Share via

PoolOperations Class

  • Reference
Package:
com.microsoft.azure.batch

public class PoolOperations implements IInheritedBehaviors

Performs pool-related operations on an Azure Batch account.

Method Summary

Modifier and Type Method and Description
void createPool(PoolAddParameter pool)

Adds a pool to the Batch account.
void createPool(PoolAddParameter pool, Iterable<BatchClientBehavior> additionalBehaviors)

Adds a pool to the Batch account.
void createPool(String poolId, String virtualMachineSize, CloudServiceConfiguration cloudServiceConfiguration, int targetDedicatedNodes)

Adds a pool to the Batch account.
void createPool(String poolId, String virtualMachineSize, CloudServiceConfiguration cloudServiceConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)

Adds a pool to the Batch account.
void createPool(String poolId, String virtualMachineSize, CloudServiceConfiguration cloudServiceConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable<BatchClientBehavior> additionalBehaviors)

Adds a pool to the Batch account.
void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes)

Adds a pool to the Batch account.
void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)

Adds a pool to the Batch account.
void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable<BatchClientBehavior> additionalBehaviors)

Adds a pool to the Batch account.
Collection<BatchClientBehavior> customBehaviors()

Gets a collection of behaviors that modify or customize requests to the Batch service.
void deletePool(String poolId)

Deletes the specified pool.
void deletePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)

Deletes the specified pool.
void disableAutoScale(String poolId)

Disables automatic scaling on the specified pool.
void disableAutoScale(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)

Disables automatic scaling on the specified pool.
void enableAutoScale(String poolId)

Enables automatic scaling on the specified pool.
void enableAutoScale(String poolId, String autoScaleFormula)

Enables automatic scaling on the specified pool.
void enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval)

Enables automatic scaling on the specified pool.
void enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval, Iterable<BatchClientBehavior> additionalBehaviors)

Enables automatic scaling on the specified pool.
AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula)

Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.
AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula, Iterable<BatchClientBehavior> additionalBehaviors)

Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.
boolean existsPool(String poolId)

Checks whether the specified pool exists.
boolean existsPool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)

Checks whether the specified pool exists.
PoolStatistics getAllPoolsLifetimeStatistics()

Gets lifetime summary statistics for all of the pools in the current account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
PoolStatistics getAllPoolsLifetimeStatistics(Iterable<BatchClientBehavior> additionalBehaviors)

Gets lifetime summary statistics for all of the pools in the current account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.
CloudPool getPool(String poolId)

Gets the specified CloudPool.
CloudPool getPool(String poolId, DetailLevel detailLevel)

Gets the specified CloudPool.
CloudPool getPool(String poolId, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)

Gets the specified CloudPool.
PagedList<CloudPool> listPools()

Lists the pools in the Batch account.
PagedList<CloudPool> listPools(DetailLevel detailLevel)

Lists the pools in the Batch account.
PagedList<CloudPool> listPools(DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)

Lists the pools in the Batch account.
PagedList<PoolUsageMetrics> listPoolUsageMetrics(DateTime startTime, DateTime endTime)

Lists pool usage metrics.
PagedList<PoolUsageMetrics> listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel)

Lists pool usage metrics.
PagedList<PoolUsageMetrics> listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel, Iterable<BatchClientBehavior> additionalBehaviors)

Lists pool usage metrics.
void patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)

Updates the specified pool. This method only replaces the properties specified with non-null values.
void patchPool(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)

Updates the specified pool. This method only replaces the properties specified with non-null values.
void removeNodeFromPool(String poolId, String computeNodeId)

Removes the specified compute node from the specified pool.
void removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption)

Removes the specified compute node from the specified pool.
void removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)

Removes the specified compute node from the specified pool.
void removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes)

Removes the specified compute nodes from the specified pool.
void removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption)

Removes the specified compute nodes from the specified pool.
void removeNodesFromPool(String poolId, Collection<ComputeNode> computeNodes, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)

Removes the specified compute nodes from the specified pool.
void removeNodesFromPool(String poolId, List<String> computeNodeIds, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable<BatchClientBehavior> additionalBehaviors)

