NodeRemoveParameter Class

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

public class NodeRemoveParameter

Options for removing compute nodes from 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'.
List<String> nodeList()

Get the nodeList value.
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).
NodeRemoveParameter withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set the default value is requeue. Possible values include: 'requeue', 'terminate', 'taskCompletion', 'retainedData'.
NodeRemoveParameter withNodeList(List<String> nodeList)

Set the nodeList value.
NodeRemoveParameter 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).

Method Details

nodeDeallocationOption

public ComputeNodeDeallocationOption nodeDeallocationOption()

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

Returns:

the nodeDeallocationOption value

nodeList

public List nodeList()

Get the nodeList value.

Returns:

the nodeList 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

withNodeDeallocationOption

public NodeRemoveParameter 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 NodeRemoveParameter object itself.

withNodeList

public NodeRemoveParameter withNodeList(List nodeList)

Set the nodeList value.

Parameters:

nodeList - the nodeList value to set

Returns:

the NodeRemoveParameter object itself.

withResizeTimeout

public NodeRemoveParameter 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 NodeRemoveParameter object itself.

Applies to