Package software.amazon.awssdk.services.rekognition.waiters

Interface RekognitionWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static RekognitionWaiter.Builder	builder()	Create a builder that can be used to configure and create a RekognitionWaiter.
static RekognitionWaiter	create()	Create an instance of RekognitionWaiter with the default configuration.
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionRunning(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionRunning(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionRunning(DescribeProjectVersionsRequest describeProjectVersionsRequest)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionRunning(DescribeProjectVersionsRequest describeProjectVersionsRequest, WaiterOverrideConfiguration overrideConfig)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionTrainingCompleted(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionTrainingCompleted(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionTrainingCompleted(DescribeProjectVersionsRequest describeProjectVersionsRequest)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<DescribeProjectVersionsResponse>	waitUntilProjectVersionTrainingCompleted(DescribeProjectVersionsRequest describeProjectVersionsRequest, WaiterOverrideConfiguration overrideConfig)	Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted 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

waitUntilProjectVersionRunning

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionRunning(DescribeProjectVersionsRequest describeProjectVersionsRequest)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeProjectVersionsRequest - the request to be used for polling

Returns:

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

waitUntilProjectVersionRunning

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionRunning(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning 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 DescribeProjectVersionsRequest.builder()

Parameters:

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

waitUntilProjectVersionRunning

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionRunning(DescribeProjectVersionsRequest describeProjectVersionsRequest,
                                                                                       WaiterOverrideConfiguration overrideConfig)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilProjectVersionRunning

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionRunning(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest,
                                                                                       Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionRunning 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:

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

waitUntilProjectVersionTrainingCompleted

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionTrainingCompleted(DescribeProjectVersionsRequest describeProjectVersionsRequest)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

describeProjectVersionsRequest - the request to be used for polling

Returns:

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

waitUntilProjectVersionTrainingCompleted

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionTrainingCompleted(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted 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 DescribeProjectVersionsRequest.builder()

Parameters:

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

waitUntilProjectVersionTrainingCompleted

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionTrainingCompleted(DescribeProjectVersionsRequest describeProjectVersionsRequest,
                                                                                                 WaiterOverrideConfiguration overrideConfig)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilProjectVersionTrainingCompleted

default WaiterResponse<DescribeProjectVersionsResponse> waitUntilProjectVersionTrainingCompleted(Consumer<DescribeProjectVersionsRequest.Builder> describeProjectVersionsRequest,
                                                                                                 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls RekognitionClient.describeProjectVersions(software.amazon.awssdk.services.rekognition.model.DescribeProjectVersionsRequest) API until the desired condition ProjectVersionTrainingCompleted 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:

describeProjectVersionsRequest - 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 RekognitionWaiter.Builder builder()

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

Returns:

a builder

create

static RekognitionWaiter create()

Create an instance of RekognitionWaiter with the default configuration.

A default RekognitionClient 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 RekognitionWaiter