CloudJob Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. CloudJob
- com.
public class CloudJob
An Azure Batch Job.
Constructor Summary
| Constructor | Description | |
|---|---|---|
| CloudJob() | ||
Method Summary
| Modifier and Type | Method and Description |
|---|---|
| Boolean |
allowTaskPreemption()
Get if the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. |
|
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 constraints value. |
| org.joda.time.DateTime |
creationTime()
Get the creation |
| String |
displayName()
Get the display |
| String |
eTag()
Get this is an opaque string. |
|
Job |
executionInfo()
Get the execution |
| String |
id()
Get 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 the job |
|
Job |
jobPreparationTask()
Get the Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. |
|
Job |
jobReleaseTask()
Get the Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. |
| org.joda.time.DateTime |
lastModified()
Get this is the last time at which the Job level data, such as the Job state or priority, changed. |
| Integer |
maxParallelTasks()
Get the value of max |
|
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 network |
|
On |
onAllTasksComplete()
Get the default is noaction. |
|
On |
onTaskFailure()
Get a Task is considered to have failed if has a failure |
|
Pool |
poolInfo()
Get the pool |
|
Job |
previousState()
Get this property is not set if the Job is in its initial Active state. |
| org.joda.time.DateTime |
previousStateTransitionTime()
Get this property is not set if the Job is in its initial Active state. |
| Integer |
priority()
Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. |
|
Job |
state()
Get possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'. |
| org.joda.time.DateTime |
stateTransitionTime()
Get the state |
|
Job |
stats()
Get this property is populated only if the Cloud |
| String |
url()
Get the url value. |
| Boolean |
usesTaskDependencies()
Get the uses |
|
Cloud |
withAllowTaskPreemption(Boolean allowTaskPreemption)
Set if the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. |
|
Cloud |
withCommonEnvironmentSettings(List<EnvironmentSetting> commonEnvironmentSettings)
Set individual Tasks can override an environment setting specified here by specifying the same setting name with a different value. |
|
Cloud |
withConstraints(JobConstraints constraints)
Set the constraints value. |
|
Cloud |
withCreationTime(DateTime creationTime)
Set the creation |
|
Cloud |
withDisplayName(String displayName)
Set the display |
|
Cloud |
withETag(String eTag)
Set this is an opaque string. |
|
Cloud |
withExecutionInfo(JobExecutionInformation executionInfo)
Set the execution |
|
Cloud |
withId(String id)
Set the ID is case-preserving and case-insensitive (that is, you may not have two IDs within an Account that differ only by case). |
|
Cloud |
withJobManagerTask(JobManagerTask jobManagerTask)
Set the job |
|
Cloud |
withJobPreparationTask(JobPreparationTask jobPreparationTask)
Set the Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job. |
|
Cloud |
withJobReleaseTask(JobReleaseTask jobReleaseTask)
Set the Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job. |
|
Cloud |
withLastModified(DateTime lastModified)
Set this is the last time at which the Job level data, such as the Job state or priority, changed. |
|
Cloud |
withMaxParallelTasks(Integer maxParallelTasks)
Set the value of max |
|
Cloud |
withMetadata(List<MetadataItem> metadata)
Set the Batch service does not assign any meaning to metadata; it is solely for the use of user code. |
|
Cloud |
withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)
Set the network |
|
Cloud |
withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
Set the default is noaction. |
|
Cloud |
withOnTaskFailure(OnTaskFailure onTaskFailure)
Set a Task is considered to have failed if has a failure |
|
Cloud |
withPoolInfo(PoolInformation poolInfo)
Set the pool |
|
Cloud |
withPreviousState(JobState previousState)
Set this property is not set if the Job is in its initial Active state. |
|
Cloud |
withPreviousStateTransitionTime(DateTime previousStateTransitionTime)
Set this property is not set if the Job is in its initial Active state. |
|
Cloud |
withPriority(Integer priority)
Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. |
|
Cloud |
withState(JobState state)
Set possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'. |
|
Cloud |
withStateTransitionTime(DateTime stateTransitionTime)
Set the state |
|
Cloud |
withStats(JobStatistics stats)
Set this property is populated only if the Cloud |
|
Cloud |
withUrl(String url)
Set the url value. |
|
Cloud |
withUsesTaskDependencies(Boolean usesTaskDependencies)
Set the uses |
Methods inherited from java.lang.Object
Constructor Details
CloudJob
public CloudJob()
Method Details
allowTaskPreemption
public Boolean allowTaskPreemption()
Get if the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API.
Returns:
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 constraints value.
Returns:
creationTime
public DateTime creationTime()
Get the creationTime value.
Returns:
displayName
public String displayName()
Get the displayName value.
Returns:
eTag
public String eTag()
Get this is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.
Returns:
executionInfo
public JobExecutionInformation executionInfo()
Get the executionInfo value.
Returns:
id
public String id()
Get 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 the jobManagerTask value.
Returns:
jobPreparationTask
public JobPreparationTask jobPreparationTask()
Get the Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job.
Returns:
jobReleaseTask
public JobReleaseTask jobReleaseTask()
Get the Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job.
Returns:
lastModified
public DateTime lastModified()
Get this is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.
Returns:
maxParallelTasks
public Integer maxParallelTasks()
Get the value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.
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 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:
previousState
public JobState previousState()
Get this property is not set if the Job is in its initial Active state. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'.
Returns:
previousStateTransitionTime
public DateTime previousStateTransitionTime()
Get this property is not set if the Job is in its initial Active state.
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:
state
public JobState state()
Get possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'.
Returns:
stateTransitionTime
public DateTime stateTransitionTime()
Get the stateTransitionTime value.
Returns:
stats
public JobStatistics stats()
Get this property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Returns:
url
public String url()
Get the url value.
Returns:
usesTaskDependencies
public Boolean usesTaskDependencies()
Get the usesTaskDependencies value.
Returns:
withAllowTaskPreemption
public CloudJob withAllowTaskPreemption(Boolean allowTaskPreemption)
Set if the value is set to True, other high priority jobs submitted to the system will take precedence and will be able requeue tasks from this job. You can update a job's allowTaskPreemption after it has been created using the update job API.
Parameters:
Returns:
withCommonEnvironmentSettings
public CloudJob 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 CloudJob withConstraints(JobConstraints constraints)
Set the constraints value.
Parameters:
Returns:
withCreationTime
public CloudJob withCreationTime(DateTime creationTime)
Set the creationTime value.
Parameters:
Returns:
withDisplayName
public CloudJob withDisplayName(String displayName)
Set the displayName value.
Parameters:
Returns:
withETag
public CloudJob withETag(String eTag)
Set this is an opaque string. You can use it to detect whether the Job has changed between requests. In particular, you can be pass the ETag when updating a Job to specify that your changes should take effect only if nobody else has modified the Job in the meantime.
Parameters:
Returns:
withExecutionInfo
public CloudJob withExecutionInfo(JobExecutionInformation executionInfo)
Set the executionInfo value.
Parameters:
Returns:
withId
public CloudJob withId(String id)
Set 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 CloudJob withJobManagerTask(JobManagerTask jobManagerTask)
Set the jobManagerTask value.
Parameters:
Returns:
withJobPreparationTask
public CloudJob withJobPreparationTask(JobPreparationTask jobPreparationTask)
Set the Job Preparation Task is a special Task run on each Compute Node before any other Task of the Job.
Parameters:
Returns:
withJobReleaseTask
public CloudJob withJobReleaseTask(JobReleaseTask jobReleaseTask)
Set the Job Release Task is a special Task run at the end of the Job on each Compute Node that has run any other Task of the Job.
Parameters:
Returns:
withLastModified
public CloudJob withLastModified(DateTime lastModified)
Set this is the last time at which the Job level data, such as the Job state or priority, changed. It does not factor in task-level changes such as adding new Tasks or Tasks changing state.
Parameters:
Returns:
withMaxParallelTasks
public CloudJob withMaxParallelTasks(Integer maxParallelTasks)
Set the value of maxParallelTasks must be -1 or greater than 0 if specified. If not specified, the default value is -1, which means there's no limit to the number of tasks that can be run at once. You can update a job's maxParallelTasks after it has been created using the update job API.
Parameters:
Returns:
withMetadata
public CloudJob 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 CloudJob withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)
Set the networkConfiguration value.
Parameters:
Returns:
withOnAllTasksComplete
public CloudJob withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
Set the default is noaction. Possible values include: 'noAction', 'terminateJob'.
Parameters:
Returns:
withOnTaskFailure
public CloudJob 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 CloudJob withPoolInfo(PoolInformation poolInfo)
Set the poolInfo value.
Parameters:
Returns:
withPreviousState
public CloudJob withPreviousState(JobState previousState)
Set this property is not set if the Job is in its initial Active state. Possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'.
Parameters:
Returns:
withPreviousStateTransitionTime
public CloudJob withPreviousStateTransitionTime(DateTime previousStateTransitionTime)
Set this property is not set if the Job is in its initial Active state.
Parameters:
Returns:
withPriority
public CloudJob 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:
withState
public CloudJob withState(JobState state)
Set possible values include: 'active', 'disabling', 'disabled', 'enabling', 'terminating', 'completed', 'deleting'.
Parameters:
Returns:
withStateTransitionTime
public CloudJob withStateTransitionTime(DateTime stateTransitionTime)
Set the stateTransitionTime value.
Parameters:
Returns:
withStats
public CloudJob withStats(JobStatistics stats)
Set this property is populated only if the CloudJob was retrieved with an expand clause including the 'stats' attribute; otherwise it is null. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Parameters:
Returns:
withUrl
public CloudJob withUrl(String url)
Set the url value.
Parameters:
Returns:
withUsesTaskDependencies
public CloudJob withUsesTaskDependencies(Boolean usesTaskDependencies)
Set the usesTaskDependencies value.
Parameters:
Returns:
Applies to
Azure SDK for Java
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for