154 строки
11 KiB
YAML
154 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
inheritances:
|
|
- <xref href="java.lang.Object" data-throw-if-not-resolved="False"/>
|
|
methods:
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.constraints()
|
|
name: constraints()
|
|
nameWithType: JobUpdateParameter.constraints()
|
|
returns:
|
|
description: <p>the constraints value </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobConstraints?alt=com.microsoft.azure.batch.protocol.models.JobConstraints&text=JobConstraints" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Get if omitted, the constraints are cleared.</p>
|
|
|
|
<p></p>
|
|
syntax: public JobConstraints constraints()
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.constraints()
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.metadata()
|
|
name: metadata()
|
|
nameWithType: JobUpdateParameter.metadata()
|
|
returns:
|
|
description: <p>the metadata value </p>
|
|
type: List<<xref href="com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem" data-throw-if-not-resolved="False"/>>
|
|
summary: >-
|
|
<p>Get if omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted.</p>
|
|
|
|
<p></p>
|
|
syntax: public List<MetadataItem> metadata()
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.metadata()
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.onAllTasksComplete()
|
|
name: onAllTasksComplete()
|
|
nameWithType: JobUpdateParameter.onAllTasksComplete()
|
|
returns:
|
|
description: <p>the onAllTasksComplete value </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.OnAllTasksComplete?alt=com.microsoft.azure.batch.protocol.models.OnAllTasksComplete&text=OnAllTasksComplete" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Get if omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. 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 and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob. Possible values include: 'noAction', 'terminateJob'.</p>
|
|
|
|
<p></p>
|
|
syntax: public OnAllTasksComplete onAllTasksComplete()
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.onAllTasksComplete()
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.poolInfo()
|
|
name: poolInfo()
|
|
nameWithType: JobUpdateParameter.poolInfo()
|
|
returns:
|
|
description: <p>the poolInfo value </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.PoolInformation?alt=com.microsoft.azure.batch.protocol.models.PoolInformation&text=PoolInformation" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Get you may change the pool for a job only when the job is disabled. The Update 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.</p>
|
|
|
|
<p></p>
|
|
syntax: public PoolInformation poolInfo()
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.poolInfo()
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.priority()
|
|
name: priority()
|
|
nameWithType: JobUpdateParameter.priority()
|
|
returns:
|
|
description: <p>the priority value </p>
|
|
type: <xref href="Integer?alt=Integer&text=Integer" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0.</p>
|
|
|
|
<p></p>
|
|
syntax: public Integer priority()
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.priority()
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withConstraints(JobConstraints constraints)
|
|
name: withConstraints(JobConstraints constraints)
|
|
nameWithType: JobUpdateParameter.withConstraints(JobConstraints constraints)
|
|
parameters:
|
|
- description: <p>the constraints value to set </p>
|
|
name: constraints
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobConstraints?alt=com.microsoft.azure.batch.protocol.models.JobConstraints&text=JobConstraints" data-throw-if-not-resolved="False"/>
|
|
returns:
|
|
description: <p>the JobUpdateParameter object itself. </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobUpdateParameter?alt=com.microsoft.azure.batch.protocol.models.JobUpdateParameter&text=JobUpdateParameter" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set if omitted, the constraints are cleared.</p>
|
|
|
|
<p></p>
|
|
syntax: public JobUpdateParameter withConstraints(JobConstraints constraints)
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withConstraints(JobConstraints)
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withMetadata(List<MetadataItem> metadata)
|
|
name: withMetadata(List<MetadataItem> metadata)
|
|
nameWithType: JobUpdateParameter.withMetadata(List<MetadataItem> metadata)
|
|
parameters:
|
|
- description: <p>the metadata value to set </p>
|
|
name: metadata
|
|
type: List<<xref href="com.microsoft.azure.batch.protocol.models.MetadataItem?alt=com.microsoft.azure.batch.protocol.models.MetadataItem&text=MetadataItem" data-throw-if-not-resolved="False"/>>
|
|
returns:
|
|
description: <p>the JobUpdateParameter object itself. </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobUpdateParameter?alt=com.microsoft.azure.batch.protocol.models.JobUpdateParameter&text=JobUpdateParameter" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set if omitted, it takes the default value of an empty list; in effect, any existing metadata is deleted.</p>
|
|
|
|
<p></p>
|
|
syntax: public JobUpdateParameter withMetadata(List<MetadataItem> metadata)
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withMetadata(List<MetadataItem>)
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
|
|
name: withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
|
|
nameWithType: JobUpdateParameter.withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
|
|
parameters:
|
|
- description: <p>the onAllTasksComplete value to set </p>
|
|
name: onAllTasksComplete
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.OnAllTasksComplete?alt=com.microsoft.azure.batch.protocol.models.OnAllTasksComplete&text=OnAllTasksComplete" data-throw-if-not-resolved="False"/>
|
|
returns:
|
|
description: <p>the JobUpdateParameter object itself. </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobUpdateParameter?alt=com.microsoft.azure.batch.protocol.models.JobUpdateParameter&text=JobUpdateParameter" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set if omitted, the completion behavior is set to noaction. If the current value is terminatejob, this is an error because a job's completion behavior may not be changed from terminatejob to noaction. 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 and Batch returns status code 400 (Bad Request) and an 'invalid property value' error response. If you do not specify this element in a PUT request, it is equivalent to passing noaction. This is an error if the current value is terminatejob. Possible values include: 'noAction', 'terminateJob'.</p>
|
|
|
|
<p></p>
|
|
syntax: public JobUpdateParameter withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withOnAllTasksComplete(OnAllTasksComplete)
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withPoolInfo(PoolInformation poolInfo)
|
|
name: withPoolInfo(PoolInformation poolInfo)
|
|
nameWithType: JobUpdateParameter.withPoolInfo(PoolInformation poolInfo)
|
|
parameters:
|
|
- description: <p>the poolInfo value to set </p>
|
|
name: poolInfo
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.PoolInformation?alt=com.microsoft.azure.batch.protocol.models.PoolInformation&text=PoolInformation" data-throw-if-not-resolved="False"/>
|
|
returns:
|
|
description: <p>the JobUpdateParameter object itself. </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobUpdateParameter?alt=com.microsoft.azure.batch.protocol.models.JobUpdateParameter&text=JobUpdateParameter" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set you may change the pool for a job only when the job is disabled. The Update 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.</p>
|
|
|
|
<p></p>
|
|
syntax: public JobUpdateParameter withPoolInfo(PoolInformation poolInfo)
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withPoolInfo(PoolInformation)
|
|
- fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withPriority(Integer priority)
|
|
name: withPriority(Integer priority)
|
|
nameWithType: JobUpdateParameter.withPriority(Integer priority)
|
|
parameters:
|
|
- description: <p>the priority value to set </p>
|
|
name: priority
|
|
type: <xref href="Integer?alt=Integer&text=Integer" data-throw-if-not-resolved="False"/>
|
|
returns:
|
|
description: <p>the JobUpdateParameter object itself. </p>
|
|
type: <xref href="com.microsoft.azure.batch.protocol.models.JobUpdateParameter?alt=com.microsoft.azure.batch.protocol.models.JobUpdateParameter&text=JobUpdateParameter" data-throw-if-not-resolved="False"/>
|
|
summary: >-
|
|
<p>Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority. If omitted, it is set to the default value 0.</p>
|
|
|
|
<p></p>
|
|
syntax: public JobUpdateParameter withPriority(Integer priority)
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter.withPriority(Integer)
|
|
nameWithType: JobUpdateParameter
|
|
syntax: public class JobUpdateParameter
|
|
type: class
|
|
uid: com.microsoft.azure.batch.protocol.models.JobUpdateParameter
|
|
fullName: com.microsoft.azure.batch.protocol.models.JobUpdateParameter
|
|
name: JobUpdateParameter
|
|
package: com.microsoft.azure.batch.protocol.models
|
|
summary: <p>The set of changes to be made to a job. </p>
|
|
metadata: {}
|