NodeRemoveParameter Class

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.2.0
  • java.lang.Object
    • com.microsoft.azure.batch.protocol.models.NodeRemoveParameter

public class NodeRemoveParameter

Options for removing Compute Nodes from a Pool.

Constructor Summary

Constructor Description
NodeRemoveParameter()

Method Summary

Modifier and Type Method and Description
ComputeNodeDeallocationOption nodeDeallocationOption()

Get the default value is requeue.
List<String> nodeList()

Get a maximum of 100 nodes may be removed per request.
org.joda.time.Period resizeTimeout()

Get the default value is 15 minutes.
NodeRemoveParameter withNodeDeallocationOption(ComputeNodeDeallocationOption nodeDeallocationOption)

Set the default value is requeue.
NodeRemoveParameter withNodeList(List<String> nodeList)

Set a maximum of 100 nodes may be removed per request.
NodeRemoveParameter withResizeTimeout(Period resizeTimeout)

Set the default value is 15 minutes.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

NodeRemoveParameter

public NodeRemoveParameter()

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 a maximum of 100 nodes may be removed per request.

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 a maximum of 100 nodes may be removed per request.

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