BatchAutoPoolSpecification Class

Package:

com.azure.compute.batch.models

Maven Artifact:

com.azure:azure-compute-batch:1.0.0-beta.5

• java.lang.Object
• • com.azure.compute.batch.models.BatchAutoPoolSpecification

Implements

JsonSerializable<BatchAutoPoolSpecification>

public final class BatchAutoPoolSpecification
implements JsonSerializable<BatchAutoPoolSpecification>

Specifies characteristics for a temporary 'auto pool'. The Batch service will create this auto Pool when the Job is submitted.

Constructor Summary

Constructor	Description
BatchAutoPoolSpecification(BatchPoolLifetimeOption poolLifetimeOption)	Creates an instance of BatchAutoPoolSpecification class.

Method Summary

Modifier and Type	Method and Description
static BatchAutoPoolSpecification	fromJson(JsonReader jsonReader) Reads an instance of BatchAutoPoolSpecification from the JsonReader.
String	getAutoPoolIdPrefix() Get the autoPoolIdPrefix property: A prefix to be added to the unique identifier when a Pool is automatically created.
BatchPoolSpecification	getPool() Get the pool property: The Pool specification for the auto Pool.
BatchPoolLifetimeOption	getPoolLifetimeOption() Get the poolLifetimeOption property: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.
Boolean	isKeepAlive() Get the keepAlive property: Whether to keep an auto Pool alive after its lifetime expires.
BatchAutoPoolSpecification	setAutoPoolIdPrefix(String autoPoolIdPrefix) Set the autoPoolIdPrefix property: A prefix to be added to the unique identifier when a Pool is automatically created.
BatchAutoPoolSpecification	setKeepAlive(Boolean keepAlive) Set the keepAlive property: Whether to keep an auto Pool alive after its lifetime expires.
BatchAutoPoolSpecification	setPool(BatchPoolSpecification pool) Set the pool property: The Pool specification for the auto Pool.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BatchAutoPoolSpecification

public BatchAutoPoolSpecification(BatchPoolLifetimeOption poolLifetimeOption)

Creates an instance of BatchAutoPoolSpecification class.

Parameters:

poolLifetimeOption - the poolLifetimeOption value to set.

Method Details

fromJson

public static BatchAutoPoolSpecification fromJson(JsonReader jsonReader)

Reads an instance of BatchAutoPoolSpecification from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BatchAutoPoolSpecification if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getAutoPoolIdPrefix

public String getAutoPoolIdPrefix()

Get the autoPoolIdPrefix property: A prefix to be added to the unique identifier when a Pool is automatically created. 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.

getPool

public BatchPoolSpecification getPool()

Get the pool property: The Pool specification for the auto Pool.

Returns:

the pool value.

getPoolLifetimeOption

public BatchPoolLifetimeOption getPoolLifetimeOption()

Get the poolLifetimeOption property: The minimum lifetime of created auto Pools, and how multiple Jobs on a schedule are assigned to Pools.

Returns:

the poolLifetimeOption value.

isKeepAlive

public Boolean isKeepAlive()

Get the keepAlive property: Whether to keep an auto Pool alive after its lifetime expires. 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.

setAutoPoolIdPrefix

public BatchAutoPoolSpecification setAutoPoolIdPrefix(String autoPoolIdPrefix)

Set the autoPoolIdPrefix property: A prefix to be added to the unique identifier when a Pool is automatically created. 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 BatchAutoPoolSpecification object itself.

setKeepAlive

public BatchAutoPoolSpecification setKeepAlive(Boolean keepAlive)

Set the keepAlive property: Whether to keep an auto Pool alive after its lifetime expires. 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 BatchAutoPoolSpecification object itself.

setPool

public BatchAutoPoolSpecification setPool(BatchPoolSpecification pool)

Set the pool property: The Pool specification for the auto Pool.

Parameters:

pool - the pool value to set.

Returns:

the BatchAutoPoolSpecification object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException