AutoPoolSpecification Class
- java.
lang. Object - com.
microsoft. azure. batch. protocol. models. AutoPoolSpecification
- com.
public class AutoPoolSpecification
Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto pool when the job is submitted.
Method Summary
Modifier and Type | Method and Description |
---|---|
String |
autoPoolIdPrefix()
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. |
Boolean |
keepAlive()
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. |
Pool |
pool()
Get the pool value. |
Pool |
poolLifetimeOption()
Get possible values include: 'jobSchedule', 'job'. |
Auto |
withAutoPoolIdPrefix(String autoPoolIdPrefix)
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. |
Auto |
withKeepAlive(Boolean keepAlive)
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. |
Auto |
withPool(PoolSpecification pool)
Set the pool value. |
Auto |
withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)
Set possible values include: 'jobSchedule', 'job'. |
Method Details
autoPoolIdPrefix
public String autoPoolIdPrefix()
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:
keepAlive
public Boolean keepAlive()
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:
pool
public PoolSpecification pool()
Get the pool value.
Returns:
poolLifetimeOption
public PoolLifetimeOption poolLifetimeOption()
Get possible values include: 'jobSchedule', 'job'.
Returns:
withAutoPoolIdPrefix
public AutoPoolSpecification withAutoPoolIdPrefix(String autoPoolIdPrefix)
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.
Parameters:
Returns:
withKeepAlive
public AutoPoolSpecification withKeepAlive(Boolean keepAlive)
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.
Parameters:
Returns:
withPool
public AutoPoolSpecification withPool(PoolSpecification pool)
Set the pool value.
Parameters:
Returns:
withPoolLifetimeOption
public AutoPoolSpecification withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)
Set possible values include: 'jobSchedule', 'job'.
Parameters:
Returns:
Applies to
Azure SDK for Java