software.amazon.awssdk.services.elasticbeanstalk.waiters

Interface ElasticBeanstalkWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

@Generated(value="software.amazon.awssdk:codegen")
public interface ElasticBeanstalkWaiter
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 and Description
static interface	ElasticBeanstalkWaiter.Builder

Method Summary

Modifier and Type	Method and Description
static ElasticBeanstalkWaiter.Builder	builder() Create a builder that can be used to configure and create a ElasticBeanstalkWaiter.
static ElasticBeanstalkWaiter	create() Create an instance of ElasticBeanstalkWaiter with the default configuration.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentExists(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentExists(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentExists(DescribeEnvironmentsRequest describeEnvironmentsRequest) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentExists(DescribeEnvironmentsRequest describeEnvironmentsRequest, WaiterOverrideConfiguration overrideConfig) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentTerminated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentTerminated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentTerminated(DescribeEnvironmentsRequest describeEnvironmentsRequest) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentTerminated(DescribeEnvironmentsRequest describeEnvironmentsRequest, WaiterOverrideConfiguration overrideConfig) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentUpdated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentUpdated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentUpdated(DescribeEnvironmentsRequest describeEnvironmentsRequest) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeEnvironmentsResponse>	waitUntilEnvironmentUpdated(DescribeEnvironmentsRequest describeEnvironmentsRequest, WaiterOverrideConfiguration overrideConfig) Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated 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

waitUntilEnvironmentExists

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentExists(DescribeEnvironmentsRequest describeEnvironmentsRequest)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeEnvironmentsRequest - the request to be used for polling

Returns:

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

waitUntilEnvironmentExists

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentExists(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists 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 DescribeEnvironmentsRequest.builder()

Parameters:

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

waitUntilEnvironmentExists

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentExists(DescribeEnvironmentsRequest describeEnvironmentsRequest,
                                                                                WaiterOverrideConfiguration overrideConfig)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilEnvironmentExists

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentExists(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest,
                                                                                Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentExists 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:

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

waitUntilEnvironmentTerminated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentTerminated(DescribeEnvironmentsRequest describeEnvironmentsRequest)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeEnvironmentsRequest - the request to be used for polling

Returns:

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

waitUntilEnvironmentTerminated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentTerminated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated 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 DescribeEnvironmentsRequest.builder()

Parameters:

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

waitUntilEnvironmentTerminated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentTerminated(DescribeEnvironmentsRequest describeEnvironmentsRequest,
                                                                                    WaiterOverrideConfiguration overrideConfig)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilEnvironmentTerminated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentTerminated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest,
                                                                                    Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentTerminated 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:

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

waitUntilEnvironmentUpdated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentUpdated(DescribeEnvironmentsRequest describeEnvironmentsRequest)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeEnvironmentsRequest - the request to be used for polling

Returns:

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

waitUntilEnvironmentUpdated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentUpdated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated 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 DescribeEnvironmentsRequest.builder()

Parameters:

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

waitUntilEnvironmentUpdated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentUpdated(DescribeEnvironmentsRequest describeEnvironmentsRequest,
                                                                                 WaiterOverrideConfiguration overrideConfig)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilEnvironmentUpdated

default WaiterResponse<DescribeEnvironmentsResponse> waitUntilEnvironmentUpdated(Consumer<DescribeEnvironmentsRequest.Builder> describeEnvironmentsRequest,
                                                                                 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElasticBeanstalkClient.describeEnvironments() API until the desired condition EnvironmentUpdated 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:

describeEnvironmentsRequest - 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 ElasticBeanstalkWaiter.Builder builder()

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

Returns:

a builder

create

static ElasticBeanstalkWaiter create()

Create an instance of ElasticBeanstalkWaiter with the default configuration.

A default ElasticBeanstalkClient 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 ElasticBeanstalkWaiter