com.ibm.cloud.objectstorage.waiters

Class WaiterExecution<Input extends AmazonWebServiceRequest,Output>

java.lang.Object

com.ibm.cloud.objectstorage.waiters.WaiterExecution<Input,Output>

public class WaiterExecution<Input extends AmazonWebServiceRequest,Output>
extends Object

Constructor Summary

Constructors

Constructor and Description
WaiterExecution(WaiterExecutionBuilder<Input,Output> waiterExecutionBuilder) Constructs a new waiter with all the parameters defined in the WaiterExecutionBuilder

Method Summary

Modifier and Type	Method and Description
boolean	pollResource() Polls until a specified resource transitions into either success or failure state or until the specified number of retries has been made.

Methods inherited from class java.lang.Object

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

Constructor Detail

WaiterExecution

public WaiterExecution(WaiterExecutionBuilder<Input,Output> waiterExecutionBuilder)

Constructs a new waiter with all the parameters defined in the WaiterExecutionBuilder

Parameters:

waiterExecutionBuilder - Contains all the parameters required to construct a new waiter

Method Detail

pollResource

public boolean pollResource()
                     throws AmazonServiceException,
                            WaiterTimedOutException,
                            WaiterUnrecoverableException

Polls until a specified resource transitions into either success or failure state or until the specified number of retries has been made.

Returns:

True if the resource transitions into desired state.

Throws:

AmazonServiceException - If the service exception thrown doesn't match any of the expected exceptions, it's re-thrown.

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.