Package software.amazon.awssdk.services.elasticache.waiters

Interface ElastiCacheAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface ElastiCacheAsyncWaiter
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 static builder() method

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ElastiCacheAsyncWaiter.Builder

Method Summary

Modifier and Type	Method	Description
static ElastiCacheAsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a ElastiCacheAsyncWaiter.
static ElastiCacheAsyncWaiter	create()	Create an instance of ElastiCacheAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterAvailable(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterAvailable(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterAvailable(DescribeCacheClustersRequest describeCacheClustersRequest)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterAvailable(DescribeCacheClustersRequest describeCacheClustersRequest, WaiterOverrideConfiguration overrideConfig)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterDeleted(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterDeleted(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterDeleted(DescribeCacheClustersRequest describeCacheClustersRequest)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>>	waitUntilCacheClusterDeleted(DescribeCacheClustersRequest describeCacheClustersRequest, WaiterOverrideConfiguration overrideConfig)	Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupAvailable(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupAvailable(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupAvailable(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupAvailable(DescribeReplicationGroupsRequest describeReplicationGroupsRequest, WaiterOverrideConfiguration overrideConfig)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupDeleted(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupDeleted(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupDeleted(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>>	waitUntilReplicationGroupDeleted(DescribeReplicationGroupsRequest describeReplicationGroupsRequest, WaiterOverrideConfiguration overrideConfig)	Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted is met, or until it is determined that the resource will never enter into the desired state

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Method Detail

waitUntilCacheClusterAvailable

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterAvailable(DescribeCacheClustersRequest describeCacheClustersRequest)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeCacheClustersRequest - 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.

waitUntilCacheClusterAvailable

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterAvailable(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable 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 DescribeCacheClustersRequest.builder()

Parameters:

describeCacheClustersRequest - 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

waitUntilCacheClusterAvailable

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterAvailable(DescribeCacheClustersRequest describeCacheClustersRequest,
                                                                                                        WaiterOverrideConfiguration overrideConfig)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeCacheClustersRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilCacheClusterAvailable

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterAvailable(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest,
                                                                                                        Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterAvailable 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:

describeCacheClustersRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilCacheClusterDeleted

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterDeleted(DescribeCacheClustersRequest describeCacheClustersRequest)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeCacheClustersRequest - 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.

waitUntilCacheClusterDeleted

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterDeleted(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted 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 DescribeCacheClustersRequest.builder()

Parameters:

describeCacheClustersRequest - 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

waitUntilCacheClusterDeleted

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterDeleted(DescribeCacheClustersRequest describeCacheClustersRequest,
                                                                                                      WaiterOverrideConfiguration overrideConfig)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeCacheClustersRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilCacheClusterDeleted

default CompletableFuture<WaiterResponse<DescribeCacheClustersResponse>> waitUntilCacheClusterDeleted(Consumer<DescribeCacheClustersRequest.Builder> describeCacheClustersRequest,
                                                                                                      Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElastiCacheAsyncClient.describeCacheClusters(software.amazon.awssdk.services.elasticache.model.DescribeCacheClustersRequest) API until the desired condition CacheClusterDeleted 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:

describeCacheClustersRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilReplicationGroupAvailable

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupAvailable(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeReplicationGroupsRequest - 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.

waitUntilReplicationGroupAvailable

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupAvailable(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable 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 DescribeReplicationGroupsRequest.builder()

Parameters:

describeReplicationGroupsRequest - 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

waitUntilReplicationGroupAvailable

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupAvailable(DescribeReplicationGroupsRequest describeReplicationGroupsRequest,
                                                                                                                WaiterOverrideConfiguration overrideConfig)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeReplicationGroupsRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilReplicationGroupAvailable

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupAvailable(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest,
                                                                                                                Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupAvailable 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:

describeReplicationGroupsRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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

waitUntilReplicationGroupDeleted

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupDeleted(DescribeReplicationGroupsRequest describeReplicationGroupsRequest)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeReplicationGroupsRequest - 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.

waitUntilReplicationGroupDeleted

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupDeleted(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted 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 DescribeReplicationGroupsRequest.builder()

Parameters:

describeReplicationGroupsRequest - 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

waitUntilReplicationGroupDeleted

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupDeleted(DescribeReplicationGroupsRequest describeReplicationGroupsRequest,
                                                                                                              WaiterOverrideConfiguration overrideConfig)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeReplicationGroupsRequest - The request to be used for polling

overrideConfig - Per request override configuration for waiters

Returns:

WaiterResponse containing either a response or an exception that has matched with the waiter success condition

waitUntilReplicationGroupDeleted

default CompletableFuture<WaiterResponse<DescribeReplicationGroupsResponse>> waitUntilReplicationGroupDeleted(Consumer<DescribeReplicationGroupsRequest.Builder> describeReplicationGroupsRequest,
                                                                                                              Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElastiCacheAsyncClient.describeReplicationGroups(software.amazon.awssdk.services.elasticache.model.DescribeReplicationGroupsRequest) API until the desired condition ReplicationGroupDeleted 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:

describeReplicationGroupsRequest - The consumer that will configure the request to be used for polling

overrideConfig - 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 ElastiCacheAsyncWaiter.Builder builder()

Create a builder that can be used to configure and create a ElastiCacheAsyncWaiter.

Returns:

a builder

create

static ElastiCacheAsyncWaiter create()

Create an instance of ElastiCacheAsyncWaiter with the default configuration.

A default ElastiCacheAsyncClient 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, invoke SdkAutoCloseable.close() to release the resources once the waiter is not needed.

Returns:

an instance of ElastiCacheAsyncWaiter