Interface EmrAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static EmrAsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a EmrAsyncWaiter.
static EmrAsyncWaiter	create()	Create an instance of EmrAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest, WaiterOverrideConfiguration overrideConfig)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeClusterResponse>>	waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest, WaiterOverrideConfiguration overrideConfig)	Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeStepResponse>>	waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest)	Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeStepResponse>>	waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeStepResponse>>	waitUntilStepComplete(DescribeStepRequest describeStepRequest)	Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeStepResponse>>	waitUntilStepComplete(DescribeStepRequest describeStepRequest, WaiterOverrideConfiguration overrideConfig)	Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete 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

waitUntilClusterRunning

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterRunning

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning 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 DescribeClusterRequest.builder()

Parameters:

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

waitUntilClusterRunning

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterRunning

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterRunning 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:

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

waitUntilClusterTerminated

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterTerminated

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated 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 DescribeClusterRequest.builder()

Parameters:

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

waitUntilClusterTerminated

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilClusterTerminated

default CompletableFuture<WaiterResponse<DescribeClusterResponse>> waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EmrAsyncClient.describeCluster(software.amazon.awssdk.services.emr.model.DescribeClusterRequest) API until the desired condition ClusterTerminated 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:

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

waitUntilStepComplete

default CompletableFuture<WaiterResponse<DescribeStepResponse>> waitUntilStepComplete(DescribeStepRequest describeStepRequest)

Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilStepComplete

default CompletableFuture<WaiterResponse<DescribeStepResponse>> waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest)

Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete 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 DescribeStepRequest.builder()

Parameters:

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

waitUntilStepComplete

default CompletableFuture<WaiterResponse<DescribeStepResponse>> waitUntilStepComplete(DescribeStepRequest describeStepRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilStepComplete

default CompletableFuture<WaiterResponse<DescribeStepResponse>> waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EmrAsyncClient.describeStep(software.amazon.awssdk.services.emr.model.DescribeStepRequest) API until the desired condition StepComplete 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:

describeStepRequest - 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 EmrAsyncWaiter.Builder builder()

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

Returns:

a builder

create

static EmrAsyncWaiter create()

Create an instance of EmrAsyncWaiter with the default configuration.

A default EmrAsyncClient 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 EmrAsyncWaiter