Removes the specified compute nodes from the specified pool.
void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes)

Resizes the specified pool.
void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout)

Resizes the specified pool.
void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption)

Resizes the specified pool.
void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption, Iterable<BatchClientBehavior> additionalBehaviors)

Resizes the specified pool.
void stopResizePool(String poolId)

Stops a pool resize operation.
void stopResizePool(String poolId, Iterable<BatchClientBehavior> additionalBehaviors)

Stops a pool resize operation.
void updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata)

Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task.
void updatePoolProperties(String poolId, StartTask startTask, Collection<CertificateReference> certificateReferences, Collection<ApplicationPackageReference> applicationPackageReferences, Collection<MetadataItem> metadata, Iterable<BatchClientBehavior> additionalBehaviors)

Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task.
IInheritedBehaviors withCustomBehaviors(Collection<BatchClientBehavior> behaviors)

Sets a collection of behaviors that modify or customize requests to the Batch service.

Method Details

createPool

public void createPool(PoolAddParameter pool)

Adds a pool to the Batch account.

Parameters:

pool - The pool to be added.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(PoolAddParameter pool, Iterable additionalBehaviors)

Adds a pool to the Batch account.

Parameters:

pool - The pool to be added.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(String poolId, String virtualMachineSize, CloudServiceConfiguration cloudServiceConfiguration, int targetDedicatedNodes)

Adds a pool to the Batch account.

Parameters:

poolId - The ID of the pool.
virtualMachineSize - The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/ for sizes.
cloudServiceConfiguration - The CloudServiceConfiguration for the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(String poolId, String virtualMachineSize, CloudServiceConfiguration cloudServiceConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)

Adds a pool to the Batch account.

Parameters:

poolId - The ID of the pool.
virtualMachineSize - The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/ for sizes.
cloudServiceConfiguration - The CloudServiceConfiguration for the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(String poolId, String virtualMachineSize, CloudServiceConfiguration cloudServiceConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable additionalBehaviors)

Adds a pool to the Batch account.

Parameters:

poolId - The ID of the pool.
virtualMachineSize - The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/ for sizes.
cloudServiceConfiguration - The CloudServiceConfiguration for the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes)

Adds a pool to the Batch account.

Parameters:

poolId - The ID of the pool.
virtualMachineSize - The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/ for sizes.
virtualMachineConfiguration - The VirtualMachineConfiguration for the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes)

Adds a pool to the Batch account.

Parameters:

poolId - The ID of the pool.
virtualMachineSize - The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/ for sizes.
virtualMachineConfiguration - The VirtualMachineConfiguration for the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

createPool

public void createPool(String poolId, String virtualMachineSize, VirtualMachineConfiguration virtualMachineConfiguration, int targetDedicatedNodes, int targetLowPriorityNodes, Iterable additionalBehaviors)

Adds a pool to the Batch account.

Parameters:

poolId - The ID of the pool.
virtualMachineSize - The size of virtual machines in the pool. See https://azure.microsoft.com/documentation/articles/virtual-machines-size-specs/ for sizes.
virtualMachineConfiguration - The VirtualMachineConfiguration for the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

customBehaviors

public Collection customBehaviors()

Gets a collection of behaviors that modify or customize requests to the Batch service.

Overrides:

PoolOperations.customBehaviors()

Returns:

A collection of BatchClientBehavior instances.

deletePool

public void deletePool(String poolId)

Deletes the specified pool.

Parameters:

poolId - The ID of the pool to delete.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

deletePool

public void deletePool(String poolId, Iterable additionalBehaviors)

Deletes the specified pool.

Parameters:

poolId - The ID of the pool to delete.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

disableAutoScale

public void disableAutoScale(String poolId)

Disables automatic scaling on the specified pool.

Parameters:

poolId - The ID of the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

disableAutoScale

public void disableAutoScale(String poolId, Iterable additionalBehaviors)

Disables automatic scaling on the specified pool.

Parameters:

poolId - The ID of the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

enableAutoScale

