Class ResizeOperationStatus
Describes either the current operation (if the pool AllocationState is Resizing) or the previously completed operation (if the AllocationState is Steady).
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionerrors()
Get the errors property: Details of any errors encountered while performing the last resize on the pool.Get the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation.Get the resizeTimeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.Get the startTime property: The time when this resize operation was started.Get the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool.Get the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool.void
validate()
Validates the instance.withErrors
(List<ResizeError> errors) Set the errors property: Details of any errors encountered while performing the last resize on the pool.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.withResizeTimeout
(Duration resizeTimeout) Set the resizeTimeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.withStartTime
(OffsetDateTime startTime) Set the startTime property: The time when this resize operation was started.withTargetDedicatedNodes
(Integer targetDedicatedNodes) Set the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool.withTargetLowPriorityNodes
(Integer targetLowPriorityNodes) Set the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool.
-
Constructor Details
-
ResizeOperationStatus
public ResizeOperationStatus()Creates an instance of ResizeOperationStatus class.
-
-
Method Details
-
targetDedicatedNodes
Get the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool.- Returns:
- the targetDedicatedNodes value.
-
withTargetDedicatedNodes
Set the targetDedicatedNodes property: The desired number of dedicated compute nodes in the pool.- Parameters:
targetDedicatedNodes
- the targetDedicatedNodes value to set.- Returns:
- the ResizeOperationStatus object itself.
-
targetLowPriorityNodes
Get the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool.- Returns:
- the targetLowPriorityNodes value.
-
withTargetLowPriorityNodes
Set the targetLowPriorityNodes property: The desired number of Spot/low-priority compute nodes in the pool.- Parameters:
targetLowPriorityNodes
- the targetLowPriorityNodes value to set.- Returns:
- the ResizeOperationStatus object itself.
-
resizeTimeout
Get the resizeTimeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.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.
-
withResizeTimeout
Set the resizeTimeout property: The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool.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 ResizeOperationStatus object itself.
-
nodeDeallocationOption
Get the nodeDeallocationOption property: Determines what to do with a node and its running task(s) after it has been selected for deallocation.The default value is requeue.
- Returns:
- the nodeDeallocationOption value.
-
withNodeDeallocationOption
public ResizeOperationStatus 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.The default value is requeue.
- Parameters:
nodeDeallocationOption
- the nodeDeallocationOption value to set.- Returns:
- the ResizeOperationStatus object itself.
-
startTime
Get the startTime property: The time when this resize operation was started.- Returns:
- the startTime value.
-
withStartTime
Set the startTime property: The time when this resize operation was started.- Parameters:
startTime
- the startTime value to set.- Returns:
- the ResizeOperationStatus object itself.
-
errors
Get the errors property: Details of any errors encountered while performing the last resize on the pool.This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.
- Returns:
- the errors value.
-
withErrors
Set the errors property: Details of any errors encountered while performing the last resize on the pool.This property is set only if an error occurred during the last pool resize, and only when the pool allocationState is Steady.
- Parameters:
errors
- the errors value to set.- Returns:
- the ResizeOperationStatus object itself.
-
validate
public void validate()Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-