JobConstants (genie 4.0.0-rc.20 API)

java.lang.Object
- com.netflix.genie.common.internal.jobs.JobConstants

```
public final class JobConstants
extends java.lang.Object
```
A class holding some constants to be used everywhere.

Since:

3.0.0

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`APPLICATION_PATH_VAR` File Path prefix to be used while creating directories for application files to local dir.
`static java.lang.String`	`CHILDREN_PID_ENV_VAR` Environment variable run script children pid.
`static java.lang.String`	`CLUSTER_PATH_VAR` File Path prefix to be used while creating directories for cluster files to local dir.
`static java.lang.String`	`COMMAND_PATH_VAR` File Path prefix to be used while creating directories for command files to local dir.
`static java.lang.String`	`CONFIG_FILE_PATH_PREFIX` File Path prefix to be used while creating paths for config files downloaded by Genie to local dir.
`static java.lang.String`	`DEPENDENCY_FILE_PATH_PREFIX` File Path prefix to be used while creating paths for dependency files downloaded by Genie to local dir.
`static java.lang.String`	`DOUBLE_QUOTE_SYMBOL` Double Quote symbol.
`static byte[]`	`EMPTY_BYTE_ARRAY` Empty byte array.
`static java.lang.String`	`EQUALS_SYMBOL` Equals symbol.
`static java.lang.String`	`EXPORT` Bash export command.
`static java.lang.String`	`FILE_PATH_DELIMITER` Delimiter to be used while creating file paths.
`static java.lang.String`	`FILE_TRANSFER_SERVICE_KEY` Key used for look up of File Transfer object in a Context Map for workflows.
`static java.lang.String`	`GENIE_AGENT_ENV_SCRIPT_LOG_FILE_NAME` Filename for logfile generated by master setup script.
`static java.lang.String`	`GENIE_AGENT_ENV_SCRIPT_OUTPUT_FILE_NAME` Filename for output of master setup script, containing environment for job.
`static java.lang.String`	`GENIE_AGENT_ENV_SCRIPT_RESOURCE` Genie Agent script to run entities setup and dump environment.
`static java.lang.String`	`GENIE_AGENT_LOG_FILE_NAME` Genie Agent log file name (after it is relocated inside the job directory).
`static java.lang.String`	`GENIE_APPLICATION_DIR_ENV_VAR` Environment variable for Genie application directory.
`static java.lang.String`	`GENIE_CLUSTER_DIR_ENV_VAR` Environment variable for Genie cluster directory.
`static java.lang.String`	`GENIE_CLUSTER_ID_ENV_VAR` Environment variable for Genie cluster id.
`static java.lang.String`	`GENIE_CLUSTER_NAME_ENV_VAR` Environment variable for the Genie cluster name.
`static java.lang.String`	`GENIE_CLUSTER_TAGS_ENV_VAR` Environment variable for the Genie cluster tags.
`static java.lang.String`	`GENIE_COMMAND_DIR_ENV_VAR` Environment variable for Genie command directory.
`static java.lang.String`	`GENIE_COMMAND_ID_ENV_VAR` Environment variable for Genie command id.
`static java.lang.String`	`GENIE_COMMAND_NAME_ENV_VAR` Environment variable for the Genie command name.
`static java.lang.String`	`GENIE_COMMAND_TAGS_ENV_VAR` Environment variable for the Genie command tags.
`static java.lang.String`	`GENIE_DONE_FILE_CONTENT_PREFIX` Genie Done file contents prefix.
`static java.lang.String`	`GENIE_DONE_FILE_NAME` Done filename generated by Genie after running a job.
`static java.lang.String`	`GENIE_ENV_PATH` Genie env file path.
`static java.lang.String`	`GENIE_FORWARDED_FROM_HEADER` The header to use to mark a forwarded from another Genie node.
`static java.lang.String`	`GENIE_INIT_FAILURE_MESSAGE_FILE_NAME` File created by Genie with details and trace for a job that failed to initialize.
`static java.lang.String`	`GENIE_JOB_DIR_ENV_VAR` Environment variable for Genie job working directory.
`static java.lang.String`	`GENIE_JOB_GROUPING_ENV_VAR` Environment variable for Genie Job grouping.
`static java.lang.String`	`GENIE_JOB_GROUPING_INSTANCE_ENV_VAR` Environment variable for Genie Job grouping instance.
`static java.lang.String`	`GENIE_JOB_ID_ENV_VAR` Environment variable for Genie Job ID.
`static java.lang.String`	`GENIE_JOB_LAUNCHER_SCRIPT` The launcher script name that genie creates to setup a job for running.
`static java.lang.String`	`GENIE_JOB_MEMORY_ENV_VAR` Environment variable for Genie Job Memory.
`static java.lang.String`	`GENIE_JOB_NAME_ENV_VAR` Environment variable for Genie Job Name.
`static java.lang.String`	`GENIE_JOB_TAGS_ENV_VAR` Environment variable for Genie job tags provided by the user.
`static java.lang.String`	`GENIE_KILL_REASON_FILE_NAME` "Kill reason" filename generated by Genie after killing a job.
`static java.lang.String`	`GENIE_LOG_PATH` Genie log file path.
`static java.lang.String`	`GENIE_PATH_VAR` File Path prefix to be used while creating working directory for jobs.
`static java.lang.String`	`GENIE_REQUESTED_CLUSTER_TAGS_ENV_VAR` Environment variable for the Genie cluster criteria tags in the job request.
`static java.lang.String`	`GENIE_REQUESTED_COMMAND_TAGS_ENV_VAR` Environment variable for the Genie command tags in the job request.
`static java.lang.String`	`GENIE_TEMPORARY_DONE_FILE_NAME` Temporary done filename generated by Genie after running a job as not to conflict/overwrite the one that 'trap' handler might have created.
`static java.lang.String`	`JOB_EXECUTION_DTO_KEY` Key used for look up of Job Execution DTO in a Context Map for workflows.
`static java.lang.String`	`JOB_EXECUTION_ENV_KEY` Key used for look up of Job Execution environment object in a Context Map for workflows.
`static java.lang.String`	`JOB_FAILURE_AND_KILL_HANDLER_LOGIC` An object the encapsulates the kill handling logic to be added to the for each job.
`static java.lang.String`	`KILL_PARENT_PID_FLAG` Flag to send with the pkill command using the parent pid.
`static java.lang.String`	`KILL_PROCESS_GROUP_FLAG` Flag to send with the pkill command while killing jobs using the process group ids.
`static java.lang.String`	`LOGS_PATH_VAR` File Path prefix to be used while creating working directory for jobs.
`static java.lang.String`	`PID` Process ID.
`static java.lang.String`	`SEMICOLON_SYMBOL` Semicolon symbol.
`static java.lang.String`	`SOURCE` Bash source command.
`static java.lang.String`	`STDERR_LOG_FILE_NAME` Stderr Filename generated by Genie after running a job.
`static java.lang.String`	`STDERR_REDIRECT` unix stderr symbol.
`static java.lang.String`	`STDOUT_LOG_FILE_NAME` Stdout Filename generated by Genie after running a job.
`static java.lang.String`	`STDOUT_REDIRECT` unix stdout symbol.
`static java.lang.String`	`UNIX_PKILL_COMMAND` Unix Pkill command.
`static java.util.TimeZone`	`UTC` UTC timezone.
`static java.lang.String`	`WHITE_SPACE` String containing a whitespace.
`static java.lang.String`	`WRITER_KEY` Key used to look up the writer object.

