132 строки
10 KiB
YAML
132 строки
10 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification"
|
|
name: "AutoPoolSpecification"
|
|
nameWithType: "AutoPoolSpecification"
|
|
summary: "Specifies characteristics for a temporary 'auto 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 **AutoPoolSpecification**"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.AutoPoolSpecification()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.AutoPoolSpecification()"
|
|
name: "AutoPoolSpecification()"
|
|
nameWithType: "AutoPoolSpecification.AutoPoolSpecification()"
|
|
syntax: "public AutoPoolSpecification()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.autoPoolIdPrefix()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.autoPoolIdPrefix()"
|
|
name: "autoPoolIdPrefix()"
|
|
nameWithType: "AutoPoolSpecification.autoPoolIdPrefix()"
|
|
summary: "Get the Batch service assigns each auto Pool a unique identifier on creation."
|
|
syntax: "public String autoPoolIdPrefix()"
|
|
desc: "Get the Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long."
|
|
returns:
|
|
description: "the autoPoolIdPrefix 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.AutoPoolSpecification.keepAlive()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.keepAlive()"
|
|
name: "keepAlive()"
|
|
nameWithType: "AutoPoolSpecification.keepAlive()"
|
|
summary: "Get if false, the Batch service deletes the Pool once its lifetime (as determined by the pool<wbr>Lifetime<wbr>Option setting) expires; that is, when the Job or Job Schedule completes."
|
|
syntax: "public Boolean keepAlive()"
|
|
desc: "Get if false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option."
|
|
returns:
|
|
description: "the keepAlive 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.AutoPoolSpecification.pool()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.pool()"
|
|
name: "pool()"
|
|
nameWithType: "AutoPoolSpecification.pool()"
|
|
summary: "Get the pool value."
|
|
syntax: "public PoolSpecification pool()"
|
|
desc: "Get the pool value."
|
|
returns:
|
|
description: "the pool value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolSpecification?alt=com.microsoft.azure.batch.protocol.models.PoolSpecification&text=PoolSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.poolLifetimeOption()"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.poolLifetimeOption()"
|
|
name: "poolLifetimeOption()"
|
|
nameWithType: "AutoPoolSpecification.poolLifetimeOption()"
|
|
summary: "Get possible values include: 'job<wbr>Schedule', 'job'."
|
|
syntax: "public PoolLifetimeOption poolLifetimeOption()"
|
|
desc: "Get possible values include: 'jobSchedule', 'job'."
|
|
returns:
|
|
description: "the poolLifetimeOption value"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolLifetimeOption?alt=com.microsoft.azure.batch.protocol.models.PoolLifetimeOption&text=PoolLifetimeOption\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.withAutoPoolIdPrefix(java.lang.String)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.withAutoPoolIdPrefix(String autoPoolIdPrefix)"
|
|
name: "withAutoPoolIdPrefix(String autoPoolIdPrefix)"
|
|
nameWithType: "AutoPoolSpecification.withAutoPoolIdPrefix(String autoPoolIdPrefix)"
|
|
summary: "Set the Batch service assigns each auto Pool a unique identifier on creation."
|
|
parameters:
|
|
- description: "the autoPoolIdPrefix value to set"
|
|
name: "autoPoolIdPrefix"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AutoPoolSpecification withAutoPoolIdPrefix(String autoPoolIdPrefix)"
|
|
desc: "Set the Batch service assigns each auto Pool a unique identifier on creation. To distinguish between Pools created for different purposes, you can specify this element to add a prefix to the ID that is assigned. The prefix can be up to 20 characters long."
|
|
returns:
|
|
description: "the AutoPoolSpecification object itself."
|
|
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.AutoPoolSpecification.withKeepAlive(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.withKeepAlive(Boolean keepAlive)"
|
|
name: "withKeepAlive(Boolean keepAlive)"
|
|
nameWithType: "AutoPoolSpecification.withKeepAlive(Boolean keepAlive)"
|
|
summary: "Set if false, the Batch service deletes the Pool once its lifetime (as determined by the pool<wbr>Lifetime<wbr>Option setting) expires; that is, when the Job or Job Schedule completes."
|
|
parameters:
|
|
- description: "the keepAlive value to set"
|
|
name: "keepAlive"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
syntax: "public AutoPoolSpecification withKeepAlive(Boolean keepAlive)"
|
|
desc: "Set if false, the Batch service deletes the Pool once its lifetime (as determined by the poolLifetimeOption setting) expires; that is, when the Job or Job Schedule completes. If true, the Batch service does not delete the Pool automatically. It is up to the user to delete auto Pools created with this option."
|
|
returns:
|
|
description: "the AutoPoolSpecification object itself."
|
|
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.AutoPoolSpecification.withPool(com.microsoft.azure.batch.protocol.models.PoolSpecification)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.withPool(PoolSpecification pool)"
|
|
name: "withPool(PoolSpecification pool)"
|
|
nameWithType: "AutoPoolSpecification.withPool(PoolSpecification pool)"
|
|
summary: "Set the pool value."
|
|
parameters:
|
|
- description: "the pool value to set"
|
|
name: "pool"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolSpecification?alt=com.microsoft.azure.batch.protocol.models.PoolSpecification&text=PoolSpecification\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AutoPoolSpecification withPool(PoolSpecification pool)"
|
|
desc: "Set the pool value."
|
|
returns:
|
|
description: "the AutoPoolSpecification object itself."
|
|
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.AutoPoolSpecification.withPoolLifetimeOption(com.microsoft.azure.batch.protocol.models.PoolLifetimeOption)"
|
|
fullName: "com.microsoft.azure.batch.protocol.models.AutoPoolSpecification.withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)"
|
|
name: "withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)"
|
|
nameWithType: "AutoPoolSpecification.withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)"
|
|
summary: "Set possible values include: 'job<wbr>Schedule', 'job'."
|
|
parameters:
|
|
- description: "the poolLifetimeOption value to set"
|
|
name: "poolLifetimeOption"
|
|
type: "<xref href=\"com.microsoft.azure.batch.protocol.models.PoolLifetimeOption?alt=com.microsoft.azure.batch.protocol.models.PoolLifetimeOption&text=PoolLifetimeOption\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AutoPoolSpecification withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)"
|
|
desc: "Set possible values include: 'jobSchedule', 'job'."
|
|
returns:
|
|
description: "the AutoPoolSpecification object itself."
|
|
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\" />"
|
|
type: "class"
|
|
desc: "Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted."
|
|
metadata: {}
|
|
package: "com.microsoft.azure.batch.protocol.models"
|
|
artifact: com.microsoft.azure:azure-batch:11.2.0
|