84 строки
7.4 KiB
YAML
84 строки
7.4 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.PoolInformation"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolInformation"
|
|
name: "PoolInformation"
|
|
nameWithType: "PoolInformation"
|
|
summary: "Specifies how a Job should be assigned to a Pool."
|
|
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 **PoolInformation**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolInformation.PoolInformation()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolInformation.PoolInformation()"
|
|
name: "PoolInformation()"
|
|
nameWithType: "PoolInformation.PoolInformation()"
|
|
syntax: "public PoolInformation()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolInformation.autoPoolSpecification()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolInformation.autoPoolSpecification()"
|
|
name: "autoPoolSpecification()"
|
|
nameWithType: "PoolInformation.autoPoolSpecification()"
|
|
summary: "Get if auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property."
|
|
syntax: "public AutoPoolSpecification autoPoolSpecification()"
|
|
desc: "Get if auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both."
|
|
returns:
|
|
description: "the autoPoolSpecification value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.AutoPoolSpecification?alt=com.microsoft.azure.batch.protocol.models.AutoPoolSpecification&text=AutoPoolSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolInformation.poolId()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolInformation.poolId()"
|
|
name: "poolId()"
|
|
nameWithType: "PoolInformation.poolId()"
|
|
summary: "Get you must ensure that the Pool referenced by this property exists."
|
|
syntax: "public String poolId()"
|
|
desc: "Get you must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both."
|
|
returns:
|
|
description: "the poolId value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.PoolInformation.withAutoPoolSpecification(com.microsoft.azure.batch.protocol.models.AutoPoolSpecification)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolInformation.withAutoPoolSpecification(AutoPoolSpecification autoPoolSpecification)"
|
|
name: "withAutoPoolSpecification(AutoPoolSpecification autoPoolSpecification)"
|
|
nameWithType: "PoolInformation.withAutoPoolSpecification(AutoPoolSpecification autoPoolSpecification)"
|
|
summary: "Set if auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property."
|
|
parameters:
|
|
- description: "the autoPoolSpecification value to set"
|
|
name: "autoPoolSpecification"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.AutoPoolSpecification?alt=com.microsoft.azure.batch.protocol.models.AutoPoolSpecification&text=AutoPoolSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public PoolInformation withAutoPoolSpecification(AutoPoolSpecification autoPoolSpecification)"
|
|
desc: "Set if auto Pool creation fails, the Batch service moves the Job to a completed state, and the Pool creation error is set in the Job's scheduling error property. The Batch service manages the lifetime (both creation and, unless keepAlive is specified, deletion) of the auto Pool. Any user actions that affect the lifetime of the auto Pool while the Job is active will result in unexpected behavior. You must specify either the Pool ID or the auto Pool specification, but not both."
|
|
returns:
|
|
description: "the PoolInformation object itself."
|
|
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.PoolInformation.withPoolId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.PoolInformation.withPoolId(String poolId)"
|
|
name: "withPoolId(String poolId)"
|
|
nameWithType: "PoolInformation.withPoolId(String poolId)"
|
|
summary: "Set you must ensure that the Pool referenced by this property exists."
|
|
parameters:
|
|
- description: "the poolId value to set"
|
|
name: "poolId"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public PoolInformation withPoolId(String poolId)"
|
|
desc: "Set you must ensure that the Pool referenced by this property exists. If the Pool does not exist at the time the Batch service tries to schedule a Job, no Tasks for the Job will run until you create a Pool with that id. Note that the Batch service will not reject the Job request; it will simply not run Tasks until the Pool exists. You must specify either the Pool ID or the auto Pool specification, but not both."
|
|
returns:
|
|
description: "the PoolInformation object itself."
|
|
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\" />"
|
|
type: "class"
|
|
desc: "Specifies how a Job should be assigned to a Pool."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|