/*
 * Copyright 2012 LinkedIn Corp.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package azkaban.flow;

public class CommonJobProperties {
  /*
   * The following are Common properties that can be set in a job file
   */

  /**
   * The type of job that will be executed. Examples: command, java, etc.
   */
  public static final String JOB_TYPE = "type";

  /**
   * Force a node to be a root node in a flow, even if there are other jobs dependent on it.
   */
  public static final String ROOT_NODE = "root.node";

  /**
   * Comma delimited list of job names which are dependencies
   */
  public static final String DEPENDENCIES = "dependencies";

  /**
   * The number of retries when this job has failed.
   */
  public static final String RETRIES = "retries";

  /**
   * The time in millisec to back off after every retry
   */
  public static final String RETRY_BACKOFF = "retry.backoff";

  /**
   * Comma delimited list of email addresses for both failure and success messages
   */
  public static final String NOTIFY_EMAILS = "notify.emails";

  /**
   * Comma delimited list of email addresses for success messages
   */
  public static final String SUCCESS_EMAILS = "success.emails";

  /**
   * Comma delimited list of email addresses for failure messages
   */
  public static final String FAILURE_EMAILS = "failure.emails";

  /*
   * The following are the common props that will be added to the job by azkaban
   */
  /**
   * Url to access azkaban on a given host
   */
  public static final String AZKABAN_URL = "azkaban.url";

  /**
   * The attempt number of the executing job.
   */
  public static final String JOB_ATTEMPT = "azkaban.job.attempt";

  /**
   * The job's metadata file name.
   */
  public static final String JOB_METADATA_FILE = "azkaban.job.metadata.file";

  /**
   * The job's attachment file absolute path.
   */
  public static final String JOB_ATTACHMENT_FILE =
      "azkaban.job.attachment.file";

  /**
   * The job's log file absolute path.
   */
  public static final String JOB_LOG_FILE = "azkaban.job.log.file";
  
  /**
   * The executing flow id
   */
  public static final String FLOW_ID = "azkaban.flow.flowid";

  /**
   * The nested flow id path
   */
  public static final String NESTED_FLOW_PATH = "azkaban.flow.nested.path";

  /**
   * The executing job id
   */
  public static final String JOB_ID = "azkaban.job.id";

  /**
   * The execution id. This should be unique per flow, but may not be due to restarts.
   */
  public static final String EXEC_ID = "azkaban.flow.execid";

  /**
   * The numerical project id identifier.
   */
  public static final String PROJECT_ID = "azkaban.flow.projectid";

  /**
   * The project name.
   */
  public static final String PROJECT_NAME = "azkaban.flow.projectname";

  /**
   * The project last modified by user.
   */
  public static final String PROJECT_LAST_CHANGED_BY = "azkaban.flow.projectlastchangedby";

  /**
   * The project last modified on date.
   */
  public static final String PROJECT_LAST_CHANGED_DATE = "azkaban.flow.projectlastchangeddate";

  /**
   * The version of the project the flow is running. This may change if a forced hotspot occurs.
   */
  public static final String PROJECT_VERSION = "azkaban.flow.projectversion";

  /**
   * Find out who is the submit user, in addition to the user.to.proxy (they may be different)
   */
  public static final String SUBMIT_USER = "azkaban.flow.submituser";

  /**
   * A uuid assigned to every execution
   */
  public static final String FLOW_UUID = "azkaban.flow.uuid";

  public static final String JOB_LINK = "azkaban.link.job.url";
  public static final String WORKFLOW_LINK = "azkaban.link.workflow.url";
  public static final String EXECUTION_LINK = "azkaban.link.execution.url";
  public static final String JOBEXEC_LINK = "azkaban.link.jobexec.url";
  public static final String ATTEMPT_LINK = "azkaban.link.attempt.url";
  public static final String OUT_NODES = "azkaban.job.outnodes";
  public static final String IN_NODES = "azkaban.job.innodes";

  /**
   * Properties for passing the flow start time to the jobs.
   */
  public static final String FLOW_START_TIMESTAMP =
      "azkaban.flow.start.timestamp";
  public static final String FLOW_START_YEAR = "azkaban.flow.start.year";
  public static final String FLOW_START_MONTH = "azkaban.flow.start.month";
  public static final String FLOW_START_DAY = "azkaban.flow.start.day";
  public static final String FLOW_START_HOUR = "azkaban.flow.start.hour";
  public static final String FLOW_START_MINUTE = "azkaban.flow.start.minute";
  public static final String FLOW_START_SECOND = "azkaban.flow.start.second";
  public static final String FLOW_START_MILLISSECOND =
      "azkaban.flow.start.milliseconds";
  public static final String FLOW_START_TIMEZONE =
      "azkaban.flow.start.timezone";

}
