Package software.amazon.awssdk.services.docdb.waiters

Interface DocDbWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static DocDbWaiter.Builder	builder()	Create a builder that can be used to configure and create a DocDbWaiter.
static DocDbWaiter	create()	Create an instance of DocDbWaiter with the default configuration.
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceAvailable(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceAvailable(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceAvailable(DescribeDbInstancesRequest describeDbInstancesRequest)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceAvailable(DescribeDbInstancesRequest describeDbInstancesRequest, WaiterOverrideConfiguration overrideConfig)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceDeleted(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceDeleted(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceDeleted(DescribeDbInstancesRequest describeDbInstancesRequest)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeDbInstancesResponse>	waitUntilDBInstanceDeleted(DescribeDbInstancesRequest describeDbInstancesRequest, WaiterOverrideConfiguration overrideConfig)	Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted 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

waitUntilDBInstanceAvailable

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceAvailable(DescribeDbInstancesRequest describeDbInstancesRequest)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeDbInstancesRequest - the request to be used for polling

Returns:

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

waitUntilDBInstanceAvailable

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceAvailable(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable 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 DescribeDbInstancesRequest.builder()

Parameters:

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

waitUntilDBInstanceAvailable

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceAvailable(DescribeDbInstancesRequest describeDbInstancesRequest,
                                                                                 WaiterOverrideConfiguration overrideConfig)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilDBInstanceAvailable

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceAvailable(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest,
                                                                                 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceAvailable 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:

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

waitUntilDBInstanceDeleted

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceDeleted(DescribeDbInstancesRequest describeDbInstancesRequest)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeDbInstancesRequest - the request to be used for polling

Returns:

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

waitUntilDBInstanceDeleted

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceDeleted(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted 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 DescribeDbInstancesRequest.builder()

Parameters:

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

waitUntilDBInstanceDeleted

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceDeleted(DescribeDbInstancesRequest describeDbInstancesRequest,
                                                                               WaiterOverrideConfiguration overrideConfig)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilDBInstanceDeleted

default WaiterResponse<DescribeDbInstancesResponse> waitUntilDBInstanceDeleted(Consumer<DescribeDbInstancesRequest.Builder> describeDbInstancesRequest,
                                                                               Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls DocDbClient.describeDBInstances(software.amazon.awssdk.services.docdb.model.DescribeDbInstancesRequest) API until the desired condition DBInstanceDeleted 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:

describeDbInstancesRequest - 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 DocDbWaiter.Builder builder()

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

Returns:

a builder

create

static DocDbWaiter create()

Create an instance of DocDbWaiter with the default configuration.

A default DocDbClient 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 DocDbWaiter