SchedulerConstants (scheduling 14.1.0-SNAPSHOT API)

java.lang.Object
- org.ow2.proactive.scheduler.common.SchedulerConstants

```
@PublicAPI
public class SchedulerConstants
extends Object
```
Constant types in the Scheduler.

Since:

ProActive Scheduling 0.9.1

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BUCKET_NAME` Generic information containing the bucket name
`static String`	`CREDENTIALS_VARIABLE` The variable name to access the user's third party credentials.
`static String`	`DISABLE_PROCESS_TREE_KILLER_GENERIC_INFO` This generic information can be used to disable Process Tree Killer execution
`static String`	`DS_CACHE_BINDING_NAME`
`static String`	`DS_GLOBAL_API_BINDING_NAME`
`static String`	`DS_GLOBAL_BINDING_NAME`
`static String`	`DS_INPUT_BINDING_NAME`
`static String`	`DS_OUTPUT_BINDING_NAME`
`static String`	`DS_SCRATCH_BINDING_NAME`
`static String`	`DS_USER_API_BINDING_NAME`
`static String`	`DS_USER_BINDING_NAME`
`static String`	`FORK_ENVIRONMENT_BINDING_NAME`
`static String`	`GENERIC_INFO_BINDING_NAME`
`static String`	`GLOBALSPACE_NAME` Name of the GlobalSpace for DataSpaces registration
`static String`	`JOB_DEFAULT_NAME` Default job name
`static String`	`METADATA_CONTENT_TYPE` Specific metadata values
`static String`	`METADATA_FILE_EXTENSION`
`static String`	`METADATA_FILE_NAME`
`static String`	`MULTI_NODE_TASK_ALL_NODESURL_BINDING_NAME` in a multi-node execution, a set of all nodes reserved for the task, including the node running the task, additional nodes and also exclusive nodes reserved by the single-host-exclusive topology
`static String`	`MULTI_NODE_TASK_NODESURL_BINDING_NAME` in a multi-node execution, a list of additional nodes reserved for the task, but not containing "exclusive" nodes i.e.
`static String`	`NEXT_EXECUTION` Generic information used by the job planner as the next execution schedule
`static String`	`NODE_ACCESS_TOKEN` Attribute name in task the generic information indicating that the task requires a node protected by token
`static String`	`NODE_SOURCE_GENERIC_INFO` Attribute name in task the generic information indicating that the task requires a node belonging to a specific node source
`static String`	`PARENT_JOB_ID` Generic information containing the parent job id
`static String`	`PROGRESS_BINDING_NAME` The variable used to get or set the task progress
`static String`	`REMOTE_CONNECTION_MARKER` Marker in the task output to locate the remote connection hint for the hint to be detected client side, the following String has to be printed to the task log : PA_REMOTE_CONNECTION;TaskId;type;url example : 'PA_REMOTE_CONNECTION;10005;vnc;localhost:5901'
`static char`	`REMOTE_CONNECTION_SEPARATOR` Separator character for the String located by the `REMOTE_CONNECTION_MARKER`
`static String`	`RESULT_MAP_BINDING_NAME`
`static String`	`RESULT_METADATA_VARIABLE` The variable name to access result metadata from dependent tasks (a map).
`static String`	`RESULTS_VARIABLE` The variable name to access results from dependent tasks (an array).
`static String`	`RM_CLIENT_BINDING_NAME`
`static String`	`SCHEDULER_CLIENT_BINDING_NAME` The variable containing a proxy to the scheduler server
`static String`	`SCHEDULER_DATASPACE_APPLICATION_ID` The Application ID used by the scheduler for local Dataspaces
`static String`	`SCHEDULER_DEFAULT_NAME` Default scheduler node name
`static String`	`SIGNAL_API_BINDING_NAME` The variable containing a proxy to the signal API
`static String`	`SUBMISSION_MODE` This generic information can be used to set the portal name via the job was submitted
`static String`	`SUBMISSION_MODE_CLI` Submission mode for workflows submitted from cli
`static String`	`SUBMISSION_MODE_REST_API` Default submission mode
`static String`	`SUBMISSION_MODE_WORKFLOW_API` Submission mode for workflows submitted from scheduler api
`static String`	`SYNCHRONIZATION_API_BINDING_NAME` The variable containing a proxy to the key/value store
`static String`	`SYNCHRONIZATION_DEFAULT_NAME` Default name for store active object binding
`static String`	`TASK_DEFAULT_NAME` Default task name
`static String`	`TASK_NAME_IFNOTSET` If the task name is not set, this is the generated one
`static String`	`TASK_WALLTIME_GENERIC_INFO` This generic information can be used to configure a task walltime
`static String`	`TASKID_DIR_DEFAULT_NAME` Default taskid directory name (used in TaskLauncher)
`static String`	`UNIX_HOME_ENV_VAR` Name of the environment variable for unix home directory on the common file system.
`static String`	`USERSPACE_NAME` Name of the UserSpace for DataSpaces registration
`static String`	`VARIABLES_BINDING_NAME`
`static String`	`WINDOWS_HOME_ENV_VAR` Name of the environment variable for windows home directory on the common file system.

Constructor Summary

Constructors
Constructor and Description

SchedulerConstants()

Constructors
Constructor and Description
`SchedulerConstants()`

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

- Field Detail
  - SCHEDULER_DEFAULT_NAME
```
public static final String SCHEDULER_DEFAULT_NAME
```
    Default scheduler node name
    
    See Also:
    
    Constant Field Values
  - SYNCHRONIZATION_DEFAULT_NAME
```
public static final String SYNCHRONIZATION_DEFAULT_NAME
```
    Default name for store active object binding
    
    See Also:
    
    Constant Field Values
  - JOB_DEFAULT_NAME
```
public static final String JOB_DEFAULT_NAME
```
    Default job name
    
    See Also:
    
    Constant Field Values
  - TASK_DEFAULT_NAME
```
public static final String TASK_DEFAULT_NAME
```
    Default task name
    
    See Also:
    
    Constant Field Values
  - TASK_NAME_IFNOTSET
```
public static final String TASK_NAME_IFNOTSET
```
    If the task name is not set, this is the generated one
    
    See Also:
    
    Constant Field Values
  - WINDOWS_HOME_ENV_VAR
```
public static final String WINDOWS_HOME_ENV_VAR
```
    Name of the environment variable for windows home directory on the common file system.
    
    See Also:
    
    Constant Field Values
  - UNIX_HOME_ENV_VAR
```
public static final String UNIX_HOME_ENV_VAR
```
    Name of the environment variable for unix home directory on the common file system.
    
    See Also:
    
    Constant Field Values
  - GLOBALSPACE_NAME
```
public static final String GLOBALSPACE_NAME
```
    Name of the GlobalSpace for DataSpaces registration
    
    See Also:
    
    Constant Field Values
  - USERSPACE_NAME
```
public static final String USERSPACE_NAME
```
    Name of the UserSpace for DataSpaces registration
    
    See Also:
    
    Constant Field Values
  - TASKID_DIR_DEFAULT_NAME
```
public static final String TASKID_DIR_DEFAULT_NAME
```
    Default taskid directory name (used in TaskLauncher)
    
    See Also:
    
    Constant Field Values
  - MULTI_NODE_TASK_NODESURL_BINDING_NAME
```
public static final String MULTI_NODE_TASK_NODESURL_BINDING_NAME
```
    in a multi-node execution, a list of additional nodes reserved for the task, but not containing "exclusive" nodes i.e. single-host-exclusive topology
    
    See Also:
    
    Constant Field Values
  - MULTI_NODE_TASK_ALL_NODESURL_BINDING_NAME
```
public static final String MULTI_NODE_TASK_ALL_NODESURL_BINDING_NAME
```
    in a multi-node execution, a set of all nodes reserved for the task, including the node running the task, additional nodes and also exclusive nodes reserved by the single-host-exclusive topology
    
    See Also:
    
    Constant Field Values
  - VARIABLES_BINDING_NAME
```
public static final String VARIABLES_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - GENERIC_INFO_BINDING_NAME
```
public static final String GENERIC_INFO_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - RESULT_MAP_BINDING_NAME
```
public static final String RESULT_MAP_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_SCRATCH_BINDING_NAME
```
public static final String DS_SCRATCH_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_CACHE_BINDING_NAME
```
public static final String DS_CACHE_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_INPUT_BINDING_NAME
```
public static final String DS_INPUT_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_OUTPUT_BINDING_NAME
```
public static final String DS_OUTPUT_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_GLOBAL_BINDING_NAME
```
public static final String DS_GLOBAL_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_USER_BINDING_NAME
```
public static final String DS_USER_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_GLOBAL_API_BINDING_NAME
```
public static final String DS_GLOBAL_API_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - DS_USER_API_BINDING_NAME
```
public static final String DS_USER_API_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - FORK_ENVIRONMENT_BINDING_NAME
```
public static final String FORK_ENVIRONMENT_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - SCHEDULER_CLIENT_BINDING_NAME
```
public static final String SCHEDULER_CLIENT_BINDING_NAME
```
    The variable containing a proxy to the scheduler server
    
    See Also:
    
    Constant Field Values
  - RM_CLIENT_BINDING_NAME
```
public static final String RM_CLIENT_BINDING_NAME
```
    See Also:
    
    Constant Field Values
  - SYNCHRONIZATION_API_BINDING_NAME
```
public static final String SYNCHRONIZATION_API_BINDING_NAME
```
    The variable containing a proxy to the key/value store
    
    See Also:
    
    Constant Field Values
  - SIGNAL_API_BINDING_NAME
```
public static final String SIGNAL_API_BINDING_NAME
```
    The variable containing a proxy to the signal API
    
    See Also:
    
    Constant Field Values
  - REMOTE_CONNECTION_MARKER
```
public static final String REMOTE_CONNECTION_MARKER
```
    Marker in the task output to locate the remote connection hint for the hint to be detected client side, the following String has to be printed to the task log : PA_REMOTE_CONNECTION;TaskId;type;url example : 'PA_REMOTE_CONNECTION;10005;vnc;localhost:5901'
    
    See Also:
    
    Constant Field Values
  - REMOTE_CONNECTION_SEPARATOR
```
public static final char REMOTE_CONNECTION_SEPARATOR
```
    Separator character for the String located by the REMOTE_CONNECTION_MARKER
    
    See Also:
    
    Constant Field Values
  - NODE_ACCESS_TOKEN
```
public static final String NODE_ACCESS_TOKEN
```
    Attribute name in task the generic information indicating that the task requires a node protected by token
    
    See Also:
    
    Constant Field Values
  - NODE_SOURCE_GENERIC_INFO
```
public static final String NODE_SOURCE_GENERIC_INFO
```
    Attribute name in task the generic information indicating that the task requires a node belonging to a specific node source
    
    See Also:
    
    Constant Field Values
  - PARENT_JOB_ID
```
public static final String PARENT_JOB_ID
```
    Generic information containing the parent job id
    
    See Also:
    
    Constant Field Values
  - NEXT_EXECUTION
```
public static final String NEXT_EXECUTION
```
    Generic information used by the job planner as the next execution schedule
    
    See Also:
    
    Constant Field Values
  - BUCKET_NAME
```
public static final String BUCKET_NAME
```
    Generic information containing the bucket name
    
    See Also:
    
    Constant Field Values
  - RESULTS_VARIABLE
```
public static final String RESULTS_VARIABLE
```
    The variable name to access results from dependent tasks (an array).
    
    See Also:
    
    Constant Field Values
  - RESULT_METADATA_VARIABLE
```
public static final String RESULT_METADATA_VARIABLE
```
    The variable name to access result metadata from dependent tasks (a map).
    
    See Also:
    
    Constant Field Values
  - METADATA_CONTENT_TYPE
```
public static final String METADATA_CONTENT_TYPE
```
    Specific metadata values
    
    See Also:
    
    Constant Field Values
  - METADATA_FILE_NAME
```
public static final String METADATA_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - METADATA_FILE_EXTENSION
```
public static final String METADATA_FILE_EXTENSION
```
    See Also:
    
    Constant Field Values
  - CREDENTIALS_VARIABLE
