228 строки
20 KiB
YAML
228 строки
20 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter"
|
|
name: "JobPatchParameter"
|
|
nameWithType: "JobPatchParameter"
|
|
summary: "The set of changes to be made to a Job."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public class **JobPatchParameter**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.JobPatchParameter()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.JobPatchParameter()"
|
|
name: "JobPatchParameter()"
|
|
nameWithType: "JobPatchParameter.JobPatchParameter()"
|
|
syntax: "public JobPatchParameter()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.allowTaskPreemption()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.allowTaskPreemption()"
|
|
name: "allowTaskPreemption()"
|
|
nameWithType: "JobPatchParameter.allowTaskPreemption()"
|
|
summary: "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."
|
|
syntax: "public Boolean allowTaskPreemption()"
|
|
desc: "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:
|
|
description: "the allowTaskPreemption value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.constraints()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.constraints()"
|
|
name: "constraints()"
|
|
nameWithType: "JobPatchParameter.constraints()"
|
|
summary: "Get if omitted, the existing execution constraints are left unchanged."
|
|
syntax: "public JobConstraints constraints()"
|
|
desc: "Get if omitted, the existing execution constraints are left unchanged."
|
|
returns:
|
|
description: "the constraints value"
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.maxParallelTasks()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.maxParallelTasks()"
|
|
name: "maxParallelTasks()"
|
|
nameWithType: "JobPatchParameter.maxParallelTasks()"
|
|
summary: "Get the value of max<wbr>Parallel<wbr>Tasks must be -1 or greater than 0 if specified."
|
|
syntax: "public Integer maxParallelTasks()"
|
|
desc: "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:
|
|
description: "the maxParallelTasks value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.metadata()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.metadata()"
|
|
name: "metadata()"
|
|
nameWithType: "JobPatchParameter.metadata()"
|
|
summary: "Get if omitted, the existing Job metadata is left unchanged."
|
|
syntax: "public List<MetadataItem> metadata()"
|
|
desc: "Get if omitted, the existing Job metadata is left unchanged."
|
|
returns:
|
|
description: "the metadata value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<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\" />>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.networkConfiguration()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.networkConfiguration()"
|
|
name: "networkConfiguration()"
|
|
nameWithType: "JobPatchParameter.networkConfiguration()"
|
|
summary: "Get the network<wbr>Configuration value."
|
|
syntax: "public JobNetworkConfiguration networkConfiguration()"
|
|
desc: "Get the networkConfiguration value."
|
|
returns:
|
|
description: "the networkConfiguration value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration?alt=com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration&text=JobNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.onAllTasksComplete()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.onAllTasksComplete()"
|
|
name: "onAllTasksComplete()"
|
|
nameWithType: "JobPatchParameter.onAllTasksComplete()"
|
|
summary: "Get if omitted, the completion behavior is left unchanged."
|
|
syntax: "public OnAllTasksComplete onAllTasksComplete()"
|
|
desc: "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:
|
|
description: "the onAllTasksComplete value"
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.poolInfo()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.poolInfo()"
|
|
name: "poolInfo()"
|
|
nameWithType: "JobPatchParameter.poolInfo()"
|
|
summary: "Get you may change the Pool for a Job only when the Job is disabled."
|
|
syntax: "public PoolInformation poolInfo()"
|
|
desc: "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 in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on its current Pool."
|
|
returns:
|
|
description: "the poolInfo value"
|
|
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\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.priority()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.priority()"
|
|
name: "priority()"
|
|
nameWithType: "JobPatchParameter.priority()"
|
|
summary: "Get priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority."
|
|
syntax: "public Integer priority()"
|
|
desc: "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:
|
|
description: "the priority value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withAllowTaskPreemption(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withAllowTaskPreemption(Boolean allowTaskPreemption)"
|
|
name: "withAllowTaskPreemption(Boolean allowTaskPreemption)"
|
|
nameWithType: "JobPatchParameter.withAllowTaskPreemption(Boolean allowTaskPreemption)"
|
|
summary: "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."
|
|
parameters:
|
|
- description: "the allowTaskPreemption value to set"
|
|
name: "allowTaskPreemption"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public JobPatchParameter withAllowTaskPreemption(Boolean allowTaskPreemption)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withConstraints(com.microsoft.azure.batch.protocol.models.JobConstraints)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withConstraints(JobConstraints constraints)"
|
|
name: "withConstraints(JobConstraints constraints)"
|
|
nameWithType: "JobPatchParameter.withConstraints(JobConstraints constraints)"
|
|
summary: "Set if omitted, the existing execution constraints are left unchanged."
|
|
parameters:
|
|
- description: "the constraints value to set"
|
|
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\" />"
|
|
syntax: "public JobPatchParameter withConstraints(JobConstraints constraints)"
|
|
desc: "Set if omitted, the existing execution constraints are left unchanged."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withMaxParallelTasks(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withMaxParallelTasks(Integer maxParallelTasks)"
|
|
name: "withMaxParallelTasks(Integer maxParallelTasks)"
|
|
nameWithType: "JobPatchParameter.withMaxParallelTasks(Integer maxParallelTasks)"
|
|
summary: "Set the value of max<wbr>Parallel<wbr>Tasks must be -1 or greater than 0 if specified."
|
|
parameters:
|
|
- description: "the maxParallelTasks value to set"
|
|
name: "maxParallelTasks"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public JobPatchParameter withMaxParallelTasks(Integer maxParallelTasks)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withMetadata(java.util.List<com.microsoft.azure.batch.protocol.models.MetadataItem>)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withMetadata(List<MetadataItem> metadata)"
|
|
name: "withMetadata(List<MetadataItem> metadata)"
|
|
nameWithType: "JobPatchParameter.withMetadata(List<MetadataItem> metadata)"
|
|
summary: "Set if omitted, the existing Job metadata is left unchanged."
|
|
parameters:
|
|
- description: "the metadata value to set"
|
|
name: "metadata"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<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\" />>"
|
|
syntax: "public JobPatchParameter withMetadata(List<MetadataItem> metadata)"
|
|
desc: "Set if omitted, the existing Job metadata is left unchanged."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withNetworkConfiguration(com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
|
|
name: "withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
|
|
nameWithType: "JobPatchParameter.withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
|
|
summary: "Set the network<wbr>Configuration value."
|
|
parameters:
|
|
- description: "the networkConfiguration value to set"
|
|
name: "networkConfiguration"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration?alt=com.microsoft.azure.batch.protocol.models.JobNetworkConfiguration&text=JobNetworkConfiguration\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public JobPatchParameter withNetworkConfiguration(JobNetworkConfiguration networkConfiguration)"
|
|
desc: "Set the networkConfiguration value."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withOnAllTasksComplete(com.microsoft.azure.batch.protocol.models.OnAllTasksComplete)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
|
|
name: "withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
|
|
nameWithType: "JobPatchParameter.withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
|
|
summary: "Set if omitted, the completion behavior is left unchanged."
|
|
parameters:
|
|
- description: "the onAllTasksComplete value to set"
|
|
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\" />"
|
|
syntax: "public JobPatchParameter withOnAllTasksComplete(OnAllTasksComplete onAllTasksComplete)"
|
|
desc: "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'."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withPoolInfo(com.microsoft.azure.batch.protocol.models.PoolInformation)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withPoolInfo(PoolInformation poolInfo)"
|
|
name: "withPoolInfo(PoolInformation poolInfo)"
|
|
nameWithType: "JobPatchParameter.withPoolInfo(PoolInformation poolInfo)"
|
|
summary: "Set you may change the Pool for a Job only when the Job is disabled."
|
|
parameters:
|
|
- description: "the poolInfo value to set"
|
|
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\" />"
|
|
syntax: "public JobPatchParameter withPoolInfo(PoolInformation poolInfo)"
|
|
desc: "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 in the poolInfo, only the keepAlive property of the autoPoolSpecification can be updated, and then only if the autoPoolSpecification has a poolLifetimeOption of Job (other job properties can be updated as normal). If omitted, the Job continues to run on its current Pool."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withPriority(java.lang.Integer)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.JobPatchParameter.withPriority(Integer priority)"
|
|
name: "withPriority(Integer priority)"
|
|
nameWithType: "JobPatchParameter.withPriority(Integer priority)"
|
|
summary: "Set priority values can range from -1000 to 1000, with -1000 being the lowest priority and 1000 being the highest priority."
|
|
parameters:
|
|
- description: "the priority value to set"
|
|
name: "priority"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
syntax: "public JobPatchParameter withPriority(Integer priority)"
|
|
desc: "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."
|
|
returns:
|
|
description: "the JobPatchParameter object itself."
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.JobPatchParameter?alt=com.microsoft.azure.batch.protocol.models.JobPatchParameter&text=JobPatchParameter\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The set of changes to be made to a Job."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|