JobAddParameter Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. JobAddParameter
- com.
public class JobAddParameter
An Azure Batch job to add.
Method Summary
Modifier and Type | Method and Description |
---|---|
List<Environment |
commonEnvironmentSettings()
Get individual tasks can override an environment setting specified here by specifying the same setting name with a different value. |
Job |
constraints()
Get the execution constraints for the job. |
String |
displayName()
Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
String |
id()
Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case). |
Job |
jobManagerTask()
Get if the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents. |
Job |
jobPreparationTask()
Get if a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node. |
Job |
jobReleaseTask()
Get a Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation. |
List<Metadata |
metadata()
Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
Job |
networkConfiguration()
Get the networkConfiguration value. |
On |
onAllTasksComplete()
Get note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'. |
On |
onTaskFailure()
Get a task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'. |
Pool |
poolInfo()
Get the poolInfo value. |
Integer |
priority()
Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. |
Boolean |
usesTaskDependencies()
Get the usesTaskDependencies value. |
Job |
withCommonEnvironmentSettings(List<EnvironmentSetting> commonEnvironmentSettings)
Set individual tasks can override an environment setting specified here by specifying the same setting name with a different value. |
Job |
withConstraints(JobConstraints constraints)
Set the execution constraints for the job. |
Job |
withDisplayName(String displayName)
Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024. |
Job |
withId(String id)
Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case). |
Job |
withJobManagerTask(JobManagerTask jobManagerTask)
Set if the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents. |
Job |
withJobPreparationTask(JobPreparationTask jobPreparationTask)
Set if a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node. |
Job |
withJobReleaseTask(JobReleaseTask jobReleaseTask)
Set a Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation. |
Job |
withMetadata(List<MetadataItem> metadata)
Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
Job |
withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)
Set the networkConfiguration value. |
Job |
withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
Set note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'. |
Job |
withOnTaskFailure(OnTaskFailure onTaskFailure)
Set a task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'. |
Job |
withPoolInfo(PoolInformation poolInfo)
Set the poolInfo value. |
Job |
withPriority(Integer priority)
Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0. |
Job |
withUsesTaskDependencies(Boolean usesTaskDependencies)
Set the usesTaskDependencies value. |
Method Details
commonEnvironmentSettings
public List
Get individual tasks can override an environment setting specified here by specifying the same setting name with a different value.
Returns:
constraints
public JobConstraints constraints()
Get the execution constraints for the job.
Returns:
displayName
public String displayName()
Get the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
Returns:
id
public String id()
Get the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
Returns:
jobManagerTask
public JobManagerTask jobManagerTask()
Get if the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents.
Returns:
jobPreparationTask
public JobPreparationTask jobPreparationTask()
Get if a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.
Returns:
jobReleaseTask
public JobReleaseTask jobReleaseTask()
Get a Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation.
Returns:
metadata
public List
Get the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Returns:
networkConfiguration
public JobNetworkConfiguration networkConfiguration()
Get the networkConfiguration value.
Returns:
onAllTasksComplete
public OnAllTasksComplete onAllTasksComplete()
Get note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'.
Returns:
onTaskFailure
public OnTaskFailure onTaskFailure()
Get a task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'.
Returns:
poolInfo
public PoolInformation poolInfo()
Get the poolInfo value.
Returns:
priority
public Integer priority()
Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
Returns:
usesTaskDependencies
public Boolean usesTaskDependencies()
Get the usesTaskDependencies value.
Returns:
withCommonEnvironmentSettings
public JobAddParameter withCommonEnvironmentSettings(List
Set individual tasks can override an environment setting specified here by specifying the same setting name with a different value.
Parameters:
Returns:
withConstraints
public JobAddParameter withConstraints(JobConstraints constraints)
Set the execution constraints for the job.
Parameters:
Returns:
withDisplayName
public JobAddParameter withDisplayName(String displayName)
Set the display name need not be unique and can contain any Unicode characters up to a maximum length of 1024.
Parameters:
Returns:
withId
public JobAddParameter withId(String id)
Set the ID can contain any combination of alphanumeric characters including hyphens and underscores, and cannot contain more than 64 characters. The ID is case-preserving and case-insensitive (that is, you may not have two IDs within an account that differ only by case).
Parameters:
Returns:
withJobManagerTask
public JobAddParameter withJobManagerTask(JobManagerTask jobManagerTask)
Set if the job does not specify a Job Manager task, the user must explicitly add tasks to the job. If the job does specify a Job Manager task, the Batch service creates the Job Manager task when the job is created, and will try to schedule the Job Manager task before scheduling other tasks in the job. The Job Manager task's typical purpose is to control and/or monitor job execution, for example by deciding what additional tasks to run, determining when the work is complete, etc. (However, a Job Manager task is not restricted to these activities - it is a fully-fledged task in the system and perform whatever actions are required for the job.) For example, a Job Manager task might download a file specified as a parameter, analyze the contents of that file and submit additional tasks based on those contents.
Parameters:
Returns:
withJobPreparationTask
public JobAddParameter withJobPreparationTask(JobPreparationTask jobPreparationTask)
Set if a job has a Job Preparation task, the Batch service will run the Job Preparation task on a compute node before starting any tasks of that job on that compute node.
Parameters:
Returns:
withJobReleaseTask
public JobAddParameter withJobReleaseTask(JobReleaseTask jobReleaseTask)
Set a Job Release task cannot be specified without also specifying a Job Preparation task for the job. The Batch service runs the Job Release task on the compute nodes that have run the Job Preparation task. The primary purpose of the Job Release task is to undo changes to compute nodes made by the Job Preparation task. Example activities include deleting local files, or shutting down services that were started as part of job preparation.
Parameters:
Returns:
withMetadata
public JobAddParameter withMetadata(List
Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code.
Parameters:
Returns:
withNetworkConfiguration
public JobAddParameter withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)
Set the networkConfiguration value.
Parameters:
Returns:
withOnAllTasksComplete
public JobAddParameter withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
Set note that if a job contains no tasks, then all tasks are considered complete. This option is therefore most commonly used with a Job Manager task; if you want to use automatic job termination without a Job Manager, you should initially set onAllTasksComplete to noaction and update the job properties to set onAllTasksComplete to terminatejob once you have finished adding tasks. The default is noaction. Possible values include: 'noAction', 'terminateJob'.
Parameters:
Returns:
withOnTaskFailure
public JobAddParameter withOnTaskFailure(OnTaskFailure onTaskFailure)
Set a task is considered to have failed if has a failureInfo. A failureInfo is set if the task completes with a non-zero exit code after exhausting its retry count, or if there was an error starting the task, for example due to a resource file download error. The default is noaction. Possible values include: 'noAction', 'performExitOptionsJobAction'.
Parameters:
Returns:
withPoolInfo
public JobAddParameter withPoolInfo(PoolInformation poolInfo)
Set the poolInfo value.
Parameters:
Returns:
withPriority
public JobAddParameter withPriority(Integer priority)
Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. The default value is 0.
Parameters:
Returns:
withUsesTaskDependencies
public JobAddParameter withUsesTaskDependencies(Boolean usesTaskDependencies)
Set the usesTaskDependencies value.
Parameters:
Returns:
Applies to
Azure SDK for Java