```
public static final String CREDENTIALS_VARIABLE
```
    The variable name to access the user's third party credentials.
    
    See Also:
    
    Constant Field Values
  - PROGRESS_BINDING_NAME
```
public static final String PROGRESS_BINDING_NAME
```
    The variable used to get or set the task progress
    
    See Also:
    
    Constant Field Values
  - SCHEDULER_DATASPACE_APPLICATION_ID
```
public static String SCHEDULER_DATASPACE_APPLICATION_ID
```
    The Application ID used by the scheduler for local Dataspaces
  - DISABLE_PROCESS_TREE_KILLER_GENERIC_INFO
```
public static String DISABLE_PROCESS_TREE_KILLER_GENERIC_INFO
```
    This generic information can be used to disable Process Tree Killer execution
  - TASK_WALLTIME_GENERIC_INFO
```
public static String TASK_WALLTIME_GENERIC_INFO
```
    This generic information can be used to configure a task walltime
  - SUBMISSION_MODE_WORKFLOW_API
```
public static String SUBMISSION_MODE_WORKFLOW_API
```
    Submission mode for workflows submitted from scheduler api
  - SUBMISSION_MODE_CLI
```
public static String SUBMISSION_MODE_CLI
```
    Submission mode for workflows submitted from cli
  - SUBMISSION_MODE_REST_API
