Package software.amazon.awssdk.services.s3.waiters

Interface S3AsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static S3AsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a S3AsyncWaiter.
static S3AsyncWaiter	create()	Create an instance of S3AsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketExists(HeadBucketRequest headBucketRequest)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketExists(HeadBucketRequest headBucketRequest, WaiterOverrideConfiguration overrideConfig)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketNotExists(HeadBucketRequest headBucketRequest)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadBucketResponse>>	waitUntilBucketNotExists(HeadBucketRequest headBucketRequest, WaiterOverrideConfiguration overrideConfig)	Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectExists(HeadObjectRequest headObjectRequest)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectExists(HeadObjectRequest headObjectRequest, WaiterOverrideConfiguration overrideConfig)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectNotExists(HeadObjectRequest headObjectRequest)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<HeadObjectResponse>>	waitUntilObjectNotExists(HeadObjectRequest headObjectRequest, WaiterOverrideConfiguration overrideConfig)	Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists 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

waitUntilBucketExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketExists(HeadBucketRequest headBucketRequest)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilBucketExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists 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 HeadBucketRequest.builder()

Parameters:

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

waitUntilBucketExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketExists(HeadBucketRequest headBucketRequest,
                                                                                    WaiterOverrideConfiguration overrideConfig)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilBucketExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest,
                                                                                    Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketExists 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:

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

waitUntilBucketNotExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketNotExists(HeadBucketRequest headBucketRequest)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilBucketNotExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists 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 HeadBucketRequest.builder()

Parameters:

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

waitUntilBucketNotExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketNotExists(HeadBucketRequest headBucketRequest,
                                                                                       WaiterOverrideConfiguration overrideConfig)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilBucketNotExists

default CompletableFuture<WaiterResponse<HeadBucketResponse>> waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest,
                                                                                       Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls S3AsyncClient.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest) API until the desired condition BucketNotExists 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:

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

waitUntilObjectExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectExists(HeadObjectRequest headObjectRequest)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilObjectExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists 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 HeadObjectRequest.builder()

Parameters:

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

waitUntilObjectExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectExists(HeadObjectRequest headObjectRequest,
                                                                                    WaiterOverrideConfiguration overrideConfig)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilObjectExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest,
                                                                                    Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectExists 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:

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

waitUntilObjectNotExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectNotExists(HeadObjectRequest headObjectRequest)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilObjectNotExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists 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 HeadObjectRequest.builder()

Parameters:

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

waitUntilObjectNotExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectNotExists(HeadObjectRequest headObjectRequest,
                                                                                       WaiterOverrideConfiguration overrideConfig)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilObjectNotExists

default CompletableFuture<WaiterResponse<HeadObjectResponse>> waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest,
                                                                                       Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls S3AsyncClient.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest) API until the desired condition ObjectNotExists 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:

headObjectRequest - 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 S3AsyncWaiter.Builder builder()

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

Returns:

a builder

create

static S3AsyncWaiter create()

Create an instance of S3AsyncWaiter with the default configuration.

A default S3AsyncClient 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 S3AsyncWaiter