public void enableAutoScale(String poolId)

Enables automatic scaling on the specified pool.

Parameters:

poolId - The ID of the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

enableAutoScale

public void enableAutoScale(String poolId, String autoScaleFormula)

Enables automatic scaling on the specified pool.

Parameters:

poolId - The ID of the pool.
autoScaleFormula - The formula for the desired number of compute nodes in the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

enableAutoScale

public void enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval)

Enables automatic scaling on the specified pool.

Parameters:

poolId - The ID of the pool.
autoScaleFormula - The formula for the desired number of compute nodes in the pool.
autoScaleEvaluationInterval - The time interval at which to automatically adjust the pool size.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

enableAutoScale

public void enableAutoScale(String poolId, String autoScaleFormula, Period autoScaleEvaluationInterval, Iterable additionalBehaviors)

Enables automatic scaling on the specified pool.

Parameters:

poolId - The ID of the pool.
autoScaleFormula - The formula for the desired number of compute nodes in the pool.
autoScaleEvaluationInterval - The time interval at which to automatically adjust the pool size.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

evaluateAutoScale

public AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula)

Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

Parameters:

poolId - The ID of the pool.
autoScaleFormula - The formula to be evaluated on the pool.

Returns:

The result of evaluating the formula on the specified pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

evaluateAutoScale

public AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula, Iterable additionalBehaviors)

Gets the result of evaluating an automatic scaling formula on the specified pool. This is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool.

Parameters:

poolId - The ID of the pool.
autoScaleFormula - The formula to be evaluated on the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Returns:

The result of evaluating the formula on the specified pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

existsPool

public boolean existsPool(String poolId)

Checks whether the specified pool exists.

Parameters:

poolId - The ID of the pool.

Returns:

True if the pool exists; otherwise, false.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

existsPool

public boolean existsPool(String poolId, Iterable additionalBehaviors)

Checks whether the specified pool exists.

Parameters:

poolId - The ID of the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Returns:

True if the pool exists; otherwise, false.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

getAllPoolsLifetimeStatistics

public PoolStatistics getAllPoolsLifetimeStatistics()

Gets lifetime summary statistics for all of the pools in the current account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.

Returns:

The aggregated pool statistics.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

getAllPoolsLifetimeStatistics

public PoolStatistics getAllPoolsLifetimeStatistics(Iterable additionalBehaviors)

Gets lifetime summary statistics for all of the pools in the current account. Statistics are aggregated across all pools that have ever existed in the account, from account creation to the last update time of the statistics.

Parameters:

additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Returns:

The aggregated pool statistics.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

getPool

public CloudPool getPool(String poolId)

Gets the specified CloudPool.

Parameters:

poolId - The ID of the pool to get.

Returns:

A CloudPool containing information about the specified Azure Batch pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

getPool

public CloudPool getPool(String poolId, DetailLevel detailLevel)

Gets the specified CloudPool.

Parameters:

poolId - The ID of the pool to get.
detailLevel - A DetailLevel used for controlling which properties are retrieved from the service.

Returns:

A CloudPool containing information about the specified Azure Batch pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

getPool

public CloudPool getPool(String poolId, DetailLevel detailLevel, Iterable additionalBehaviors)

Gets the specified CloudPool.

Parameters:

poolId - The ID of the pool to get.
detailLevel - A DetailLevel used for controlling which properties are retrieved from the service.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Returns:

A CloudPool containing information about the specified Azure Batch pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

listPools

public PagedList listPools()

Lists the pools in the Batch account.

Returns:

A list of CloudPool objects.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

listPools

public PagedList listPools(DetailLevel detailLevel)

Lists the pools in the Batch account.

Parameters:

detailLevel - A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.

Returns:

A list of CloudPool objects.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

listPools

public PagedList listPools(DetailLevel detailLevel, Iterable additionalBehaviors)

Lists the pools in the Batch account.

Parameters:

detailLevel - A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Returns:

A list of CloudPool objects.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

listPoolUsageMetrics

public PagedList listPoolUsageMetrics(DateTime startTime, DateTime endTime)