```
public static String SUBMISSION_MODE_REST_API
```
    Default submission mode
  - SUBMISSION_MODE
```
public static String SUBMISSION_MODE
```
    This generic information can be used to set the portal name via the job was submitted
- Constructor Detail
  - SchedulerConstants
```
public SchedulerConstants()
```

Class SchedulerConstants

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCHEDULER_DEFAULT_NAME

SYNCHRONIZATION_DEFAULT_NAME

JOB_DEFAULT_NAME

TASK_DEFAULT_NAME

TASK_NAME_IFNOTSET

WINDOWS_HOME_ENV_VAR

UNIX_HOME_ENV_VAR

GLOBALSPACE_NAME

USERSPACE_NAME

TASKID_DIR_DEFAULT_NAME

MULTI_NODE_TASK_NODESURL_BINDING_NAME

MULTI_NODE_TASK_ALL_NODESURL_BINDING_NAME

VARIABLES_BINDING_NAME

GENERIC_INFO_BINDING_NAME

RESULT_MAP_BINDING_NAME

DS_SCRATCH_BINDING_NAME

DS_CACHE_BINDING_NAME

DS_INPUT_BINDING_NAME

DS_OUTPUT_BINDING_NAME

DS_GLOBAL_BINDING_NAME

DS_USER_BINDING_NAME

