software.amazon.awssdk.core.waiters

Interface Waiter<InputT>

All Known Implementing Classes:

WaiterImpl

public interface Waiter<InputT>

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.

Method Detail

run

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

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

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

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.

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