Lists pool usage metrics.

Parameters:

startTime - The start time of the aggregation interval covered by this entry.
endTime - The end time of the aggregation interval for this entry.

Returns:

A list of PoolUsageMetrics objects.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

listPoolUsageMetrics

public PagedList listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel)

Lists pool usage metrics.

Parameters:

startTime - The start time of the aggregation interval covered by this entry.
endTime - The end time of the aggregation interval for this entry.
detailLevel - A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.

Returns:

A list of PoolUsageMetrics objects.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

listPoolUsageMetrics

public PagedList listPoolUsageMetrics(DateTime startTime, DateTime endTime, DetailLevel detailLevel, Iterable additionalBehaviors)

Lists pool usage metrics.

Parameters:

startTime - The start time of the aggregation interval covered by this entry.
endTime - The end time of the aggregation interval for this entry.
detailLevel - A DetailLevel used for filtering the list and for controlling which properties are retrieved from the service.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Returns:

A list of PoolUsageMetrics objects.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

patchPool

public void patchPool(String poolId, StartTask startTask, Collection certificateReferences, Collection applicationPackageReferences, Collection metadata)

Updates the specified pool. This method only replaces the properties specified with non-null values.

Parameters:

poolId - The ID of the pool.
startTask - A task to run on each compute node as it joins the pool. If null, any existing start task is left unchanged.
certificateReferences - A collection of certificates to be installed on each compute node in the pool. If null, any existing certificate references are left unchanged.
applicationPackageReferences - A collection of application packages to be installed on each compute node in the pool. If null, any existing application packages references are left unchanged.
metadata - A collection of name-value pairs associated with the pool as metadata. If null, any existing metadata is left unchanged.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

patchPool

public void patchPool(String poolId, StartTask startTask, Collection certificateReferences, Collection applicationPackageReferences, Collection metadata, Iterable additionalBehaviors)

Updates the specified pool. This method only replaces the properties specified with non-null values.

Parameters:

poolId - The ID of the pool.
startTask - A task to run on each compute node as it joins the pool. If null, any existing start task is left unchanged.
certificateReferences - A collection of certificates to be installed on each compute node in the pool. If null, any existing certificate references are left unchanged.
applicationPackageReferences - A collection of application packages to be installed on each compute node in the pool. If null, any existing application packages references are left unchanged.
metadata - A collection of name-value pairs associated with the pool as metadata. If null, any existing metadata is left unchanged.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodeFromPool

public void removeNodeFromPool(String poolId, String computeNodeId)

Removes the specified compute node from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodeId - The ID of the compute node to remove from the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodeFromPool

public void removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption)

Removes the specified compute node from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodeId - The ID of the compute node to remove from the pool.
deallocationOption - Specifies when nodes may be removed from the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodeFromPool

public void removeNodeFromPool(String poolId, String computeNodeId, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable additionalBehaviors)

Removes the specified compute node from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodeId - The ID of the compute node to remove from the pool.
deallocationOption - Specifies when nodes may be removed from the pool.
resizeTimeout - Specifies the timeout for removal of compute nodes from the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodesFromPool

public void removeNodesFromPool(String poolId, Collection computeNodes)

Removes the specified compute nodes from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodes - The compute nodes to remove from the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodesFromPool

public void removeNodesFromPool(String poolId, Collection computeNodes, ComputeNodeDeallocationOption deallocationOption)

Removes the specified compute nodes from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodes - The compute nodes to remove from the pool.
deallocationOption - Specifies when nodes may be removed from the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodesFromPool

public void removeNodesFromPool(String poolId, Collection computeNodes, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable additionalBehaviors)

Removes the specified compute nodes from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodes - The compute nodes to remove from the pool.
deallocationOption - Specifies when nodes may be removed from the pool.
resizeTimeout - Specifies the timeout for removal of compute nodes from the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

removeNodesFromPool

public void removeNodesFromPool(String poolId, List computeNodeIds, ComputeNodeDeallocationOption deallocationOption, Period resizeTimeout, Iterable additionalBehaviors)

