Share via

FixedScaleSettings Class

  • Reference
Package:
com.microsoft.azure.management.batch
  • java.lang.Object
    • com.microsoft.azure.management.batch.FixedScaleSettings

public class FixedScaleSettings

Fixed scale settings for the pool.

Method Summary

Modifier and Type Method and Description
ComputeNodeDeallocationOption nodeDeallocationOption()

Get if omitted, the default value is Requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'.
Period resizeTimeout()

Get 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).
Integer targetDedicatedNodes()

Get at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.
Integer targetLowPriorityNodes()

Get at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.
FixedScaleSettings withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set if omitted, the default value is Requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'.
FixedScaleSettings withResizeTimeout(Period resizeTimeout)

Set 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).
FixedScaleSettings withTargetDedicatedNodes(Integer targetDedicatedNodes)

Set at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.
FixedScaleSettings withTargetLowPriorityNodes(Integer targetLowPriorityNodes)

Set at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Method Details

nodeDeallocationOption

public ComputeNodeDeallocationOption nodeDeallocationOption()

Get if omitted, 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. 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 at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Returns:

the targetDedicatedNodes value

targetLowPriorityNodes

public Integer targetLowPriorityNodes()

Get at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Returns:

the targetLowPriorityNodes value

withNodeDeallocationOption

public FixedScaleSettings withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set if omitted, the default value is Requeue. Possible values include: 'Requeue', 'Terminate', 'TaskCompletion', 'RetainedData'.

Parameters:

nodeDeallocationOption - the nodeDeallocationOption value to set

Returns:

the FixedScaleSettings object itself.

withResizeTimeout

public FixedScaleSettings withResizeTimeout(Period resizeTimeout)

Set 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 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 at least one of targetDedicatedNodes, targetLowPriorityNodes must be set.

Parameters:

targetLowPriorityNodes - the targetLowPriorityNodes value to set

Returns:

the FixedScaleSettings object itself.

Applies to