Package software.amazon.awssdk.services.amp.waiters

Interface AmpAsyncWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static AmpAsyncWaiter.Builder	builder()	Create a builder that can be used to configure and create a AmpAsyncWaiter.
static AmpAsyncWaiter	create()	Create an instance of AmpAsyncWaiter with the default configuration.
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperActive(Consumer<DescribeScraperRequest.Builder> describeScraperRequest)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperActive(Consumer<DescribeScraperRequest.Builder> describeScraperRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperActive(DescribeScraperRequest describeScraperRequest)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperActive(DescribeScraperRequest describeScraperRequest, WaiterOverrideConfiguration overrideConfig)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperDeleted(Consumer<DescribeScraperRequest.Builder> describeScraperRequest)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperDeleted(Consumer<DescribeScraperRequest.Builder> describeScraperRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperDeleted(DescribeScraperRequest describeScraperRequest)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeScraperResponse>>	waitUntilScraperDeleted(DescribeScraperRequest describeScraperRequest, WaiterOverrideConfiguration overrideConfig)	Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceActive(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceActive(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceActive(DescribeWorkspaceRequest describeWorkspaceRequest)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceActive(DescribeWorkspaceRequest describeWorkspaceRequest, WaiterOverrideConfiguration overrideConfig)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceDeleted(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceDeleted(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted is met, or until it is determined that the resource will never enter into the desired state.
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceDeleted(DescribeWorkspaceRequest describeWorkspaceRequest)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted is met, or until it is determined that the resource will never enter into the desired state
default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>>	waitUntilWorkspaceDeleted(DescribeWorkspaceRequest describeWorkspaceRequest, WaiterOverrideConfiguration overrideConfig)	Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted 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

waitUntilScraperActive

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperActive(DescribeScraperRequest describeScraperRequest)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilScraperActive

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperActive(Consumer<DescribeScraperRequest.Builder> describeScraperRequest)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive 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 DescribeScraperRequest.builder()

Parameters:

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

waitUntilScraperActive

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperActive(DescribeScraperRequest describeScraperRequest,
                                                                                          WaiterOverrideConfiguration overrideConfig)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilScraperActive

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperActive(Consumer<DescribeScraperRequest.Builder> describeScraperRequest,
                                                                                          Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperActive 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:

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

waitUntilScraperDeleted

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperDeleted(DescribeScraperRequest describeScraperRequest)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilScraperDeleted

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperDeleted(Consumer<DescribeScraperRequest.Builder> describeScraperRequest)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted 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 DescribeScraperRequest.builder()

Parameters:

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

waitUntilScraperDeleted

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperDeleted(DescribeScraperRequest describeScraperRequest,
                                                                                           WaiterOverrideConfiguration overrideConfig)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilScraperDeleted

default CompletableFuture<WaiterResponse<DescribeScraperResponse>> waitUntilScraperDeleted(Consumer<DescribeScraperRequest.Builder> describeScraperRequest,
                                                                                           Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AmpAsyncClient.describeScraper(software.amazon.awssdk.services.amp.model.DescribeScraperRequest) API until the desired condition ScraperDeleted 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:

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

waitUntilWorkspaceActive

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceActive(DescribeWorkspaceRequest describeWorkspaceRequest)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilWorkspaceActive

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceActive(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive 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 DescribeWorkspaceRequest.builder()

Parameters:

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

waitUntilWorkspaceActive

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceActive(DescribeWorkspaceRequest describeWorkspaceRequest,
                                                                                              WaiterOverrideConfiguration overrideConfig)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilWorkspaceActive

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceActive(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest,
                                                                                              Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceActive 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:

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

waitUntilWorkspaceDeleted

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceDeleted(DescribeWorkspaceRequest describeWorkspaceRequest)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilWorkspaceDeleted

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceDeleted(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted 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 DescribeWorkspaceRequest.builder()

Parameters:

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

waitUntilWorkspaceDeleted

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceDeleted(DescribeWorkspaceRequest describeWorkspaceRequest,
                                                                                               WaiterOverrideConfiguration overrideConfig)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilWorkspaceDeleted

default CompletableFuture<WaiterResponse<DescribeWorkspaceResponse>> waitUntilWorkspaceDeleted(Consumer<DescribeWorkspaceRequest.Builder> describeWorkspaceRequest,
                                                                                               Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls AmpAsyncClient.describeWorkspace(software.amazon.awssdk.services.amp.model.DescribeWorkspaceRequest) API until the desired condition WorkspaceDeleted 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:

describeWorkspaceRequest - 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 AmpAsyncWaiter.Builder builder()

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

Returns:

a builder

create

static AmpAsyncWaiter create()

Create an instance of AmpAsyncWaiter with the default configuration.

A default AmpAsyncClient 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 AmpAsyncWaiter