Pools Interface

Reference

Package:: com.microsoft.azure.batch.protocol

public interface Pools

An instance of this class provides access to all the operations defined in Pools.

Method Summary

Modifier and Type	Method and Description
void	add(PoolAddParameter pool) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
void	add(PoolAddParameter pool, PoolAddOptions poolAddOptions) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<Void>	addAsync(PoolAddParameter pool) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
ServiceFuture<Void>	addAsync(PoolAddParameter pool, final ServiceCallback<Void> serviceCallback) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<Void>	addAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
ServiceFuture<Void>	addAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions, final ServiceCallback<Void> serviceCallback) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<ServiceResponseWithHeaders<Void, PoolAddHeaders>>	addWithServiceResponseAsync(PoolAddParameter pool) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
Observable<ServiceResponseWithHeaders<Void, PoolAddHeaders>>	addWithServiceResponseAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions) Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.
void	delete(String poolId) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
void	delete(String poolId, PoolDeleteOptions poolDeleteOptions) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
Observable<Void>	deleteAsync(String poolId) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
ServiceFuture<Void>	deleteAsync(String poolId, final ServiceCallback<Void> serviceCallback) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
Observable<Void>	deleteAsync(String poolId, PoolDeleteOptions poolDeleteOptions) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
ServiceFuture<Void>	deleteAsync(String poolId, PoolDeleteOptions poolDeleteOptions, final ServiceCallback<Void> serviceCallback) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
Observable<ServiceResponseWithHeaders<Void, PoolDeleteHeaders>>	deleteWithServiceResponseAsync(String poolId) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
Observable<ServiceResponseWithHeaders<Void, PoolDeleteHeaders>>	deleteWithServiceResponseAsync(String poolId, PoolDeleteOptions poolDeleteOptions) Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.
void	disableAutoScale(String poolId) Disables automatic scaling for a pool.
void	disableAutoScale(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions) Disables automatic scaling for a pool.
Observable<Void>	disableAutoScaleAsync(String poolId) Disables automatic scaling for a pool.
ServiceFuture<Void>	disableAutoScaleAsync(String poolId, final ServiceCallback<Void> serviceCallback) Disables automatic scaling for a pool.
Observable<Void>	disableAutoScaleAsync(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions) Disables automatic scaling for a pool.
ServiceFuture<Void>	disableAutoScaleAsync(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions, final ServiceCallback<Void> serviceCallback) Disables automatic scaling for a pool.
Observable<ServiceResponseWithHeaders<Void, PoolDisableAutoScaleHeaders>>	disableAutoScaleWithServiceResponseAsync(String poolId) Disables automatic scaling for a pool.
Observable<ServiceResponseWithHeaders<Void, PoolDisableAutoScaleHeaders>>	disableAutoScaleWithServiceResponseAsync(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions) Disables automatic scaling for a pool.
void	enableAutoScale(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
void	enableAutoScale(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
Observable<Void>	enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
ServiceFuture<Void>	enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, final ServiceCallback<Void> serviceCallback) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
Observable<Void>	enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
ServiceFuture<Void>	enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions, final ServiceCallback<Void> serviceCallback) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
Observable<ServiceResponseWithHeaders<Void, PoolEnableAutoScaleHeaders>>	enableAutoScaleWithServiceResponseAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
Observable<ServiceResponseWithHeaders<Void, PoolEnableAutoScaleHeaders>>	enableAutoScaleWithServiceResponseAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions) Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.
AutoScaleRun	evaluateAutoScale(String poolId, String autoScaleFormula) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
AutoScaleRun	evaluateAutoScale(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
Observable<AutoScaleRun>	evaluateAutoScaleAsync(String poolId, String autoScaleFormula) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
ServiceFuture<AutoScaleRun>	evaluateAutoScaleAsync(String poolId, String autoScaleFormula, final ServiceCallback<AutoScaleRun> serviceCallback) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
Observable<AutoScaleRun>	evaluateAutoScaleAsync(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
ServiceFuture<AutoScaleRun>	evaluateAutoScaleAsync(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions, final ServiceCallback<AutoScaleRun> serviceCallback) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
Observable<ServiceResponseWithHeaders<AutoScaleRun, PoolEvaluateAutoScaleHeaders>>	evaluateAutoScaleWithServiceResponseAsync(String poolId, String autoScaleFormula) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
Observable<ServiceResponseWithHeaders<AutoScaleRun, PoolEvaluateAutoScaleHeaders>>	evaluateAutoScaleWithServiceResponseAsync(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions) Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.
boolean	exists(String poolId) Gets basic properties of a pool.
boolean	exists(String poolId, PoolExistsOptions poolExistsOptions) Gets basic properties of a pool.
Observable<Boolean>	existsAsync(String poolId) Gets basic properties of a pool.
ServiceFuture<Boolean>	existsAsync(String poolId, final ServiceCallback<Boolean> serviceCallback) Gets basic properties of a pool.
Observable<Boolean>	existsAsync(String poolId, PoolExistsOptions poolExistsOptions) Gets basic properties of a pool.
ServiceFuture<Boolean>	existsAsync(String poolId, PoolExistsOptions poolExistsOptions, final ServiceCallback<Boolean> serviceCallback) Gets basic properties of a pool.
Observable<ServiceResponseWithHeaders<Boolean, PoolExistsHeaders>>	existsWithServiceResponseAsync(String poolId) Gets basic properties of a pool.
Observable<ServiceResponseWithHeaders<Boolean, PoolExistsHeaders>>	existsWithServiceResponseAsync(String poolId, PoolExistsOptions poolExistsOptions) Gets basic properties of a pool.
CloudPool	get(String poolId) Gets information about the specified pool.
CloudPool	get(String poolId, PoolGetOptions poolGetOptions) Gets information about the specified pool.
PoolStatistics	getAllLifetimeStatistics() Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
PoolStatistics	getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions) Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<PoolStatistics>	getAllLifetimeStatisticsAsync() Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
ServiceFuture<PoolStatistics>	getAllLifetimeStatisticsAsync(final ServiceCallback<PoolStatistics> serviceCallback) Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<PoolStatistics>	getAllLifetimeStatisticsAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions) Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
ServiceFuture<PoolStatistics>	getAllLifetimeStatisticsAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions, final ServiceCallback<PoolStatistics> serviceCallback) Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<ServiceResponseWithHeaders<PoolStatistics, PoolGetAllLifetimeStatisticsHeaders>>	getAllLifetimeStatisticsWithServiceResponseAsync() Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<ServiceResponseWithHeaders<PoolStatistics, PoolGetAllLifetimeStatisticsHeaders>>	getAllLifetimeStatisticsWithServiceResponseAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions) Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.
Observable<CloudPool>	getAsync(String poolId) Gets information about the specified pool.
ServiceFuture<CloudPool>	getAsync(String poolId, final ServiceCallback<CloudPool> serviceCallback) Gets information about the specified pool.
Observable<CloudPool>	getAsync(String poolId, PoolGetOptions poolGetOptions) Gets information about the specified pool.
ServiceFuture<CloudPool>	getAsync(String poolId, PoolGetOptions poolGetOptions, final ServiceCallback<CloudPool> serviceCallback) Gets information about the specified pool.
Observable<ServiceResponseWithHeaders<CloudPool, PoolGetHeaders>>	getWithServiceResponseAsync(String poolId) Gets information about the specified pool.
Observable<ServiceResponseWithHeaders<CloudPool, PoolGetHeaders>>	getWithServiceResponseAsync(String poolId, PoolGetOptions poolGetOptions) Gets information about the specified pool.
PagedList<CloudPool>	list() Lists all of the pools in the specified account.
PagedList<CloudPool>	list(final PoolListOptions poolListOptions) Lists all of the pools in the specified account.
Observable<Page<CloudPool>>	listAsync() Lists all of the pools in the specified account.
ServiceFuture<List<CloudPool>>	listAsync(final ListOperationCallback<CloudPool> serviceCallback) Lists all of the pools in the specified account.
Observable<Page<CloudPool>>	listAsync(final PoolListOptions poolListOptions) Lists all of the pools in the specified account.
ServiceFuture<List<CloudPool>>	listAsync(final PoolListOptions poolListOptions, final ListOperationCallback<CloudPool> serviceCallback) Lists all of the pools in the specified account.
PagedList<CloudPool>	listNext(final String nextPageLink) Lists all of the pools in the specified account.
PagedList<CloudPool>	listNext(final String nextPageLink, final PoolListNextOptions poolListNextOptions) Lists all of the pools in the specified account.
Observable<Page<CloudPool>>	listNextAsync(final String nextPageLink) Lists all of the pools in the specified account.
Observable<Page<CloudPool>>	listNextAsync(final String nextPageLink, final PoolListNextOptions poolListNextOptions) Lists all of the pools in the specified account.
ServiceFuture<List<CloudPool>>	listNextAsync(final String nextPageLink, final PoolListNextOptions poolListNextOptions, final ServiceFuture<List<CloudPool>> serviceFuture, final ListOperationCallback<CloudPool> serviceCallback) Lists all of the pools in the specified account.
ServiceFuture<List<CloudPool>>	listNextAsync(final String nextPageLink, final ServiceFuture<List<CloudPool>> serviceFuture, final ListOperationCallback<CloudPool> serviceCallback) Lists all of the pools in the specified account.
Observable<ServiceResponseWithHeaders<Page<CloudPool>, PoolListHeaders>>	listNextWithServiceResponseAsync(final String nextPageLink) Lists all of the pools in the specified account.
Observable<ServiceResponseWithHeaders<Page<CloudPool>, PoolListHeaders>>	listNextWithServiceResponseAsync(final String nextPageLink, final PoolListNextOptions poolListNextOptions) Lists all of the pools in the specified account.
PagedList<PoolUsageMetrics>	listUsageMetrics() Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
PagedList<PoolUsageMetrics>	listUsageMetrics(final PoolListUsageMetricsOptions poolListUsageMetricsOptions) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<Page<PoolUsageMetrics>>	listUsageMetricsAsync() Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
ServiceFuture<List<PoolUsageMetrics>>	listUsageMetricsAsync(final ListOperationCallback<PoolUsageMetrics> serviceCallback) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<Page<PoolUsageMetrics>>	listUsageMetricsAsync(final PoolListUsageMetricsOptions poolListUsageMetricsOptions) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
ServiceFuture<List<PoolUsageMetrics>>	listUsageMetricsAsync(final PoolListUsageMetricsOptions poolListUsageMetricsOptions, final ListOperationCallback<PoolUsageMetrics> serviceCallback) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
PagedList<PoolUsageMetrics>	listUsageMetricsNext(final String nextPageLink) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
PagedList<PoolUsageMetrics>	listUsageMetricsNext(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<Page<PoolUsageMetrics>>	listUsageMetricsNextAsync(final String nextPageLink) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<Page<PoolUsageMetrics>>	listUsageMetricsNextAsync(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
ServiceFuture<List<PoolUsageMetrics>>	listUsageMetricsNextAsync(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions, final ServiceFuture<List<PoolUsageMetrics>> serviceFuture, final ListOperationCallback<PoolUsageMetrics> serviceCallback) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
ServiceFuture<List<PoolUsageMetrics>>	listUsageMetricsNextAsync(final String nextPageLink, final ServiceFuture<List<PoolUsageMetrics>> serviceFuture, final ListOperationCallback<PoolUsageMetrics> serviceCallback) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<ServiceResponseWithHeaders<Page<PoolUsageMetrics>, PoolListUsageMetricsHeaders>>	listUsageMetricsNextWithServiceResponseAsync(final String nextPageLink) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<ServiceResponseWithHeaders<Page<PoolUsageMetrics>, PoolListUsageMetricsHeaders>>	listUsageMetricsNextWithServiceResponseAsync(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<ServiceResponseWithHeaders<Page<PoolUsageMetrics>, PoolListUsageMetricsHeaders>>	listUsageMetricsWithServiceResponseAsync() Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<ServiceResponseWithHeaders<Page<PoolUsageMetrics>, PoolListUsageMetricsHeaders>>	listUsageMetricsWithServiceResponseAsync(final PoolListUsageMetricsOptions poolListUsageMetricsOptions) Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.
Observable<ServiceResponseWithHeaders<Page<CloudPool>, PoolListHeaders>>	listWithServiceResponseAsync() Lists all of the pools in the specified account.
Observable<ServiceResponseWithHeaders<Page<CloudPool>, PoolListHeaders>>	listWithServiceResponseAsync(final PoolListOptions poolListOptions) Lists all of the pools in the specified account.
void	patch(String poolId, PoolPatchParameter poolPatchParameter) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
void	patch(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
Observable<Void>	patchAsync(String poolId, PoolPatchParameter poolPatchParameter) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
ServiceFuture<Void>	patchAsync(String poolId, PoolPatchParameter poolPatchParameter, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
Observable<Void>	patchAsync(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
ServiceFuture<Void>	patchAsync(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
Observable<ServiceResponseWithHeaders<Void, PoolPatchHeaders>>	patchWithServiceResponseAsync(String poolId, PoolPatchParameter poolPatchParameter) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
Observable<ServiceResponseWithHeaders<Void, PoolPatchHeaders>>	patchWithServiceResponseAsync(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions) Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.
void	removeNodes(String poolId, NodeRemoveParameter nodeRemoveParameter) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
void	removeNodes(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
Observable<Void>	removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
ServiceFuture<Void>	removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, final ServiceCallback<Void> serviceCallback) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
Observable<Void>	removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
ServiceFuture<Void>	removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions, final ServiceCallback<Void> serviceCallback) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
Observable<ServiceResponseWithHeaders<Void, PoolRemoveNodesHeaders>>	removeNodesWithServiceResponseAsync(String poolId, NodeRemoveParameter nodeRemoveParameter) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
Observable<ServiceResponseWithHeaders<Void, PoolRemoveNodesHeaders>>	removeNodesWithServiceResponseAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions) Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.
void	resize(String poolId, PoolResizeParameter poolResizeParameter) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
void	resize(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
Observable<Void>	resizeAsync(String poolId, PoolResizeParameter poolResizeParameter) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
ServiceFuture<Void>	resizeAsync(String poolId, PoolResizeParameter poolResizeParameter, final ServiceCallback<Void> serviceCallback) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
Observable<Void>	resizeAsync(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
ServiceFuture<Void>	resizeAsync(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions, final ServiceCallback<Void> serviceCallback) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
Observable<ServiceResponseWithHeaders<Void, PoolResizeHeaders>>	resizeWithServiceResponseAsync(String poolId, PoolResizeParameter poolResizeParameter) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
Observable<ServiceResponseWithHeaders<Void, PoolResizeHeaders>>	resizeWithServiceResponseAsync(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions) Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.
void	stopResize(String poolId) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
void	stopResize(String poolId, PoolStopResizeOptions poolStopResizeOptions) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
Observable<Void>	stopResizeAsync(String poolId) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
ServiceFuture<Void>	stopResizeAsync(String poolId, final ServiceCallback<Void> serviceCallback) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
Observable<Void>	stopResizeAsync(String poolId, PoolStopResizeOptions poolStopResizeOptions) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
ServiceFuture<Void>	stopResizeAsync(String poolId, PoolStopResizeOptions poolStopResizeOptions, final ServiceCallback<Void> serviceCallback) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
Observable<ServiceResponseWithHeaders<Void, PoolStopResizeHeaders>>	stopResizeWithServiceResponseAsync(String poolId) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
Observable<ServiceResponseWithHeaders<Void, PoolStopResizeHeaders>>	stopResizeWithServiceResponseAsync(String poolId, PoolStopResizeOptions poolStopResizeOptions) Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.
void	updateProperties(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
void	updateProperties(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
Observable<Void>	updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
ServiceFuture<Void>	updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
Observable<Void>	updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
ServiceFuture<Void>	updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions, final ServiceCallback<Void> serviceCallback) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
Observable<ServiceResponseWithHeaders<Void, PoolUpdatePropertiesHeaders>>	updatePropertiesWithServiceResponseAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.
Observable<ServiceResponseWithHeaders<Void, PoolUpdatePropertiesHeaders>>	updatePropertiesWithServiceResponseAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions) Updates the properties of the specified pool. This fully replaces all the updatable properties of the pool. For example, if the pool has a start task associated with it and if start task is not specified with this request, then the Batch service will remove the existing start task.

Method Details

add

public void add(PoolAddParameter pool)

Adds a pool to the specified account. When naming pools, avoid including sensitive information such as user names or secret project names. This information may appear in telemetry logs accessible to Microsoft Support engineers.

Parameters:

pool - The pool to be added.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

add

public void add(PoolAddParameter pool, PoolAddOptions poolAddOptions)

Parameters:

pool - The pool to be added.

poolAddOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

addAsync

public Observable addAsync(PoolAddParameter pool)

Parameters:

pool - The pool to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public ServiceFuture addAsync(PoolAddParameter pool, final ServiceCallback serviceCallback)

Parameters:

pool - The pool to be added.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public Observable addAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions)

Parameters:

pool - The pool to be added.

poolAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addAsync

public ServiceFuture addAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions, final ServiceCallback serviceCallback)

Parameters:

pool - The pool to be added.

poolAddOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addWithServiceResponseAsync

public Observable> addWithServiceResponseAsync(PoolAddParameter pool)

Parameters:

pool - The pool to be added.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

addWithServiceResponseAsync

public Observable> addWithServiceResponseAsync(PoolAddParameter pool, PoolAddOptions poolAddOptions)

Parameters:

pool - The pool to be added.

poolAddOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

delete

public void delete(String poolId)

Deletes a pool from the specified account. When you request that a pool be deleted, the following actions occur: the pool state is set to deleting; any ongoing resize operation on the pool are stopped; the Batch service starts resizing the pool to zero nodes; any tasks running on existing nodes are terminated and requeued (as if a resize pool operation had been requested with the default requeue option); finally, the pool is removed from the system. Because running tasks are requeued, the user can rerun these tasks by updating their job to target a different pool. The tasks can then run on the new pool. If you want to override the requeue behavior, then you should call resize pool explicitly to shrink the pool to zero size before deleting the pool. If you call an Update, Patch or Delete API on a pool in the deleting state, it will fail with HTTP status code 409 with error code PoolBeingDeleted.

Parameters:

poolId - The ID of the pool to delete.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

delete

public void delete(String poolId, PoolDeleteOptions poolDeleteOptions)

Parameters:

poolId - The ID of the pool to delete.

poolDeleteOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

deleteAsync

public Observable deleteAsync(String poolId)

Parameters:

poolId - The ID of the pool to delete.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String poolId, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to delete.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public Observable deleteAsync(String poolId, PoolDeleteOptions poolDeleteOptions)

Parameters:

poolId - The ID of the pool to delete.

poolDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteAsync

public ServiceFuture deleteAsync(String poolId, PoolDeleteOptions poolDeleteOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to delete.

poolDeleteOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable> deleteWithServiceResponseAsync(String poolId)

Parameters:

poolId - The ID of the pool to delete.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

deleteWithServiceResponseAsync

public Observable> deleteWithServiceResponseAsync(String poolId, PoolDeleteOptions poolDeleteOptions)

Parameters:

poolId - The ID of the pool to delete.

poolDeleteOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAutoScale

public void disableAutoScale(String poolId)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

disableAutoScale

public void disableAutoScale(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

poolDisableAutoScaleOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

disableAutoScaleAsync

public Observable disableAutoScaleAsync(String poolId)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAutoScaleAsync

public ServiceFuture disableAutoScaleAsync(String poolId, final ServiceCallback serviceCallback)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAutoScaleAsync

public Observable disableAutoScaleAsync(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

poolDisableAutoScaleOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAutoScaleAsync

public ServiceFuture disableAutoScaleAsync(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions, final ServiceCallback serviceCallback)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

poolDisableAutoScaleOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAutoScaleWithServiceResponseAsync

public Observable> disableAutoScaleWithServiceResponseAsync(String poolId)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

disableAutoScaleWithServiceResponseAsync

public Observable> disableAutoScaleWithServiceResponseAsync(String poolId, PoolDisableAutoScaleOptions poolDisableAutoScaleOptions)

Disables automatic scaling for a pool.

Parameters:

poolId - The ID of the pool on which to disable automatic scaling.

poolDisableAutoScaleOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAutoScale

public void enableAutoScale(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter)

Enables automatic scaling for a pool. You cannot enable automatic scaling on a pool if a resize operation is in progress on the pool. If automatic scaling of the pool is currently disabled, you must specify a valid autoscale formula as part of the request. If automatic scaling of the pool is already enabled, you may specify a new autoscale formula and/or a new evaluation interval. You cannot call this API for the same pool more than once every 30 seconds.

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

enableAutoScale

public void enableAutoScale(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

poolEnableAutoScaleOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

enableAutoScaleAsync

public Observable enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAutoScaleAsync

public ServiceFuture enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAutoScaleAsync

public Observable enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

poolEnableAutoScaleOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAutoScaleAsync

public ServiceFuture enableAutoScaleAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

poolEnableAutoScaleOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAutoScaleWithServiceResponseAsync

public Observable> enableAutoScaleWithServiceResponseAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

enableAutoScaleWithServiceResponseAsync

public Observable> enableAutoScaleWithServiceResponseAsync(String poolId, PoolEnableAutoScaleParameter poolEnableAutoScaleParameter, PoolEnableAutoScaleOptions poolEnableAutoScaleOptions)

Parameters:

poolId - The ID of the pool on which to enable automatic scaling.

poolEnableAutoScaleParameter - The parameters for the request.

poolEnableAutoScaleOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateAutoScale

public AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula)

Gets the result of evaluating an automatic scaling formula on the pool. This API is primarily for validating an autoscale formula, as it simply returns the result without applying the formula to the pool. The pool must have auto scaling enabled in order to evaluate a formula.

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

autoScaleFormula - The formula for the desired number of compute nodes in the pool. The formula is validated and its results calculated, but it is not applied to the pool. To apply the formula to the pool, 'Enable automatic scaling on a pool'. For more information about specifying this formula, see Automatically scale compute nodes in an Azure Batch pool (https://azure.microsoft.com/en-us/documentation/articles/batch-automatic-scaling).

Returns:

the AutoScaleRun object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

evaluateAutoScale

public AutoScaleRun evaluateAutoScale(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

poolEvaluateAutoScaleOptions - Additional parameters for the operation

Returns:

the AutoScaleRun object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

evaluateAutoScaleAsync

public Observable evaluateAutoScaleAsync(String poolId, String autoScaleFormula)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

Returns:

the observable to the AutoScaleRun object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateAutoScaleAsync

public ServiceFuture evaluateAutoScaleAsync(String poolId, String autoScaleFormula, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateAutoScaleAsync

public Observable evaluateAutoScaleAsync(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

poolEvaluateAutoScaleOptions - Additional parameters for the operation

Returns:

the observable to the AutoScaleRun object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateAutoScaleAsync

public ServiceFuture evaluateAutoScaleAsync(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

poolEvaluateAutoScaleOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateAutoScaleWithServiceResponseAsync

public Observable> evaluateAutoScaleWithServiceResponseAsync(String poolId, String autoScaleFormula)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

Returns:

the observable to the AutoScaleRun object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

evaluateAutoScaleWithServiceResponseAsync

public Observable> evaluateAutoScaleWithServiceResponseAsync(String poolId, String autoScaleFormula, PoolEvaluateAutoScaleOptions poolEvaluateAutoScaleOptions)

Parameters:

poolId - The ID of the pool on which to evaluate the automatic scaling formula.

poolEvaluateAutoScaleOptions - Additional parameters for the operation

Returns:

the observable to the AutoScaleRun object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

exists

public boolean exists(String poolId)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

Returns:

the boolean object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

exists

public boolean exists(String poolId, PoolExistsOptions poolExistsOptions)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

poolExistsOptions - Additional parameters for the operation

Returns:

the boolean object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

existsAsync

public Observable existsAsync(String poolId)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

Returns:

the observable to the boolean object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

existsAsync

public ServiceFuture existsAsync(String poolId, final ServiceCallback serviceCallback)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

existsAsync

public Observable existsAsync(String poolId, PoolExistsOptions poolExistsOptions)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

poolExistsOptions - Additional parameters for the operation

Returns:

the observable to the boolean object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

existsAsync

public ServiceFuture existsAsync(String poolId, PoolExistsOptions poolExistsOptions, final ServiceCallback serviceCallback)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

poolExistsOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

existsWithServiceResponseAsync

public Observable> existsWithServiceResponseAsync(String poolId)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

Returns:

the observable to the boolean object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

existsWithServiceResponseAsync

public Observable> existsWithServiceResponseAsync(String poolId, PoolExistsOptions poolExistsOptions)

Gets basic properties of a pool.

Parameters:

poolId - The ID of the pool to get.

poolExistsOptions - Additional parameters for the operation

Returns:

the observable to the boolean object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

get

public CloudPool get(String poolId)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

Returns:

the CloudPool object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

get

public CloudPool get(String poolId, PoolGetOptions poolGetOptions)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

poolGetOptions - Additional parameters for the operation

Returns:

the CloudPool object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllLifetimeStatistics

public PoolStatistics getAllLifetimeStatistics()

Gets lifetime summary statistics for all of the pools in the specified 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. The statistics may not be immediately available. The Batch service performs periodic roll-up of statistics. The typical delay is about 30 minutes.

Returns:

the PoolStatistics object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllLifetimeStatistics

public PoolStatistics getAllLifetimeStatistics(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions)

Parameters:

poolGetAllLifetimeStatisticsOptions - Additional parameters for the operation

Returns:

the PoolStatistics object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

getAllLifetimeStatisticsAsync

public Observable getAllLifetimeStatisticsAsync()

Returns:

the observable to the PoolStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsAsync

public ServiceFuture getAllLifetimeStatisticsAsync(final ServiceCallback serviceCallback)

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsAsync

public Observable getAllLifetimeStatisticsAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions)

Parameters:

poolGetAllLifetimeStatisticsOptions - Additional parameters for the operation

Returns:

the observable to the PoolStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsAsync

public ServiceFuture getAllLifetimeStatisticsAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions, final ServiceCallback serviceCallback)

Parameters:

poolGetAllLifetimeStatisticsOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsWithServiceResponseAsync

public Observable> getAllLifetimeStatisticsWithServiceResponseAsync()

Returns:

the observable to the PoolStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAllLifetimeStatisticsWithServiceResponseAsync

public Observable> getAllLifetimeStatisticsWithServiceResponseAsync(PoolGetAllLifetimeStatisticsOptions poolGetAllLifetimeStatisticsOptions)

Parameters:

poolGetAllLifetimeStatisticsOptions - Additional parameters for the operation

Returns:

the observable to the PoolStatistics object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String poolId)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

Returns:

the observable to the CloudPool object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String poolId, final ServiceCallback serviceCallback)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public Observable getAsync(String poolId, PoolGetOptions poolGetOptions)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

poolGetOptions - Additional parameters for the operation

Returns:

the observable to the CloudPool object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getAsync

public ServiceFuture getAsync(String poolId, PoolGetOptions poolGetOptions, final ServiceCallback serviceCallback)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

poolGetOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String poolId)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

Returns:

the observable to the CloudPool object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

getWithServiceResponseAsync

public Observable> getWithServiceResponseAsync(String poolId, PoolGetOptions poolGetOptions)

Gets information about the specified pool.

Parameters:

poolId - The ID of the pool to get.

poolGetOptions - Additional parameters for the operation

Returns:

the observable to the CloudPool object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

list

public PagedList list()

Lists all of the pools in the specified account.

Returns:

the PagedList<CloudPool> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

list

public PagedList list(final PoolListOptions poolListOptions)

Lists all of the pools in the specified account.

Parameters:

poolListOptions - Additional parameters for the operation

Returns:

the PagedList<CloudPool> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listAsync

public Observable> listAsync()

Lists all of the pools in the specified account.

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(final ListOperationCallback serviceCallback)

Lists all of the pools in the specified account.

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public Observable> listAsync(final PoolListOptions poolListOptions)

Lists all of the pools in the specified account.

Parameters:

poolListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listAsync

public ServiceFuture> listAsync(final PoolListOptions poolListOptions, final ListOperationCallback serviceCallback)

Lists all of the pools in the specified account.

Parameters:

poolListOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNext

public PagedList listNext(final String nextPageLink)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<CloudPool> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNext

public PagedList listNext(final String nextPageLink, final PoolListNextOptions poolListNextOptions)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListNextOptions - Additional parameters for the operation

Returns:

the PagedList<CloudPool> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listNextAsync

public Observable> listNextAsync(final String nextPageLink)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public Observable> listNextAsync(final String nextPageLink, final PoolListNextOptions poolListNextOptions)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture> listNextAsync(final String nextPageLink, final PoolListNextOptions poolListNextOptions, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListNextOptions - Additional parameters for the operation

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextAsync

public ServiceFuture> listNextAsync(final String nextPageLink, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable, PoolListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listNextWithServiceResponseAsync

public Observable, PoolListHeaders>> listNextWithServiceResponseAsync(final String nextPageLink, final PoolListNextOptions poolListNextOptions)

Lists all of the pools in the specified account.

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetrics

public PagedList listUsageMetrics()

Lists the usage metrics, aggregated by pool across individual time intervals, for the specified account. If you do not specify a $filter clause including a poolId, the response includes all pools that existed in the account in the time range of the returned aggregation intervals. If you do not specify a $filter clause including a startTime or endTime these filters default to the start and end times of the last aggregation interval currently available; that is, only the last aggregation interval is returned.

Returns:

the PagedList<PoolUsageMetrics> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listUsageMetrics

public PagedList listUsageMetrics(final PoolListUsageMetricsOptions poolListUsageMetricsOptions)

Parameters:

poolListUsageMetricsOptions - Additional parameters for the operation

Returns:

the PagedList<PoolUsageMetrics> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listUsageMetricsAsync

public Observable> listUsageMetricsAsync()

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsAsync

public ServiceFuture> listUsageMetricsAsync(final ListOperationCallback serviceCallback)

Parameters:

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsAsync

public Observable> listUsageMetricsAsync(final PoolListUsageMetricsOptions poolListUsageMetricsOptions)

Parameters:

poolListUsageMetricsOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsAsync

public ServiceFuture> listUsageMetricsAsync(final PoolListUsageMetricsOptions poolListUsageMetricsOptions, final ListOperationCallback serviceCallback)

Parameters:

poolListUsageMetricsOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsNext

public PagedList listUsageMetricsNext(final String nextPageLink)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the PagedList<PoolUsageMetrics> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listUsageMetricsNext

public PagedList listUsageMetricsNext(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListUsageMetricsNextOptions - Additional parameters for the operation

Returns:

the PagedList<PoolUsageMetrics> object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

listUsageMetricsNextAsync

public Observable> listUsageMetricsNextAsync(final String nextPageLink)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsNextAsync

public Observable> listUsageMetricsNextAsync(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListUsageMetricsNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsNextAsync

public ServiceFuture> listUsageMetricsNextAsync(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListUsageMetricsNextOptions - Additional parameters for the operation

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsNextAsync

public ServiceFuture> listUsageMetricsNextAsync(final String nextPageLink, final ServiceFuture> serviceFuture, final ListOperationCallback serviceCallback)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

serviceFuture - the ServiceFuture object tracking the Retrofit calls

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsNextWithServiceResponseAsync

public Observable, PoolListUsageMetricsHeaders>> listUsageMetricsNextWithServiceResponseAsync(final String nextPageLink)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsNextWithServiceResponseAsync

public Observable, PoolListUsageMetricsHeaders>> listUsageMetricsNextWithServiceResponseAsync(final String nextPageLink, final PoolListUsageMetricsNextOptions poolListUsageMetricsNextOptions)

Parameters:

nextPageLink - The NextLink from the previous successful call to List operation.

poolListUsageMetricsNextOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsWithServiceResponseAsync

public Observable, PoolListUsageMetricsHeaders>> listUsageMetricsWithServiceResponseAsync()

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listUsageMetricsWithServiceResponseAsync

public Observable, PoolListUsageMetricsHeaders>> listUsageMetricsWithServiceResponseAsync(final PoolListUsageMetricsOptions poolListUsageMetricsOptions)

Parameters:

poolListUsageMetricsOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<PoolUsageMetrics> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable, PoolListHeaders>> listWithServiceResponseAsync()

Lists all of the pools in the specified account.

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

listWithServiceResponseAsync

public Observable, PoolListHeaders>> listWithServiceResponseAsync(final PoolListOptions poolListOptions)

Lists all of the pools in the specified account.

Parameters:

poolListOptions - Additional parameters for the operation

Returns:

the observable to the PagedList<CloudPool> object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patch

public void patch(String poolId, PoolPatchParameter poolPatchParameter)

Updates the properties of the specified pool. This only replaces the pool properties specified in the request. For example, if the pool has a start task associated with it, and a request does not specify a start task element, then the pool keeps the existing start task.

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

patch

public void patch(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

poolPatchOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

patchAsync

public Observable patchAsync(String poolId, PoolPatchParameter poolPatchParameter)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchAsync

public ServiceFuture patchAsync(String poolId, PoolPatchParameter poolPatchParameter, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchAsync

public Observable patchAsync(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

poolPatchOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchAsync

public ServiceFuture patchAsync(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

poolPatchOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchWithServiceResponseAsync

public Observable> patchWithServiceResponseAsync(String poolId, PoolPatchParameter poolPatchParameter)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

patchWithServiceResponseAsync

public Observable> patchWithServiceResponseAsync(String poolId, PoolPatchParameter poolPatchParameter, PoolPatchOptions poolPatchOptions)

Parameters:

poolId - The ID of the pool to update.

poolPatchParameter - The parameters for the request.

poolPatchOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

removeNodes

public void removeNodes(String poolId, NodeRemoveParameter nodeRemoveParameter)

Removes compute nodes from the specified pool. This operation can only run when the allocation state of the pool is steady. When this operation runs, the allocation state changes from steady to resizing.

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

removeNodes

public void removeNodes(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

poolRemoveNodesOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

removeNodesAsync

public Observable removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

removeNodesAsync

public ServiceFuture removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

removeNodesAsync

public Observable removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

poolRemoveNodesOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

removeNodesAsync

public ServiceFuture removeNodesAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

poolRemoveNodesOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

removeNodesWithServiceResponseAsync

public Observable> removeNodesWithServiceResponseAsync(String poolId, NodeRemoveParameter nodeRemoveParameter)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

removeNodesWithServiceResponseAsync

public Observable> removeNodesWithServiceResponseAsync(String poolId, NodeRemoveParameter nodeRemoveParameter, PoolRemoveNodesOptions poolRemoveNodesOptions)

Parameters:

poolId - The ID of the pool from which you want to remove nodes.

nodeRemoveParameter - The parameters for the request.

poolRemoveNodesOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

resize

public void resize(String poolId, PoolResizeParameter poolResizeParameter)

Changes the number of compute nodes that are assigned to a pool. You can only resize a pool when its allocation state is steady. If the pool is already resizing, the request fails with status code 409. When you resize a pool, the pool's allocation state changes from steady to resizing. You cannot resize pools which are configured for automatic scaling. If you try to do this, the Batch service returns an error 409. If you resize a pool downwards, the Batch service chooses which nodes to remove. To remove specific nodes, use the pool remove nodes API instead.

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

resize

public void resize(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

poolResizeOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

resizeAsync

public Observable resizeAsync(String poolId, PoolResizeParameter poolResizeParameter)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

resizeAsync

public ServiceFuture resizeAsync(String poolId, PoolResizeParameter poolResizeParameter, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

resizeAsync

public Observable resizeAsync(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

poolResizeOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

resizeAsync

public ServiceFuture resizeAsync(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

poolResizeOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

resizeWithServiceResponseAsync

public Observable> resizeWithServiceResponseAsync(String poolId, PoolResizeParameter poolResizeParameter)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

resizeWithServiceResponseAsync

public Observable> resizeWithServiceResponseAsync(String poolId, PoolResizeParameter poolResizeParameter, PoolResizeOptions poolResizeOptions)

Parameters:

poolId - The ID of the pool to resize.

poolResizeParameter - The parameters for the request.

poolResizeOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

stopResize

public void stopResize(String poolId)

Stops an ongoing resize operation on the pool. This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created.

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

stopResize

public void stopResize(String poolId, PoolStopResizeOptions poolStopResizeOptions)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

poolStopResizeOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

stopResizeAsync

public Observable stopResizeAsync(String poolId)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

stopResizeAsync

public ServiceFuture stopResizeAsync(String poolId, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

stopResizeAsync

public Observable stopResizeAsync(String poolId, PoolStopResizeOptions poolStopResizeOptions)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

poolStopResizeOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

stopResizeAsync

public ServiceFuture stopResizeAsync(String poolId, PoolStopResizeOptions poolStopResizeOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

poolStopResizeOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

stopResizeWithServiceResponseAsync

public Observable> stopResizeWithServiceResponseAsync(String poolId)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

stopResizeWithServiceResponseAsync

public Observable> stopResizeWithServiceResponseAsync(String poolId, PoolStopResizeOptions poolStopResizeOptions)

Parameters:

poolId - The ID of the pool whose resizing you want to stop.

poolStopResizeOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updateProperties

public void updateProperties(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter)

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

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updateProperties

public void updateProperties(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

poolUpdatePropertiesOptions - Additional parameters for the operation

Throws:

IllegalArgumentException - thrown if parameters fail the validation

BatchErrorException - thrown if the request is rejected by server

RuntimeException - all other wrapped checked exceptions if the request fails to be sent

updatePropertiesAsync

public Observable updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePropertiesAsync

public ServiceFuture updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePropertiesAsync

public Observable updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

poolUpdatePropertiesOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePropertiesAsync

public ServiceFuture updatePropertiesAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions, final ServiceCallback serviceCallback)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

poolUpdatePropertiesOptions - Additional parameters for the operation

serviceCallback - the async ServiceCallback to handle successful and failed responses.

Returns:

the ServiceFuture object

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePropertiesWithServiceResponseAsync

public Observable> updatePropertiesWithServiceResponseAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

updatePropertiesWithServiceResponseAsync

public Observable> updatePropertiesWithServiceResponseAsync(String poolId, PoolUpdatePropertiesParameter poolUpdatePropertiesParameter, PoolUpdatePropertiesOptions poolUpdatePropertiesOptions)

Parameters:

poolId - The ID of the pool to update.

poolUpdatePropertiesParameter - The parameters for the request.

poolUpdatePropertiesOptions - Additional parameters for the operation

Returns:

the ServiceResponseWithHeaders object if successful.

Throws:

IllegalArgumentException - thrown if parameters fail the validation

Share via

Pools Interface

Method Summary

Method Details

add

add

addAsync

addAsync

addAsync

addAsync

addWithServiceResponseAsync

addWithServiceResponseAsync

delete

delete

deleteAsync

deleteAsync

deleteAsync

deleteAsync

deleteWithServiceResponseAsync

deleteWithServiceResponseAsync

disableAutoScale

disableAutoScale

disableAutoScaleAsync

disableAutoScaleAsync

disableAutoScaleAsync

disableAutoScaleAsync

disableAutoScaleWithServiceResponseAsync

disableAutoScaleWithServiceResponseAsync

enableAutoScale

enableAutoScale

enableAutoScaleAsync

enableAutoScaleAsync

enableAutoScaleAsync

enableAutoScaleAsync

enableAutoScaleWithServiceResponseAsync

enableAutoScaleWithServiceResponseAsync

evaluateAutoScale

evaluateAutoScale

evaluateAutoScaleAsync

evaluateAutoScaleAsync

evaluateAutoScaleAsync

evaluateAutoScaleAsync

evaluateAutoScaleWithServiceResponseAsync

evaluateAutoScaleWithServiceResponseAsync

exists

exists

existsAsync

existsAsync

existsAsync

existsAsync

existsWithServiceResponseAsync

existsWithServiceResponseAsync

get

get

getAllLifetimeStatistics

getAllLifetimeStatistics

getAllLifetimeStatisticsAsync

getAllLifetimeStatisticsAsync

getAllLifetimeStatisticsAsync

getAllLifetimeStatisticsAsync

getAllLifetimeStatisticsWithServiceResponseAsync

getAllLifetimeStatisticsWithServiceResponseAsync

getAsync

getAsync

getAsync

getAsync

getWithServiceResponseAsync

getWithServiceResponseAsync

list

list

listAsync

listAsync

listAsync

listAsync

listNext

listNext

listNextAsync

listNextAsync

listNextAsync

listNextAsync