Interface DynamoDbWaiter
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
builder()
method-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic DynamoDbWaiter.Builder
builder()
Create a builder that can be used to configure and create aDynamoDbWaiter
.static DynamoDbWaiter
create()
Create an instance ofDynamoDbWaiter
with the default configuration.default WaiterResponse
<DescribeTableResponse> waitUntilTableExists
(Consumer<DescribeTableRequest.Builder> describeTableRequest) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<DescribeTableResponse> waitUntilTableExists
(DescribeTableRequest describeTableRequest) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeTableResponse> waitUntilTableExists
(DescribeTableRequest describeTableRequest, WaiterOverrideConfiguration overrideConfig) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeTableResponse> waitUntilTableNotExists
(Consumer<DescribeTableRequest.Builder> describeTableRequest) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse
<DescribeTableResponse> waitUntilTableNotExists
(DescribeTableRequest describeTableRequest) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse
<DescribeTableResponse> waitUntilTableNotExists
(DescribeTableRequest describeTableRequest, WaiterOverrideConfiguration overrideConfig) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
is met, or until it is determined that the resource will never enter into the desired stateMethods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Method Details
-
waitUntilTableExists
default WaiterResponse<DescribeTableResponse> waitUntilTableExists(DescribeTableRequest describeTableRequest) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
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 pollingoverrideConfig
- 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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableExists
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 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
-
waitUntilTableNotExists
default WaiterResponse<DescribeTableResponse> waitUntilTableNotExists(DescribeTableRequest describeTableRequest) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
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 pollingoverrideConfig
- 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) PollsDynamoDbClient.describeTable(software.amazon.awssdk.services.dynamodb.model.DescribeTableRequest)
API until the desired conditionTableNotExists
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 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
Create a builder that can be used to configure and create aDynamoDbWaiter
.- Returns:
- a builder
-
create
Create an instance ofDynamoDbWaiter
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, invokeSdkAutoCloseable.close()
to release the resources once the waiter is not needed.- Returns:
- an instance of
DynamoDbWaiter
-