DS_GLOBAL_API_BINDING_NAME

DS_USER_API_BINDING_NAME

FORK_ENVIRONMENT_BINDING_NAME

SCHEDULER_CLIENT_BINDING_NAME

RM_CLIENT_BINDING_NAME

SYNCHRONIZATION_API_BINDING_NAME

SIGNAL_API_BINDING_NAME

REMOTE_CONNECTION_MARKER

REMOTE_CONNECTION_SEPARATOR

NODE_ACCESS_TOKEN

NODE_SOURCE_GENERIC_INFO

PARENT_JOB_ID

NEXT_EXECUTION

BUCKET_NAME

RESULTS_VARIABLE

RESULT_METADATA_VARIABLE

METADATA_CONTENT_TYPE

METADATA_FILE_NAME

METADATA_FILE_EXTENSION

CREDENTIALS_VARIABLE

PROGRESS_BINDING_NAME

SCHEDULER_DATASPACE_APPLICATION_ID

DISABLE_PROCESS_TREE_KILLER_GENERIC_INFO

TASK_WALLTIME_GENERIC_INFO

SUBMISSION_MODE_WORKFLOW_API

SUBMISSION_MODE_CLI

SUBMISSION_MODE_REST_API

SUBMISSION_MODE

Constructor Detail

SchedulerConstants