JobPatchParameter Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. JobPatchParameter
- com.
public class JobPatchParameter
The set of changes to be made to a job.
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
Job |
constraints()
Get if omitted, the existing execution constraints are left unchanged. |
|
List<Metadata |
metadata()
Get if omitted, the existing job metadata is left unchanged. |
|
On |
onAllTasksComplete()
Get if omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'noAction', 'terminateJob'. |
|
Pool |
poolInfo()
Get you may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool. |
| Integer |
priority()
Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged. |
|
Job |
withConstraints(JobConstraints constraints)
Set if omitted, the existing execution constraints are left unchanged. |
|
Job |
withMetadata(List<MetadataItem> metadata)
Set if omitted, the existing job metadata is left unchanged. |
|
Job |
withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
Set if omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'noAction', 'terminateJob'. |
|
Job |
withPoolInfo(PoolInformation poolInfo)
Set you may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool. |
|
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. If omitted, the priority of the job is left unchanged. |
Method Details
constraints
public JobConstraints constraints()
Get if omitted, the existing execution constraints are left unchanged.
Returns:
metadata
public List
Get if omitted, the existing job metadata is left unchanged.
Returns:
onAllTasksComplete
public OnAllTasksComplete onAllTasksComplete()
Get if omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'noAction', 'terminateJob'.
Returns:
poolInfo
public PoolInformation poolInfo()
Get you may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool.
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. If omitted, the priority of the job is left unchanged.
Returns:
withConstraints
public JobPatchParameter withConstraints(JobConstraints constraints)
Set if omitted, the existing execution constraints are left unchanged.
Parameters:
Returns:
withMetadata
public JobPatchParameter withMetadata(List
Set if omitted, the existing job metadata is left unchanged.
Parameters:
Returns:
withOnAllTasksComplete
public JobPatchParameter withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
Set if omitted, the completion behavior is left unchanged. You may not change the value from terminatejob to noaction - that is, once you have engaged automatic job termination, you cannot turn it off again. If you try to do this, the request fails with an 'invalid property value' error response; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request). Possible values include: 'noAction', 'terminateJob'.
Parameters:
Returns:
withPoolInfo
public JobPatchParameter withPoolInfo(PoolInformation poolInfo)
Set you may change the pool for a job only when the job is disabled. The Patch Job call will fail if you include the poolInfo element and the job is not disabled. If you specify an autoPoolSpecification specification in the poolInfo, only the keepAlive property can be updated, and then only if the auto pool has a poolLifetimeOption of job. If omitted, the job continues to run on its current pool.
Parameters:
Returns:
withPriority
public JobPatchParameter withPriority(Integer priority)
Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, the priority of the job is left unchanged.
Parameters:
Returns:
