PoolInformation Class

Package:

com.microsoft.azure.batch.protocol.models

Maven Artifact:

com.microsoft.azure:azure-batch:11.1.1

• java.lang.Object
• • com.microsoft.azure.batch.protocol.models.PoolInformation

public class PoolInformation

Specifies how a Job should be assigned to a Pool.

Constructor Summary

Constructor	Description
PoolInformation()

Method Summary

Modifier and Type	Method and Description
AutoPoolSpecification	autoPoolSpecification() 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.
String	poolId() Get you must ensure that the Pool referenced by this property exists.
PoolInformation	withAutoPoolSpecification(AutoPoolSpecification autoPoolSpecification) 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.
PoolInformation	withPoolId(String poolId) Set you must ensure that the Pool referenced by this property exists.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PoolInformation

public PoolInformation()

Method Details

autoPoolSpecification

public AutoPoolSpecification autoPoolSpecification()

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:

the autoPoolSpecification value

poolId

public String poolId()

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:

the poolId value

withAutoPoolSpecification

public PoolInformation withAutoPoolSpecification(AutoPoolSpecification autoPoolSpecification)

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.

Parameters:

autoPoolSpecification - the autoPoolSpecification value to set

Returns:

the PoolInformation object itself.

withPoolId

public PoolInformation withPoolId(String poolId)

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.

Parameters:

poolId - the poolId value to set

Returns:

the PoolInformation object itself.