PoolResizeParameter Class

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

public class PoolResizeParameter

Options for changing the size of a pool.

Method Summary

Modifier and Type Method and Description
ComputeNodeDeallocationOption nodeDeallocationOption()

Get the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'.
Period resizeTimeout()

Get the default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
Integer targetDedicatedNodes()

Get the targetDedicatedNodes value.
Integer targetLowPriorityNodes()

Get the targetLowPriorityNodes value.
PoolResizeParameter withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'.
PoolResizeParameter withResizeTimeout(Period resizeTimeout)

Set the default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns an error; if you are calling the REST API directly, the HTTP status code is 400 (Bad Request).
PoolResizeParameter withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set the targetDedicatedNodes value.
PoolResizeParameter withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set the targetLowPriorityNodes value.

Method Details

nodeDeallocationOption

public ComputeNodeDeallocationOption nodeDeallocationOption()

Get the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'.

Returns:

the nodeDeallocationOption value

resizeTimeout

public Period resizeTimeout()

Get the default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns 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 value.

Returns:

the targetDedicatedNodes value

targetLowPriorityNodes

public Integer targetLowPriorityNodes()

Get the targetLowPriorityNodes value.

Returns:

the targetLowPriorityNodes value

withNodeDeallocationOption

public PoolResizeParameter withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'.

Parameters:

nodeDeallocationOption - the nodeDeallocationOption value to set

Returns:

the PoolResizeParameter object itself.

withResizeTimeout

public PoolResizeParameter withResizeTimeout(Period resizeTimeout)

Set the default value is 15 minutes. The minimum value is 5 minutes. If you specify a value less than 5 minutes, the Batch service returns 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 PoolResizeParameter object itself.

withTargetDedicatedNodes

public PoolResizeParameter withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set the targetDedicatedNodes value.

Parameters:

targetDedicatedNodes - the targetDedicatedNodes value to set

Returns:

the PoolResizeParameter object itself.

withTargetLowPriorityNodes

public PoolResizeParameter withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set the targetLowPriorityNodes value.

Parameters:

targetLowPriorityNodes - the targetLowPriorityNodes value to set

Returns:

the PoolResizeParameter object itself.

Applies to