Package software.amazon.awssdk.services.dynamodb.waiters

Interface DynamoDbWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
@Immutable
public interface DynamoDbWaiter
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	DynamoDbWaiter.Builder

Method Summary

Modifier and Type	Method	Description
static DynamoDbWaiter.Builder	builder()	Create a builder that can be used to configure and create a DynamoDbWaiter.
static DynamoDbWaiter	create()	Create an instance of DynamoDbWaiter with the default configuration.
default WaiterResponse<DescribeTableResponse>	waitUntilTableExists(Consumer<DescribeTableRequest.Builder> describeTableRequest)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeTableResponse>	waitUntilTableExists(Consumer<DescribeTableRequest.Builder> describeTableRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeTableResponse>	waitUntilTableExists(DescribeTableRequest describeTableRequest)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeTableResponse>	waitUntilTableExists(DescribeTableRequest describeTableRequest, WaiterOverrideConfiguration overrideConfig)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeTableResponse>	waitUntilTableNotExists(Consumer<DescribeTableRequest.Builder> describeTableRequest)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeTableResponse>	waitUntilTableNotExists(Consumer<DescribeTableRequest.Builder> describeTableRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeTableResponse>	waitUntilTableNotExists(DescribeTableRequest describeTableRequest)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeTableResponse>	waitUntilTableNotExists(DescribeTableRequest describeTableRequest, WaiterOverrideConfiguration overrideConfig)	Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists 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

waitUntilTableExists

default WaiterResponse<DescribeTableResponse> waitUntilTableExists(DescribeTableRequest describeTableRequest)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeTableRequest - the request to be used for polling

Returns:

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

waitUntilTableExists

default WaiterResponse<DescribeTableResponse> waitUntilTableExists(Consumer<DescribeTableRequest.Builder> describeTableRequest)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists 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 DescribeTableRequest.builder()

Parameters:

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

waitUntilTableExists

default WaiterResponse<DescribeTableResponse> waitUntilTableExists(DescribeTableRequest describeTableRequest,
                                                                   WaiterOverrideConfiguration overrideConfig)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilTableExists

default WaiterResponse<DescribeTableResponse> waitUntilTableExists(Consumer<DescribeTableRequest.Builder> describeTableRequest,
                                                                   Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableExists 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:

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

waitUntilTableNotExists

default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(DescribeTableRequest describeTableRequest)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeTableRequest - the request to be used for polling

Returns:

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

waitUntilTableNotExists

default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(Consumer<DescribeTableRequest.Builder> describeTableRequest)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists 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 DescribeTableRequest.builder()

Parameters:

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

waitUntilTableNotExists

default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(DescribeTableRequest describeTableRequest,
                                                                      WaiterOverrideConfiguration overrideConfig)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilTableNotExists

default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(Consumer<DescribeTableRequest.Builder> describeTableRequest,
                                                                      Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls DynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest) API until the desired condition TableNotExists 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:

describeTableRequest - 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 DynamoDbWaiter.Builder builder()

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

Returns:

a builder

create

static DynamoDbWaiter create()

Create an instance of DynamoDbWaiter with the default configuration.

A default DynamoDbClient 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 DynamoDbWaiter