Removes the specified compute nodes from the specified pool.

Parameters:

poolId - The ID of the pool.
computeNodeIds - The IDs of the compute nodes to remove from the pool.
deallocationOption - Specifies when nodes may be removed from the pool.
resizeTimeout - Specifies the timeout for removal of compute nodes from the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

resizePool

public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes)

Resizes the specified pool.

Parameters:

poolId - The ID of the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

resizePool

public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout)

Resizes the specified pool.

Parameters:

poolId - The ID of the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.
resizeTimeout - The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. If the pool has not reached the target size after this time, the resize is stopped.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

resizePool

public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption)

Resizes the specified pool.

Parameters:

poolId - The ID of the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.
resizeTimeout - The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. If the pool has not reached the target size after this time, the resize is stopped.
deallocationOption - Specifies when nodes may be removed from the pool, if the pool size is decreasing.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

resizePool

public void resizePool(String poolId, Integer targetDedicatedNodes, Integer targetLowPriorityNodes, Period resizeTimeout, ComputeNodeDeallocationOption deallocationOption, Iterable additionalBehaviors)

Resizes the specified pool.

Parameters:

poolId - The ID of the pool.
targetDedicatedNodes - The desired number of dedicated compute nodes in the pool.
targetLowPriorityNodes - The desired number of low-priority compute nodes in the pool.
resizeTimeout - The timeout for allocation of compute nodes to the pool or removal of compute nodes from the pool. If the pool has not reached the target size after this time, the resize is stopped.
deallocationOption - Specifies when nodes may be removed from the pool, if the pool size is decreasing.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

stopResizePool

public void stopResizePool(String poolId)

Stops a pool resize operation.

Parameters:

poolId - The ID of the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

stopResizePool

public void stopResizePool(String poolId, Iterable additionalBehaviors)

Stops a pool resize operation.

Parameters:

poolId - The ID of the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

updatePoolProperties

public void updatePoolProperties(String poolId, StartTask startTask, Collection certificateReferences, Collection applicationPackageReferences, Collection metadata)

Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task.

Parameters:

poolId - The ID of the pool.
startTask - A task to run on each compute node as it joins the pool. If null, any existing start task is removed from the pool.
certificateReferences - A collection of certificates to be installed on each compute node in the pool. If null, any existing certificate references are removed from the pool.
applicationPackageReferences - A collection of application packages to be installed on each compute node in the pool. If null, any existing application packages references are removed from the pool.
metadata - A collection of name-value pairs associated with the pool as metadata. If null, any existing metadata is removed from the pool.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

updatePoolProperties

public void updatePoolProperties(String poolId, StartTask startTask, Collection certificateReferences, Collection applicationPackageReferences, Collection metadata, Iterable additionalBehaviors)

Updates the specified pool. This method fully replaces all the updatable properties of the pool. For example, if the startTask parameter is null and the pool has a start task associated with it, then the Batch service will remove the existing start task.

Parameters:

poolId - The ID of the pool.
startTask - A task to run on each compute node as it joins the pool. If null, any existing start task is removed from the pool.
certificateReferences - A collection of certificates to be installed on each compute node in the pool. If null, any existing certificate references are removed from the pool.
applicationPackageReferences - A collection of application packages to be installed on each compute node in the pool. If null, any existing application packages references are removed from the pool.
metadata - A collection of name-value pairs associated with the pool as metadata. If null, any existing metadata is removed from the pool.
additionalBehaviors - A collection of BatchClientBehavior instances that are applied to the Batch service request.

Throws:

BatchErrorException - Exception thrown when an error response is received from the Batch service.
IOException - Exception thrown when there is an error in serialization/deserialization of data sent to/received from the Batch service.

withCustomBehaviors

public IInheritedBehaviors withCustomBehaviors(Collection behaviors)

Sets a collection of behaviors that modify or customize requests to the Batch service.

Overrides:

PoolOperations.withCustomBehaviors(Collection<BatchClientBehavior> behaviors)

Parameters:

behaviors - The collection of BatchClientBehavior instances.

Returns:

The current instance.

Applies to