Package software.amazon.awssdk.services.elastictranscoder.waiters

Interface ElasticTranscoderAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static ElasticTranscoderAsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a ElasticTranscoderAsyncWaiter.
static ElasticTranscoderAsyncWaiter	create()	Create an instance of ElasticTranscoderAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<ReadJobResponse>>	waitUntilJobComplete(Consumer<ReadJobRequest.Builder> readJobRequest)	Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<ReadJobResponse>>	waitUntilJobComplete(Consumer<ReadJobRequest.Builder> readJobRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<ReadJobResponse>>	waitUntilJobComplete(ReadJobRequest readJobRequest)	Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<ReadJobResponse>>	waitUntilJobComplete(ReadJobRequest readJobRequest, WaiterOverrideConfiguration overrideConfig)	Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete 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

waitUntilJobComplete

default CompletableFuture<WaiterResponse<ReadJobResponse>> waitUntilJobComplete(ReadJobRequest readJobRequest)

Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilJobComplete

default CompletableFuture<WaiterResponse<ReadJobResponse>> waitUntilJobComplete(Consumer<ReadJobRequest.Builder> readJobRequest)

Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete 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 ReadJobRequest.builder()

Parameters:

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

waitUntilJobComplete

default CompletableFuture<WaiterResponse<ReadJobResponse>> waitUntilJobComplete(ReadJobRequest readJobRequest,
                                                                                WaiterOverrideConfiguration overrideConfig)

Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilJobComplete

default CompletableFuture<WaiterResponse<ReadJobResponse>> waitUntilJobComplete(Consumer<ReadJobRequest.Builder> readJobRequest,
                                                                                Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls ElasticTranscoderAsyncClient.readJob(software.amazon.awssdk.services.elastictranscoder.model.ReadJobRequest) API until the desired condition JobComplete 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:

readJobRequest - 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 ElasticTranscoderAsyncWaiter.Builder builder()

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

Returns:

a builder

create

static ElasticTranscoderAsyncWaiter create()

Create an instance of ElasticTranscoderAsyncWaiter with the default configuration.

A default ElasticTranscoderAsyncClient 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 ElasticTranscoderAsyncWaiter