Share via

AutoPoolSpecification Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.AutoPoolSpecification

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.
PoolSpecification pool()

Get the pool value.
PoolLifetimeOption poolLifetimeOption()

Get possible values include: 'jobSchedule', 'job'.
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.
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.
AutoPoolSpecification withPool(PoolSpecification pool)

Set the pool value.
AutoPoolSpecification 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:

the autoPoolIdPrefix value

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:

the keepAlive value

pool

public PoolSpecification pool()

Get the pool value.

Returns:

the pool value

poolLifetimeOption

public PoolLifetimeOption poolLifetimeOption()

Get possible values include: 'jobSchedule', 'job'.

Returns:

the poolLifetimeOption value

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:

autoPoolIdPrefix - the autoPoolIdPrefix value to set

Returns:

the AutoPoolSpecification object itself.

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:

keepAlive - the keepAlive value to set

Returns:

the AutoPoolSpecification object itself.

withPool

public AutoPoolSpecification withPool(PoolSpecification pool)

Set the pool value.

Parameters:

pool - the pool value to set

Returns:

the AutoPoolSpecification object itself.

withPoolLifetimeOption

public AutoPoolSpecification withPoolLifetimeOption(PoolLifetimeOption poolLifetimeOption)

Set possible values include: 'jobSchedule', 'job'.

Parameters:

poolLifetimeOption - the poolLifetimeOption value to set

Returns:

the AutoPoolSpecification object itself.

Applies to