Interface AppConfigWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static AppConfigWaiter.Builder	builder()	Create a builder that can be used to configure and create a AppConfigWaiter.
static AppConfigWaiter	create()	Create an instance of AppConfigWaiter with the default configuration.
default WaiterResponse<GetDeploymentResponse>	waitUntilDeploymentComplete(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)	Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetDeploymentResponse>	waitUntilDeploymentComplete(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetDeploymentResponse>	waitUntilDeploymentComplete(GetDeploymentRequest getDeploymentRequest)	Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetDeploymentResponse>	waitUntilDeploymentComplete(GetDeploymentRequest getDeploymentRequest, WaiterOverrideConfiguration overrideConfig)	Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetEnvironmentResponse>	waitUntilEnvironmentReadyForDeployment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)	Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetEnvironmentResponse>	waitUntilEnvironmentReadyForDeployment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetEnvironmentResponse>	waitUntilEnvironmentReadyForDeployment(GetEnvironmentRequest getEnvironmentRequest)	Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetEnvironmentResponse>	waitUntilEnvironmentReadyForDeployment(GetEnvironmentRequest getEnvironmentRequest, WaiterOverrideConfiguration overrideConfig)	Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment 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 Details

waitUntilDeploymentComplete

default WaiterResponse<GetDeploymentResponse> waitUntilDeploymentComplete(GetDeploymentRequest getDeploymentRequest)

Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getDeploymentRequest - the request to be used for polling

Returns:

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

waitUntilDeploymentComplete

default WaiterResponse<GetDeploymentResponse> waitUntilDeploymentComplete(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest)

Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete 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 GetDeploymentRequest.builder()

Parameters:

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

waitUntilDeploymentComplete

default WaiterResponse<GetDeploymentResponse> waitUntilDeploymentComplete(GetDeploymentRequest getDeploymentRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilDeploymentComplete

default WaiterResponse<GetDeploymentResponse> waitUntilDeploymentComplete(Consumer<GetDeploymentRequest.Builder> getDeploymentRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AppConfigClient.getDeployment(software.amazon.awssdk.services.appconfig.model.GetDeploymentRequest) API until the desired condition DeploymentComplete 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:

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

waitUntilEnvironmentReadyForDeployment

default WaiterResponse<GetEnvironmentResponse> waitUntilEnvironmentReadyForDeployment(GetEnvironmentRequest getEnvironmentRequest)

Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getEnvironmentRequest - the request to be used for polling

Returns:

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

waitUntilEnvironmentReadyForDeployment

default WaiterResponse<GetEnvironmentResponse> waitUntilEnvironmentReadyForDeployment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)

Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment 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 GetEnvironmentRequest.builder()

Parameters:

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

waitUntilEnvironmentReadyForDeployment

default WaiterResponse<GetEnvironmentResponse> waitUntilEnvironmentReadyForDeployment(GetEnvironmentRequest getEnvironmentRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilEnvironmentReadyForDeployment

default WaiterResponse<GetEnvironmentResponse> waitUntilEnvironmentReadyForDeployment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AppConfigClient.getEnvironment(software.amazon.awssdk.services.appconfig.model.GetEnvironmentRequest) API until the desired condition EnvironmentReadyForDeployment 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:

getEnvironmentRequest - 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 AppConfigWaiter.Builder builder()

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

Returns:

a builder

create

static AppConfigWaiter create()

Create an instance of AppConfigWaiter with the default configuration.

A default AppConfigClient 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 AppConfigWaiter