Interface S3Waiter
-
- All Superinterfaces:
AutoCloseable
,SdkAutoCloseable
@Generated("software.amazon.awssdk:codegen") @ThreadSafe @Immutable public interface S3Waiter 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 staticbuilder()
method
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
S3Waiter.Builder
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static S3Waiter.Builder
builder()
Create a builder that can be used to configure and create aS3Waiter
.static S3Waiter
create()
Create an instance ofS3Waiter
with the default configuration.default WaiterResponse<HeadBucketResponse>
waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadBucketResponse>
waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadBucketResponse>
waitUntilBucketExists(HeadBucketRequest headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadBucketResponse>
waitUntilBucketExists(HeadBucketRequest headBucketRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadBucketResponse>
waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadBucketResponse>
waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadBucketResponse>
waitUntilBucketNotExists(HeadBucketRequest headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadBucketResponse>
waitUntilBucketNotExists(HeadBucketRequest headBucketRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadObjectResponse>
waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadObjectResponse>
waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadObjectResponse>
waitUntilObjectExists(HeadObjectRequest headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadObjectResponse>
waitUntilObjectExists(HeadObjectRequest headObjectRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadObjectResponse>
waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadObjectResponse>
waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
is met, or until it is determined that the resource will never enter into the desired state.default WaiterResponse<HeadObjectResponse>
waitUntilObjectNotExists(HeadObjectRequest headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
is met, or until it is determined that the resource will never enter into the desired statedefault WaiterResponse<HeadObjectResponse>
waitUntilObjectNotExists(HeadObjectRequest headObjectRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
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 WaiterResponse<HeadBucketResponse> waitUntilBucketExists(HeadBucketRequest headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilBucketExists
default WaiterResponse<HeadBucketResponse> waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilBucketExists
default WaiterResponse<HeadBucketResponse> waitUntilBucketExists(HeadBucketRequest headBucketRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
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 pollingoverrideConfig
- 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 WaiterResponse<HeadBucketResponse> waitUntilBucketExists(Consumer<HeadBucketRequest.Builder> headBucketRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketExists
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 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
-
waitUntilBucketNotExists
default WaiterResponse<HeadBucketResponse> waitUntilBucketNotExists(HeadBucketRequest headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilBucketNotExists
default WaiterResponse<HeadBucketResponse> waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilBucketNotExists
default WaiterResponse<HeadBucketResponse> waitUntilBucketNotExists(HeadBucketRequest headBucketRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
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 pollingoverrideConfig
- 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 WaiterResponse<HeadBucketResponse> waitUntilBucketNotExists(Consumer<HeadBucketRequest.Builder> headBucketRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headBucket(software.amazon.awssdk.services.s3.model.HeadBucketRequest)
API until the desired conditionBucketNotExists
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 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
-
waitUntilObjectExists
default WaiterResponse<HeadObjectResponse> waitUntilObjectExists(HeadObjectRequest headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilObjectExists
default WaiterResponse<HeadObjectResponse> waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilObjectExists
default WaiterResponse<HeadObjectResponse> waitUntilObjectExists(HeadObjectRequest headObjectRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
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 pollingoverrideConfig
- 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 WaiterResponse<HeadObjectResponse> waitUntilObjectExists(Consumer<HeadObjectRequest.Builder> headObjectRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectExists
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 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
-
waitUntilObjectNotExists
default WaiterResponse<HeadObjectResponse> waitUntilObjectNotExists(HeadObjectRequest headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilObjectNotExists
default WaiterResponse<HeadObjectResponse> waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
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:
- WaiterResponse containing either a response or an exception that has matched with the waiter success condition
-
waitUntilObjectNotExists
default WaiterResponse<HeadObjectResponse> waitUntilObjectNotExists(HeadObjectRequest headObjectRequest, WaiterOverrideConfiguration overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
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 pollingoverrideConfig
- 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 WaiterResponse<HeadObjectResponse> waitUntilObjectNotExists(Consumer<HeadObjectRequest.Builder> headObjectRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)
PollsS3Client.headObject(software.amazon.awssdk.services.s3.model.HeadObjectRequest)
API until the desired conditionObjectNotExists
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 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
static S3Waiter.Builder builder()
Create a builder that can be used to configure and create aS3Waiter
.- Returns:
- a builder
-
create
static S3Waiter create()
Create an instance ofS3Waiter
with the default configuration.A default
S3Client
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
S3Waiter
-
-