JobConstants (genie 4.0.0-SNAPSHOT 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`	`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`	`GENIE_AGENT_ENV_FILE_NAME` Filename for environment variables dumped after setup.
`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_ENTITY_SETUP_SCRIPT_FILE_NAME` The name of the setup file (for entities that have one) when downloaded in the job directory.
`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_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_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_SETUP_ERROR_FILE_NAME` The name of the file left behind if the runfile fails during setup (sourcing entities setup scripts).
`static java.lang.String`	`GENIE_SETUP_LOG_FILE_NAME` Filename for logfile generated during setup (sourcing of entities setup files).
`static java.lang.String`	`GENIE_USER_ENV_VAR` Environment variable for the Genie username the job request.
`static java.lang.String`	`GENIE_USER_GROUP_ENV_VAR` Environment variable for the Genie user group the job request.
`static java.lang.String`	`GENIE_VERSION_ENV_VAR` Environment variable for Genie version.
`static java.lang.String`	`JOB_SUBMISSION_DISABLED_DEFAULT_MESSAGE` The default message to send back to users when the jobs are disabled if there was none other set.
`static java.lang.String`	`JOB_SUBMISSION_DISABLED_MESSAGE_KEY` The property name to check for the message to send back to the request user if jobs are currently disabled.
`static java.lang.String`	`JOB_SUBMISSION_ENABLED_PROPERTY_KEY` The property name to check whether new job submissions should be allowed.
`static java.lang.String`	`LOGS_PATH_VAR` File Path prefix to be used while creating working directory for jobs.
`static java.lang.String`	`STDERR_LOG_FILE_NAME` Stderr Filename generated by Genie after running a job.
`static java.lang.String`	`STDOUT_LOG_FILE_NAME` Stdout Filename generated by Genie after running a job.
`static java.util.TimeZone`	`UTC` UTC timezone.

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
- 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
  - 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
  - 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_SETUP_LOG_FILE_NAME
```
public static final java.lang.String GENIE_SETUP_LOG_FILE_NAME
```
    Filename for logfile generated during setup (sourcing of entities setup files).
    
    See Also:
    
    Constant Field Values
  - GENIE_AGENT_ENV_FILE_NAME
```
public static final java.lang.String GENIE_AGENT_ENV_FILE_NAME
```
    Filename for environment variables dumped after setup.
    
    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
  - GENIE_VERSION_ENV_VAR
```
public static final java.lang.String GENIE_VERSION_ENV_VAR
```
    Environment variable for Genie version.
    
    See Also:
    
    Constant Field Values
  - GENIE_USER_ENV_VAR
```
public static final java.lang.String GENIE_USER_ENV_VAR
```
    Environment variable for the Genie username the job request.
    
    See Also:
    
    Constant Field Values
  - GENIE_USER_GROUP_ENV_VAR
```
public static final java.lang.String GENIE_USER_GROUP_ENV_VAR
```
    Environment variable for the Genie user group the job request.
    
    See Also:
    
    Constant Field Values
  - UTC
```
public static final java.util.TimeZone UTC
```
    UTC timezone.
  - JOB_SUBMISSION_ENABLED_PROPERTY_KEY
```
public static final java.lang.String JOB_SUBMISSION_ENABLED_PROPERTY_KEY
```
    The property name to check whether new job submissions should be allowed.
    
    See Also:
    
    Constant Field Values
  - JOB_SUBMISSION_DISABLED_MESSAGE_KEY
```
public static final java.lang.String JOB_SUBMISSION_DISABLED_MESSAGE_KEY
```
    The property name to check for the message to send back to the request user if jobs are currently disabled.
    
    See Also:
    
    Constant Field Values
  - JOB_SUBMISSION_DISABLED_DEFAULT_MESSAGE
```
public static final java.lang.String JOB_SUBMISSION_DISABLED_DEFAULT_MESSAGE
```
    The default message to send back to users when the jobs are disabled if there was none other set.
    
    See Also:
    
    Constant Field Values
  - GENIE_ENTITY_SETUP_SCRIPT_FILE_NAME
```
public static final java.lang.String GENIE_ENTITY_SETUP_SCRIPT_FILE_NAME
```
    The name of the setup file (for entities that have one) when downloaded in the job directory.
    
    See Also:
    
    Constant Field Values
  - GENIE_SETUP_ERROR_FILE_NAME
```
public static final java.lang.String GENIE_SETUP_ERROR_FILE_NAME
```
    The name of the file left behind if the runfile fails during setup (sourcing entities setup scripts).
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - JobConstants
```
protected JobConstants()
```
    Protected constructor for utility class.

Class JobConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

GENIE_FORWARDED_FROM_HEADER

GENIE_JOB_LAUNCHER_SCRIPT

DEPENDENCY_FILE_PATH_PREFIX

CONFIG_FILE_PATH_PREFIX

STDERR_LOG_FILE_NAME

STDOUT_LOG_FILE_NAME

GENIE_SETUP_LOG_FILE_NAME

GENIE_AGENT_ENV_FILE_NAME

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

GENIE_VERSION_ENV_VAR

GENIE_USER_ENV_VAR

GENIE_USER_GROUP_ENV_VAR

UTC

JOB_SUBMISSION_ENABLED_PROPERTY_KEY

JOB_SUBMISSION_DISABLED_MESSAGE_KEY

JOB_SUBMISSION_DISABLED_DEFAULT_MESSAGE

GENIE_ENTITY_SETUP_SCRIPT_FILE_NAME

GENIE_SETUP_ERROR_FILE_NAME

Constructor Detail

JobConstants