Package software.amazon.awssdk.services.emr.waiters

Interface EmrWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static EmrWaiter.Builder	builder()	Create a builder that can be used to configure and create a EmrWaiter.
static EmrWaiter	create()	Create an instance of EmrWaiter with the default configuration.
default WaiterResponse<DescribeClusterResponse>	waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest, WaiterOverrideConfiguration overrideConfig)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest)	Polls EmrClient.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 WaiterResponse<DescribeClusterResponse>	waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest, WaiterOverrideConfiguration overrideConfig)	Polls EmrClient.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 WaiterResponse<DescribeStepResponse>	waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest)	Polls EmrClient.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 WaiterResponse<DescribeStepResponse>	waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EmrClient.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 WaiterResponse<DescribeStepResponse>	waitUntilStepComplete(DescribeStepRequest describeStepRequest)	Polls EmrClient.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 WaiterResponse<DescribeStepResponse>	waitUntilStepComplete(DescribeStepRequest describeStepRequest, WaiterOverrideConfiguration overrideConfig)	Polls EmrClient.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 Detail

waitUntilClusterRunning

default WaiterResponse<DescribeClusterResponse> waitUntilClusterRunning(DescribeClusterRequest describeClusterRequest)

Polls EmrClient.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:

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

waitUntilClusterRunning

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

Polls EmrClient.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:

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

waitUntilClusterRunning

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

Polls EmrClient.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 WaiterResponse<DescribeClusterResponse> waitUntilClusterRunning(Consumer<DescribeClusterRequest.Builder> describeClusterRequest,
                                                                        Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EmrClient.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 WaiterResponse<DescribeClusterResponse> waitUntilClusterTerminated(DescribeClusterRequest describeClusterRequest)

Polls EmrClient.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:

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

waitUntilClusterTerminated

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

Polls EmrClient.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:

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

waitUntilClusterTerminated

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

Polls EmrClient.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 WaiterResponse<DescribeClusterResponse> waitUntilClusterTerminated(Consumer<DescribeClusterRequest.Builder> describeClusterRequest,
                                                                           Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EmrClient.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 WaiterResponse<DescribeStepResponse> waitUntilStepComplete(DescribeStepRequest describeStepRequest)

Polls EmrClient.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:

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

waitUntilStepComplete

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

Polls EmrClient.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:

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

waitUntilStepComplete

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

Polls EmrClient.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 WaiterResponse<DescribeStepResponse> waitUntilStepComplete(Consumer<DescribeStepRequest.Builder> describeStepRequest,
                                                                   Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EmrClient.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 EmrWaiter.Builder builder()

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

Returns:

a builder

create

static EmrWaiter create()

Create an instance of EmrWaiter with the default configuration.

A default EmrClient 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 EmrWaiter