software.amazon.awssdk.core.waiters

Class WaiterImpl<InputT,OutputT,ErrorT extends RuntimeException>

java.lang.Object

software.amazon.awssdk.core.waiters.WaiterImpl<InputT,OutputT,ErrorT>

All Implemented Interfaces:

Waiter<InputT>

public class WaiterImpl<InputT,OutputT,ErrorT extends RuntimeException>
extends Object
implements Waiter<InputT>

Constructor Summary

Constructors

Constructor and Description
WaiterImpl(WaiterBuilder<InputT,OutputT,ErrorT> waiterBuilder) Constructs a new waiter with the given internal parameters

Method Summary

Modifier and Type	Method and Description
void	run(WaiterParameters<InputT> waiterParameters) Polls synchronously until it is determined that the resource transitioned into the desired state or not.
Future<Void>	runAsync(WaiterParameters<InputT> waiterParameters, WaiterHandler callback) Polls asynchronously until it is determined that the resource transitioned into the desired state or not.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WaiterImpl

public WaiterImpl(WaiterBuilder<InputT,OutputT,ErrorT> waiterBuilder)

Constructs a new waiter with the given internal parameters

Parameters:

waiterBuilder - Takes in default parameters and builds a basic waiter. Excludes request and custom polling strategy parameters.

Method Detail

run

public void run(WaiterParameters<InputT> waiterParameters)
         throws WaiterTimedOutException,
                WaiterUnrecoverableException

Polls synchronously until it is determined that the resource transitioned into the desired state or not.

Specified by:

run in interface Waiter<InputT>

Parameters:

waiterParameters - Custom provided parameters. Includes request and optional custom polling strategy

Throws:

WaiterUnrecoverableException - If the resource transitions into a failure/unexpected state.

WaiterTimedOutException - If the resource doesn't transition into the desired state even after a certain number of retries.

runAsync

public Future<Void> runAsync(WaiterParameters<InputT> waiterParameters,
                             WaiterHandler callback)
                      throws WaiterTimedOutException,
                             WaiterUnrecoverableException

Polls asynchronously until it is determined that the resource transitioned into the desired state or not. Includes additional callback.

Specified by:

runAsync in interface Waiter<InputT>

Parameters:

waiterParameters - Custom provided parameters. Includes request and optional custom polling strategy

callback - Custom callback

Returns:

Future object that holds the result of an asynchronous computation of waiter

Throws:

WaiterTimedOutException

WaiterUnrecoverableException