Package software.amazon.awssdk.services.glacier.waiters

Interface GlacierWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static GlacierWaiter.Builder	builder()	Create a builder that can be used to configure and create a GlacierWaiter.
static GlacierWaiter	create()	Create an instance of GlacierWaiter with the default configuration.
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultExists(DescribeVaultRequest describeVaultRequest)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultExists(DescribeVaultRequest describeVaultRequest, WaiterOverrideConfiguration overrideConfig)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultNotExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultNotExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultNotExists(DescribeVaultRequest describeVaultRequest)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeVaultResponse>	waitUntilVaultNotExists(DescribeVaultRequest describeVaultRequest, WaiterOverrideConfiguration overrideConfig)	Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists 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

waitUntilVaultExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultExists(DescribeVaultRequest describeVaultRequest)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeVaultRequest - the request to be used for polling

Returns:

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

waitUntilVaultExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists 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 DescribeVaultRequest.builder()

Parameters:

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

waitUntilVaultExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultExists(DescribeVaultRequest describeVaultRequest,
                                                                   WaiterOverrideConfiguration overrideConfig)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilVaultExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest,
                                                                   Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultExists 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:

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

waitUntilVaultNotExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultNotExists(DescribeVaultRequest describeVaultRequest)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeVaultRequest - the request to be used for polling

Returns:

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

waitUntilVaultNotExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultNotExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists 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 DescribeVaultRequest.builder()

Parameters:

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

waitUntilVaultNotExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultNotExists(DescribeVaultRequest describeVaultRequest,
                                                                      WaiterOverrideConfiguration overrideConfig)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilVaultNotExists

default WaiterResponse<DescribeVaultResponse> waitUntilVaultNotExists(Consumer<DescribeVaultRequest.Builder> describeVaultRequest,
                                                                      Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls GlacierClient.describeVault(software.amazon.awssdk.services.glacier.model.DescribeVaultRequest) API until the desired condition VaultNotExists 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:

describeVaultRequest - 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 GlacierWaiter.Builder builder()

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

Returns:

a builder

create

static GlacierWaiter create()

Create an instance of GlacierWaiter with the default configuration.

A default GlacierClient 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 GlacierWaiter