Package software.amazon.awssdk.services.ecs.waiters

Interface EcsAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static EcsAsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a EcsAsyncWaiter.
static EcsAsyncWaiter	create()	Create an instance of EcsAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesInactive(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesInactive(Consumer<DescribeServicesRequest.Builder> describeServicesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesInactive(DescribeServicesRequest describeServicesRequest)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesInactive(DescribeServicesRequest describeServicesRequest, WaiterOverrideConfiguration overrideConfig)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesStable(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesStable(Consumer<DescribeServicesRequest.Builder> describeServicesRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesStable(DescribeServicesRequest describeServicesRequest)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeServicesResponse>>	waitUntilServicesStable(DescribeServicesRequest describeServicesRequest, WaiterOverrideConfiguration overrideConfig)	Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksRunning(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksRunning(Consumer<DescribeTasksRequest.Builder> describeTasksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksRunning(DescribeTasksRequest describeTasksRequest)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksRunning(DescribeTasksRequest describeTasksRequest, WaiterOverrideConfiguration overrideConfig)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksStopped(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksStopped(Consumer<DescribeTasksRequest.Builder> describeTasksRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksStopped(DescribeTasksRequest describeTasksRequest)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeTasksResponse>>	waitUntilTasksStopped(DescribeTasksRequest describeTasksRequest, WaiterOverrideConfiguration overrideConfig)	Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped 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

waitUntilServicesInactive

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesInactive(DescribeServicesRequest describeServicesRequest)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilServicesInactive

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesInactive(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive 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 DescribeServicesRequest.builder()

Parameters:

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

waitUntilServicesInactive

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesInactive(DescribeServicesRequest describeServicesRequest,
                                                                                              WaiterOverrideConfiguration overrideConfig)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilServicesInactive

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesInactive(Consumer<DescribeServicesRequest.Builder> describeServicesRequest,
                                                                                              Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesInactive 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:

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

waitUntilServicesStable

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesStable(DescribeServicesRequest describeServicesRequest)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilServicesStable

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesStable(Consumer<DescribeServicesRequest.Builder> describeServicesRequest)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable 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 DescribeServicesRequest.builder()

Parameters:

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

waitUntilServicesStable

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesStable(DescribeServicesRequest describeServicesRequest,
                                                                                            WaiterOverrideConfiguration overrideConfig)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilServicesStable

default CompletableFuture<WaiterResponse<DescribeServicesResponse>> waitUntilServicesStable(Consumer<DescribeServicesRequest.Builder> describeServicesRequest,
                                                                                            Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EcsAsyncClient.describeServices(software.amazon.awssdk.services.ecs.model.DescribeServicesRequest) API until the desired condition ServicesStable 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:

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

waitUntilTasksRunning

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksRunning(DescribeTasksRequest describeTasksRequest)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilTasksRunning

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksRunning(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning 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 DescribeTasksRequest.builder()

Parameters:

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

waitUntilTasksRunning

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksRunning(DescribeTasksRequest describeTasksRequest,
                                                                                       WaiterOverrideConfiguration overrideConfig)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilTasksRunning

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksRunning(Consumer<DescribeTasksRequest.Builder> describeTasksRequest,
                                                                                       Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksRunning 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:

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

waitUntilTasksStopped

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksStopped(DescribeTasksRequest describeTasksRequest)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilTasksStopped

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksStopped(Consumer<DescribeTasksRequest.Builder> describeTasksRequest)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped 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 DescribeTasksRequest.builder()

Parameters:

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

waitUntilTasksStopped

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksStopped(DescribeTasksRequest describeTasksRequest,
                                                                                       WaiterOverrideConfiguration overrideConfig)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilTasksStopped

default CompletableFuture<WaiterResponse<DescribeTasksResponse>> waitUntilTasksStopped(Consumer<DescribeTasksRequest.Builder> describeTasksRequest,
                                                                                       Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EcsAsyncClient.describeTasks(software.amazon.awssdk.services.ecs.model.DescribeTasksRequest) API until the desired condition TasksStopped 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:

describeTasksRequest - 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 EcsAsyncWaiter.Builder builder()

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

Returns:

a builder

create

static EcsAsyncWaiter create()

Create an instance of EcsAsyncWaiter with the default configuration.

A default EcsAsyncClient 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 EcsAsyncWaiter