Interface EndUserMessagingWaiter

All Superinterfaces:

AutoCloseable, SdkAutoCloseable

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

Method Summary

Modifier and Type	Method	Description
static EndUserMessagingWaiter.Builder	builder()	Create a builder that can be used to configure and create a EndUserMessagingWaiter.
static EndUserMessagingWaiter	create()	Create an instance of EndUserMessagingWaiter with the default configuration.
default WaiterResponse<GetBrandProfileResponse>	waitUntilBrandProfileActive(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest)	Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetBrandProfileResponse>	waitUntilBrandProfileActive(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetBrandProfileResponse>	waitUntilBrandProfileActive(GetBrandProfileRequest getBrandProfileRequest)	Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetBrandProfileResponse>	waitUntilBrandProfileActive(GetBrandProfileRequest getBrandProfileRequest, WaiterOverrideConfiguration overrideConfig)	Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetJobResponse>	waitUntilJobSuccess(Consumer<GetJobRequest.Builder> getJobRequest)	Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetJobResponse>	waitUntilJobSuccess(Consumer<GetJobRequest.Builder> getJobRequest, Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)	Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess is met, or until it is determined that the resource will never enter into the desired state.
default WaiterResponse<GetJobResponse>	waitUntilJobSuccess(GetJobRequest getJobRequest)	Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess is met, or until it is determined that the resource will never enter into the desired state
default WaiterResponse<GetJobResponse>	waitUntilJobSuccess(GetJobRequest getJobRequest, WaiterOverrideConfiguration overrideConfig)	Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess 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

waitUntilBrandProfileActive

default WaiterResponse<GetBrandProfileResponse> waitUntilBrandProfileActive(GetBrandProfileRequest getBrandProfileRequest)

Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getBrandProfileRequest - the request to be used for polling

Returns:

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

waitUntilBrandProfileActive

default WaiterResponse<GetBrandProfileResponse> waitUntilBrandProfileActive(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest)

Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive 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 GetBrandProfileRequest.builder()

Parameters:

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

waitUntilBrandProfileActive

default WaiterResponse<GetBrandProfileResponse> waitUntilBrandProfileActive(GetBrandProfileRequest getBrandProfileRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilBrandProfileActive

default WaiterResponse<GetBrandProfileResponse> waitUntilBrandProfileActive(Consumer<GetBrandProfileRequest.Builder> getBrandProfileRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EndUserMessagingClient.getBrandProfile(software.amazon.awssdk.services.endusermessaging.model.GetBrandProfileRequest) API until the desired condition BrandProfileActive 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:

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

waitUntilJobSuccess

default WaiterResponse<GetJobResponse> waitUntilJobSuccess(GetJobRequest getJobRequest)

Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess is met, or until it is determined that the resource will never enter into the desired state

Parameters:

getJobRequest - the request to be used for polling

Returns:

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

waitUntilJobSuccess

default WaiterResponse<GetJobResponse> waitUntilJobSuccess(Consumer<GetJobRequest.Builder> getJobRequest)

Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess 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 GetJobRequest.builder()

Parameters:

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

waitUntilJobSuccess

default WaiterResponse<GetJobResponse> waitUntilJobSuccess(GetJobRequest getJobRequest,
 WaiterOverrideConfiguration overrideConfig)

Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess is met, or until it is determined that the resource will never enter into the desired state

Parameters:

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

waitUntilJobSuccess

default WaiterResponse<GetJobResponse> waitUntilJobSuccess(Consumer<GetJobRequest.Builder> getJobRequest,
 Consumer<WaiterOverrideConfiguration.Builder> overrideConfig)

Polls EndUserMessagingClient.getJob(software.amazon.awssdk.services.endusermessaging.model.GetJobRequest) API until the desired condition JobSuccess 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:

getJobRequest - 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 EndUserMessagingWaiter.Builder builder()

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

Returns:

a builder

create

static EndUserMessagingWaiter create()

Create an instance of EndUserMessagingWaiter with the default configuration.

A default EndUserMessagingClient 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 EndUserMessagingWaiter