FixedScaleSettings Class

  • java.lang.Object
    • com.azure.resourcemanager.batch.models.FixedScaleSettings

public final class FixedScaleSettings

Fixed scale settings for the pool.

Constructor Summary

Constructor Description
FixedScaleSettings()

Method Summary

Modifier and Type Method and Description
ComputeNodeDeallocationOption nodeDeallocationOption()

Get the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation.

Duration resizeTimeout()

Get the resizeTimeout property: The timeout for allocation of compute nodes to the pool.

Integer targetDedicatedNodes()

Get the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool.

Integer targetLowPriorityNodes()

Get the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool.

void validate()

Validates the instance.

FixedScaleSettings withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation.

FixedScaleSettings withResizeTimeout(Duration resizeTimeout)

Set the resizeTimeout property: The timeout for allocation of compute nodes to the pool.

FixedScaleSettings withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool.

FixedScaleSettings withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool.

Methods inherited from java.lang.Object

Constructor Details

FixedScaleSettings

public FixedScaleSettings()

Method Details

nodeDeallocationOption

public ComputeNodeDeallocationOption nodeDeallocationOption()

Get the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation. If omitted, the default value is Requeue.

Returns:

the nodeDeallocationOption value.

resizeTimeout

public Duration resizeTimeout()

Get the resizeTimeout property: The timeout for allocation of compute nodes to the pool. The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Returns:

the resizeTimeout value.

targetDedicatedNodes

public Integer targetDedicatedNodes()

Get the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool. At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Returns:

the targetDedicatedNodes value.

targetLowPriorityNodes

public Integer targetLowPriorityNodes()

Get the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool. At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Returns:

the targetLowPriorityNodes value.

validate

public void validate()

Validates the instance.

withNodeDeallocationOption

public FixedScaleSettings withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation. If omitted, the default value is Requeue.

Parameters:

nodeDeallocationOption - the nodeDeallocationOption value to set.

Returns:

the FixedScaleSettings object itself.

withResizeTimeout

public FixedScaleSettings withResizeTimeout(Duration resizeTimeout)

Set the resizeTimeout property: The timeout for allocation of compute nodes to the pool. The default value is 15 minutes. Timeout values use ISO 8601 format. For example, use PT10M for 10 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service rejects the request with an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).

Parameters:

resizeTimeout - the resizeTimeout value to set.

Returns:

the FixedScaleSettings object itself.

withTargetDedicatedNodes

public FixedScaleSettings withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool. At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Parameters:

targetDedicatedNodes - the targetDedicatedNodes value to set.

Returns:

the FixedScaleSettings object itself.

withTargetLowPriorityNodes

public FixedScaleSettings withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool. At least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Parameters:

targetLowPriorityNodes - the targetLowPriorityNodes value to set.

Returns:

the FixedScaleSettings object itself.

Applies to