Constructor Summary

Constructors
Modifier Constructor and Description

protected JobConstants()
Protected constructor for utility class.

Constructors
Modifier	Constructor and Description
`protected`	`JobConstants()` Protected constructor for utility class.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getKillFlag()` Returns the appropriate flag to append to kill command based on the OS.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - GENIE_FORWARDED_FROM_HEADER
```
public static final java.lang.String GENIE_FORWARDED_FROM_HEADER
```
    The header to use to mark a forwarded from another Genie node.
    
    See Also:
    
    Constant Field Values
  - JOB_EXECUTION_ENV_KEY
```
public static final java.lang.String JOB_EXECUTION_ENV_KEY
```
    Key used for look up of Job Execution environment object in a Context Map for workflows.
    
    See Also:
    
    Constant Field Values
  - FILE_TRANSFER_SERVICE_KEY
```
public static final java.lang.String FILE_TRANSFER_SERVICE_KEY
```
    Key used for look up of File Transfer object in a Context Map for workflows.
    
    See Also:
    
    Constant Field Values
  - JOB_EXECUTION_DTO_KEY
```
public static final java.lang.String JOB_EXECUTION_DTO_KEY
```
    Key used for look up of Job Execution DTO in a Context Map for workflows.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_LAUNCHER_SCRIPT
```
public static final java.lang.String GENIE_JOB_LAUNCHER_SCRIPT
```
    The launcher script name that genie creates to setup a job for running.
    
    See Also:
    
    Constant Field Values
  - FILE_PATH_DELIMITER
```
public static final java.lang.String FILE_PATH_DELIMITER
```
    Delimiter to be used while creating file paths.
    
    See Also:
    
    Constant Field Values
  - UNIX_PKILL_COMMAND
```
public static final java.lang.String UNIX_PKILL_COMMAND
```
    Unix Pkill command.
    
    See Also:
    
    Constant Field Values
  - EXPORT
```
public static final java.lang.String EXPORT
```
    Bash export command.
    
    See Also:
    
    Constant Field Values
  - EQUALS_SYMBOL
```
public static final java.lang.String EQUALS_SYMBOL
```
    Equals symbol.
    
    See Also:
    
    Constant Field Values
  - DOUBLE_QUOTE_SYMBOL
```
public static final java.lang.String DOUBLE_QUOTE_SYMBOL
```
    Double Quote symbol.
    
    See Also:
    
    Constant Field Values
  - SOURCE
```
public static final java.lang.String SOURCE
```
    Bash source command.
    
    See Also:
    
    Constant Field Values
  - SEMICOLON_SYMBOL
```
public static final java.lang.String SEMICOLON_SYMBOL
```
    Semicolon symbol.
    
    See Also:
    
    Constant Field Values
  - WHITE_SPACE
```
public static final java.lang.String WHITE_SPACE
```
    String containing a whitespace.
    
    See Also:
    
    Constant Field Values
  - STDOUT_REDIRECT
```
public static final java.lang.String STDOUT_REDIRECT
```
    unix stdout symbol.
    
    See Also:
    
    Constant Field Values
  - STDERR_REDIRECT
```
public static final java.lang.String STDERR_REDIRECT
```
    unix stderr symbol.
    
    See Also:
    
    Constant Field Values
  - DEPENDENCY_FILE_PATH_PREFIX
```
public static final java.lang.String DEPENDENCY_FILE_PATH_PREFIX
```
    File Path prefix to be used while creating paths for dependency files downloaded by Genie to local dir.
    
    See Also:
    
    Constant Field Values
  - CONFIG_FILE_PATH_PREFIX
```
public static final java.lang.String CONFIG_FILE_PATH_PREFIX
```
    File Path prefix to be used while creating paths for config files downloaded by Genie to local dir.
    
    See Also:
    
    Constant Field Values
  - STDERR_LOG_FILE_NAME
```
public static final java.lang.String STDERR_LOG_FILE_NAME
```
    Stderr Filename generated by Genie after running a job.
    
    See Also:
    
    Constant Field Values
  - STDOUT_LOG_FILE_NAME
```
public static final java.lang.String STDOUT_LOG_FILE_NAME
```
    Stdout Filename generated by Genie after running a job.
    
    See Also:
    
    Constant Field Values
  - GENIE_DONE_FILE_NAME
```
public static final java.lang.String GENIE_DONE_FILE_NAME
```
    Done filename generated by Genie after running a job.
    
    See Also:
    
    Constant Field Values
  - GENIE_TEMPORARY_DONE_FILE_NAME
```
public static final java.lang.String GENIE_TEMPORARY_DONE_FILE_NAME
```
    Temporary done filename generated by Genie after running a job as not to conflict/overwrite the one that 'trap' handler might have created.
    
    See Also:
    
    Constant Field Values
  - GENIE_KILL_REASON_FILE_NAME
```
public static final java.lang.String GENIE_KILL_REASON_FILE_NAME
```
    "Kill reason" filename generated by Genie after killing a job.
    
    See Also:
    
    Constant Field Values
  - GENIE_INIT_FAILURE_MESSAGE_FILE_NAME
```
public static final java.lang.String GENIE_INIT_FAILURE_MESSAGE_FILE_NAME
```
    File created by Genie with details and trace for a job that failed to initialize.
    
    See Also:
    
    Constant Field Values
  - GENIE_LOG_PATH
```
public static final java.lang.String GENIE_LOG_PATH
```
    Genie log file path.
    
    See Also:
    
    Constant Field Values
  - GENIE_ENV_PATH
```
public static final java.lang.String GENIE_ENV_PATH
```
    Genie env file path.
    
    See Also:
    
    Constant Field Values
  - GENIE_AGENT_ENV_SCRIPT_LOG_FILE_NAME
```
public static final java.lang.String GENIE_AGENT_ENV_SCRIPT_LOG_FILE_NAME
```
    Filename for logfile generated by master setup script.
    
    See Also:
    
    Constant Field Values
  - GENIE_AGENT_ENV_SCRIPT_OUTPUT_FILE_NAME
```
public static final java.lang.String GENIE_AGENT_ENV_SCRIPT_OUTPUT_FILE_NAME
```
    Filename for output of master setup script, containing environment for job.
    
    See Also:
    
    Constant Field Values
  - GENIE_AGENT_ENV_SCRIPT_RESOURCE
```
public static final java.lang.String GENIE_AGENT_ENV_SCRIPT_RESOURCE
```
    Genie Agent script to run entities setup and dump environment.
    
    See Also:
    
    Constant Field Values
  - GENIE_AGENT_LOG_FILE_NAME
```
public static final java.lang.String GENIE_AGENT_LOG_FILE_NAME
```
    Genie Agent log file name (after it is relocated inside the job directory).
    
    See Also:
    
    Constant Field Values
  - APPLICATION_PATH_VAR
```
public static final java.lang.String APPLICATION_PATH_VAR
```
    File Path prefix to be used while creating directories for application files to local dir.
    
    See Also:
    
    Constant Field Values
  - COMMAND_PATH_VAR
```
public static final java.lang.String COMMAND_PATH_VAR
```
    File Path prefix to be used while creating directories for command files to local dir.
    
    See Also:
    
    Constant Field Values
  - CLUSTER_PATH_VAR
```
public static final java.lang.String CLUSTER_PATH_VAR
```
    File Path prefix to be used while creating directories for cluster files to local dir.
    
    See Also:
    
    Constant Field Values
  - GENIE_PATH_VAR
```
public static final java.lang.String GENIE_PATH_VAR
```
    File Path prefix to be used while creating working directory for jobs.
    
    See Also:
    
    Constant Field Values
  - LOGS_PATH_VAR
```
public static final java.lang.String LOGS_PATH_VAR
```
    File Path prefix to be used while creating working directory for jobs.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_DIR_ENV_VAR
```
public static final java.lang.String GENIE_JOB_DIR_ENV_VAR
```
    Environment variable for Genie job working directory.
    
    See Also:
    
    Constant Field Values
  - GENIE_CLUSTER_DIR_ENV_VAR
```
public static final java.lang.String GENIE_CLUSTER_DIR_ENV_VAR
```
    Environment variable for Genie cluster directory.
    
    See Also:
    
    Constant Field Values
  - GENIE_CLUSTER_ID_ENV_VAR
```
public static final java.lang.String GENIE_CLUSTER_ID_ENV_VAR
```
    Environment variable for Genie cluster id.
    
    See Also:
    
    Constant Field Values
  - GENIE_CLUSTER_NAME_ENV_VAR
```
public static final java.lang.String GENIE_CLUSTER_NAME_ENV_VAR
```
    Environment variable for the Genie cluster name.
    
    See Also:
    
    Constant Field Values
  - GENIE_CLUSTER_TAGS_ENV_VAR
```
public static final java.lang.String GENIE_CLUSTER_TAGS_ENV_VAR
```
    Environment variable for the Genie cluster tags.
    
    See Also:
    
    Constant Field Values
  - GENIE_COMMAND_DIR_ENV_VAR
```
public static final java.lang.String GENIE_COMMAND_DIR_ENV_VAR
```
    Environment variable for Genie command directory.
    
    See Also:
    
    Constant Field Values
  - GENIE_COMMAND_ID_ENV_VAR
```
public static final java.lang.String GENIE_COMMAND_ID_ENV_VAR
```
    Environment variable for Genie command id.
    
    See Also:
    
    Constant Field Values
  - GENIE_COMMAND_NAME_ENV_VAR
```
public static final java.lang.String GENIE_COMMAND_NAME_ENV_VAR
```
    Environment variable for the Genie command name.
    
    See Also:
    
    Constant Field Values
  - GENIE_COMMAND_TAGS_ENV_VAR
```
public static final java.lang.String GENIE_COMMAND_TAGS_ENV_VAR
```
    Environment variable for the Genie command tags.
    
    See Also:
    
    Constant Field Values
  - GENIE_APPLICATION_DIR_ENV_VAR
```
public static final java.lang.String GENIE_APPLICATION_DIR_ENV_VAR
```
    Environment variable for Genie application directory.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_ID_ENV_VAR
```
public static final java.lang.String GENIE_JOB_ID_ENV_VAR
```
    Environment variable for Genie Job ID.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_NAME_ENV_VAR
```
public static final java.lang.String GENIE_JOB_NAME_ENV_VAR
```
    Environment variable for Genie Job Name.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_MEMORY_ENV_VAR
```
public static final java.lang.String GENIE_JOB_MEMORY_ENV_VAR
```
    Environment variable for Genie Job Memory.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_TAGS_ENV_VAR
```
public static final java.lang.String GENIE_JOB_TAGS_ENV_VAR
```
    Environment variable for Genie job tags provided by the user.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_GROUPING_ENV_VAR
```
public static final java.lang.String GENIE_JOB_GROUPING_ENV_VAR
```
    Environment variable for Genie Job grouping.
    
    See Also:
    
    Constant Field Values
  - GENIE_JOB_GROUPING_INSTANCE_ENV_VAR
```
public static final java.lang.String GENIE_JOB_GROUPING_INSTANCE_ENV_VAR
```
    Environment variable for Genie Job grouping instance.
    
    See Also:
    
    Constant Field Values
  - GENIE_REQUESTED_COMMAND_TAGS_ENV_VAR
```
public static final java.lang.String GENIE_REQUESTED_COMMAND_TAGS_ENV_VAR
```
    Environment variable for the Genie command tags in the job request.
    
    See Also:
    
    Constant Field Values
  - GENIE_REQUESTED_CLUSTER_TAGS_ENV_VAR
```
public static final java.lang.String GENIE_REQUESTED_CLUSTER_TAGS_ENV_VAR
```
    Environment variable for the Genie cluster criteria tags in the job request.
    
    See Also:
    
    Constant Field Values
  - PID
```
public static final java.lang.String PID
```
    Process ID.
    
    See Also:
    
    Constant Field Values
  - GENIE_DONE_FILE_CONTENT_PREFIX
```
public static final java.lang.String GENIE_DONE_FILE_CONTENT_PREFIX
```
    Genie Done file contents prefix.
    
    See Also:
    
    Constant Field Values
  - KILL_PROCESS_GROUP_FLAG
```
public static final java.lang.String KILL_PROCESS_GROUP_FLAG
```
    Flag to send with the pkill command while killing jobs using the process group ids.
    
    See Also:
    
    Constant Field Values
  - KILL_PARENT_PID_FLAG
```
public static final java.lang.String KILL_PARENT_PID_FLAG
```
    Flag to send with the pkill command using the parent pid.
    
    See Also:
    
    Constant Field Values
  - WRITER_KEY
```
public static final java.lang.String WRITER_KEY
```
    Key used to look up the writer object.
    
    See Also:
    
    Constant Field Values
  - UTC
```
public static final java.util.TimeZone UTC
```
    UTC timezone.
  - CHILDREN_PID_ENV_VAR
```
public static final java.lang.String CHILDREN_PID_ENV_VAR
```
    Environment variable run script children pid.
    
    See Also:
    
    Constant Field Values
  - EMPTY_BYTE_ARRAY
```
public static final byte[] EMPTY_BYTE_ARRAY
```
    Empty byte array.
  - JOB_FAILURE_AND_KILL_HANDLER_LOGIC
```
public static final java.lang.String JOB_FAILURE_AND_KILL_HANDLER_LOGIC
```
    An object the encapsulates the kill handling logic to be added to the for each job.
- Constructor Detail
  - JobConstants
```
protected JobConstants()
```
    Protected constructor for utility class.
- Method Detail
  - getKillFlag
```
public static java.lang.String getKillFlag()
```
    Returns the appropriate flag to append to kill command based on the OS.
    
    Returns:
    
    The flag to use for kill command.

Class JobConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GENIE_FORWARDED_FROM_HEADER

JOB_EXECUTION_ENV_KEY

FILE_TRANSFER_SERVICE_KEY

JOB_EXECUTION_DTO_KEY

GENIE_JOB_LAUNCHER_SCRIPT

FILE_PATH_DELIMITER

UNIX_PKILL_COMMAND

EXPORT

EQUALS_SYMBOL

DOUBLE_QUOTE_SYMBOL

SOURCE

SEMICOLON_SYMBOL

WHITE_SPACE

STDOUT_REDIRECT

STDERR_REDIRECT

DEPENDENCY_FILE_PATH_PREFIX

CONFIG_FILE_PATH_PREFIX

STDERR_LOG_FILE_NAME

STDOUT_LOG_FILE_NAME

GENIE_DONE_FILE_NAME

GENIE_TEMPORARY_DONE_FILE_NAME

GENIE_KILL_REASON_FILE_NAME

GENIE_INIT_FAILURE_MESSAGE_FILE_NAME

GENIE_LOG_PATH

GENIE_ENV_PATH

GENIE_AGENT_ENV_SCRIPT_LOG_FILE_NAME

GENIE_AGENT_ENV_SCRIPT_OUTPUT_FILE_NAME

GENIE_AGENT_ENV_SCRIPT_RESOURCE

GENIE_AGENT_LOG_FILE_NAME

APPLICATION_PATH_VAR

COMMAND_PATH_VAR

CLUSTER_PATH_VAR

GENIE_PATH_VAR

LOGS_PATH_VAR

GENIE_JOB_DIR_ENV_VAR

GENIE_CLUSTER_DIR_ENV_VAR

GENIE_CLUSTER_ID_ENV_VAR

GENIE_CLUSTER_NAME_ENV_VAR

GENIE_CLUSTER_TAGS_ENV_VAR

GENIE_COMMAND_DIR_ENV_VAR

GENIE_COMMAND_ID_ENV_VAR

GENIE_COMMAND_NAME_ENV_VAR

GENIE_COMMAND_TAGS_ENV_VAR

GENIE_APPLICATION_DIR_ENV_VAR

GENIE_JOB_ID_ENV_VAR

GENIE_JOB_NAME_ENV_VAR

GENIE_JOB_MEMORY_ENV_VAR

GENIE_JOB_TAGS_ENV_VAR

GENIE_JOB_GROUPING_ENV_VAR

GENIE_JOB_GROUPING_INSTANCE_ENV_VAR

GENIE_REQUESTED_COMMAND_TAGS_ENV_VAR

GENIE_REQUESTED_CLUSTER_TAGS_ENV_VAR

PID

GENIE_DONE_FILE_CONTENT_PREFIX

KILL_PROCESS_GROUP_FLAG

KILL_PARENT_PID_FLAG

WRITER_KEY

UTC

CHILDREN_PID_ENV_VAR

EMPTY_BYTE_ARRAY

JOB_FAILURE_AND_KILL_HANDLER_LOGIC

Constructor Detail

JobConstants

Method Detail

getKillFlag