Interface AutoScalingAsyncWaiter
-
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen") @ThreadSafe @Immutable public interface AutoScalingAsyncWaiter extends SdkAutoCloseable
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the resource will never enter into the desired state. This can be created using the staticbuilder()
method
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
AutoScalingAsyncWaiter.Builder
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
-
-
-
Method Detail
-
waitUntilGroupExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupExists(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAutoScalingGroupsRequest
- the request to be used for polling- Returns:
- CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.
-
waitUntilGroupExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupExists(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder without the need to create one manually using
DescribeAutoScalingGroupsRequest.builder()
- Parameters:
describeAutoScalingGroupsRequest
- The consumer that will configure the request to be used for polling- Returns:
- CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupExists(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest, WaiterOverrideConfiguration overrideConfig)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAutoScalingGroupsRequest
- The request to be used for pollingoverrideConfig
- Per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupExists(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder and instance of the override config builder
- Parameters:
describeAutoScalingGroupsRequest
- The consumer that will configure the request to be used for pollingoverrideConfig
- The consumer that will configure the per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupInService
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupInService(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupInService
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAutoScalingGroupsRequest
- the request to be used for polling- Returns:
- CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.
-
waitUntilGroupInService
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupInService(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupInService
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder without the need to create one manually using
DescribeAutoScalingGroupsRequest.builder()
- Parameters:
describeAutoScalingGroupsRequest
- The consumer that will configure the request to be used for polling- Returns:
- CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupInService
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupInService(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest, WaiterOverrideConfiguration overrideConfig)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupInService
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAutoScalingGroupsRequest
- The request to be used for pollingoverrideConfig
- Per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupInService
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupInService(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupInService
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder and instance of the override config builder
- Parameters:
describeAutoScalingGroupsRequest
- The consumer that will configure the request to be used for pollingoverrideConfig
- The consumer that will configure the per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupNotExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupNotExists(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupNotExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAutoScalingGroupsRequest
- the request to be used for polling- Returns:
- CompletableFuture containing the WaiterResponse. It completes successfully when the resource enters into a desired state or exceptionally when it is determined that the resource will never enter into the desired state.
-
waitUntilGroupNotExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupNotExists(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupNotExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder without the need to create one manually using
DescribeAutoScalingGroupsRequest.builder()
- Parameters:
describeAutoScalingGroupsRequest
- The consumer that will configure the request to be used for polling- Returns:
- CompletableFuture of the WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupNotExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupNotExists(DescribeAutoScalingGroupsRequest describeAutoScalingGroupsRequest, WaiterOverrideConfiguration overrideConfig)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupNotExists
is met, or until it is determined that the resource will never enter into the desired state- Parameters:
describeAutoScalingGroupsRequest
- The request to be used for pollingoverrideConfig
- Per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilGroupNotExists
default CompletableFuture<WaiterResponse<DescribeAutoScalingGroupsResponse>> waitUntilGroupNotExists(Consumer<DescribeAutoScalingGroupsRequest.Builder> describeAutoScalingGroupsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsAutoScalingAsyncClient.describeAutoScalingGroups(software.amazon.awssdk.services.autoscaling.model.DescribeAutoScalingGroupsRequest)
API until the desired conditionGroupNotExists
is met, or until it is determined that the resource will never enter into the desired state.This is a convenience method to create an instance of the request builder and instance of the override config builder
- Parameters:
describeAutoScalingGroupsRequest
- The consumer that will configure the request to be used for pollingoverrideConfig
- The consumer that will configure the per request override configuration for waiters- Returns:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
builder
static AutoScalingAsyncWaiter.Builder builder()
Create a builder that can be used to configure and create aAutoScalingAsyncWaiter
.- Returns:
- a builder
-
create
static AutoScalingAsyncWaiter create()
Create an instance ofAutoScalingAsyncWaiter
with the default configuration.A default
AutoScalingAsyncClient
will be created to poll resources. It is recommended to share a single instance of the waiter created via this method. If it is not desirable to share a waiter instance, invokeSdkAutoCloseable.close()
to release the resources once the waiter is not needed.- Returns:
- an instance of
AutoScalingAsyncWaiter
-
-