software.amazon.awssdk.services.redshift.waiters

Interface RedshiftWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated(value="software.amazon.awssdk:codegen")
public interface RedshiftWaiter
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 and Description
static interface	RedshiftWaiter.Builder

Method Summary

Modifier and Type	Method and Description
static RedshiftWaiter.Builder	builder() Create a builder that can be used to configure and create a RedshiftWaiter.
static RedshiftWaiter	create() Create an instance of RedshiftWaiter with the default configuration.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterAvailable(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterAvailable(Consumer<DescribeClustersRequest.Builder> describeClustersRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterAvailable(DescribeClustersRequest describeClustersRequest) Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterAvailable(DescribeClustersRequest describeClustersRequest, WaiterOverrideConfiguration overrideConfig) Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterDeleted(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterDeleted(Consumer<DescribeClustersRequest.Builder> describeClustersRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterDeleted(DescribeClustersRequest describeClustersRequest) Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterDeleted(DescribeClustersRequest describeClustersRequest, WaiterOverrideConfiguration overrideConfig) Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterRestored(Consumer<DescribeClustersRequest.Builder> describeClustersRequest) Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterRestored(Consumer<DescribeClustersRequest.Builder> describeClustersRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterRestored(DescribeClustersRequest describeClustersRequest) Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClustersResponse>	waitUntilClusterRestored(DescribeClustersRequest describeClustersRequest, WaiterOverrideConfiguration overrideConfig) Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClusterSnapshotsResponse>	waitUntilSnapshotAvailable(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest) Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClusterSnapshotsResponse>	waitUntilSnapshotAvailable(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeClusterSnapshotsResponse>	waitUntilSnapshotAvailable(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest) Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeClusterSnapshotsResponse>	waitUntilSnapshotAvailable(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest, WaiterOverrideConfiguration overrideConfig) Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable 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

waitUntilClusterAvailable

default WaiterResponse<DescribeClustersResponse> waitUntilClusterAvailable(DescribeClustersRequest describeClustersRequest)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeClustersRequest - the request to be used for polling

Returns:

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

waitUntilClusterAvailable

default WaiterResponse<DescribeClustersResponse> waitUntilClusterAvailable(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable 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 DescribeClustersRequest.builder()

Parameters:

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

Returns:

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

waitUntilClusterAvailable

default WaiterResponse<DescribeClustersResponse> waitUntilClusterAvailable(DescribeClustersRequest describeClustersRequest,
                                                                           WaiterOverrideConfiguration overrideConfig)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterAvailable

default WaiterResponse<DescribeClustersResponse> waitUntilClusterAvailable(Consumer<DescribeClustersRequest.Builder> describeClustersRequest,
                                                                           Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterAvailable 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:

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

waitUntilClusterDeleted

default WaiterResponse<DescribeClustersResponse> waitUntilClusterDeleted(DescribeClustersRequest describeClustersRequest)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeClustersRequest - the request to be used for polling

Returns:

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

waitUntilClusterDeleted

default WaiterResponse<DescribeClustersResponse> waitUntilClusterDeleted(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted 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 DescribeClustersRequest.builder()

Parameters:

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

Returns:

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

waitUntilClusterDeleted

default WaiterResponse<DescribeClustersResponse> waitUntilClusterDeleted(DescribeClustersRequest describeClustersRequest,
                                                                         WaiterOverrideConfiguration overrideConfig)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterDeleted

default WaiterResponse<DescribeClustersResponse> waitUntilClusterDeleted(Consumer<DescribeClustersRequest.Builder> describeClustersRequest,
                                                                         Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterDeleted 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:

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

waitUntilClusterRestored

default WaiterResponse<DescribeClustersResponse> waitUntilClusterRestored(DescribeClustersRequest describeClustersRequest)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeClustersRequest - the request to be used for polling

Returns:

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

waitUntilClusterRestored

default WaiterResponse<DescribeClustersResponse> waitUntilClusterRestored(Consumer<DescribeClustersRequest.Builder> describeClustersRequest)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored 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 DescribeClustersRequest.builder()

Parameters:

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

Returns:

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

waitUntilClusterRestored

default WaiterResponse<DescribeClustersResponse> waitUntilClusterRestored(DescribeClustersRequest describeClustersRequest,
                                                                          WaiterOverrideConfiguration overrideConfig)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterRestored

default WaiterResponse<DescribeClustersResponse> waitUntilClusterRestored(Consumer<DescribeClustersRequest.Builder> describeClustersRequest,
                                                                          Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls RedshiftClient.describeClusters() API until the desired condition ClusterRestored 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:

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

waitUntilSnapshotAvailable

default WaiterResponse<DescribeClusterSnapshotsResponse> waitUntilSnapshotAvailable(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest)

Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeClusterSnapshotsRequest - the request to be used for polling

Returns:

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

waitUntilSnapshotAvailable

default WaiterResponse<DescribeClusterSnapshotsResponse> waitUntilSnapshotAvailable(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest)

Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable 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 DescribeClusterSnapshotsRequest.builder()

Parameters:

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

Returns:

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

waitUntilSnapshotAvailable

default WaiterResponse<DescribeClusterSnapshotsResponse> waitUntilSnapshotAvailable(DescribeClusterSnapshotsRequest describeClusterSnapshotsRequest,
                                                                                    WaiterOverrideConfiguration overrideConfig)

Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilSnapshotAvailable

default WaiterResponse<DescribeClusterSnapshotsResponse> waitUntilSnapshotAvailable(Consumer<DescribeClusterSnapshotsRequest.Builder> describeClusterSnapshotsRequest,
                                                                                    Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls RedshiftClient.describeClusterSnapshots() API until the desired condition SnapshotAvailable 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:

describeClusterSnapshotsRequest - 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 RedshiftWaiter.Builder builder()

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

Returns:

a builder

create

static RedshiftWaiter create()

Create an instance of RedshiftWaiter with the default configuration.

A default RedshiftClient 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 RedshiftWaiter