Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	BmcGenericWaiter.WaitConditionFailedException Exception indicating the the condition being waited on was not met before the termination condition was satisfied.

Modifier and Type	Field and Description
private static final Logger	LOG
private final GenericWaiter	waiter

Constructor Summary

Access	Constructor and Description
public	BmcGenericWaiter(TerminationStrategy The termination strategy to use. terminationStrategy, DelayStrategy The delay strategy to use. delayStrategy) Creates a new waiter with the given strategies.

Method Summary

Modifier and Type Method and Description

Modifier and Type	Method and Description
public < Request object class REQUEST, Response object class RESPONSE> RESPONSE	Returns: The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed). execute(Supplier<REQUEST> Supplier that provides a new request instance to fetch the current state. requestSupplier, Function<REQUEST, RESPONSE> Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier. functionCall, Predicate<RESPONSE> The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting. terminationPredicate, boolean True to allow 404 responses to be accepted (ex, for termination conditions). allow404) Blocks until a specific condition is met.
public < Request object class REQUEST, Response object class RESPONSE> Callable<RESPONSE>	Returns: The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed). toCallable(final Supplier<REQUEST> Supplier that provides a new request instance to fetch the current state. requestSupplier, final Function<REQUEST, RESPONSE> Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier. functionCall, final Predicate<RESPONSE> The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting. terminationPredicate, final boolean True to allow 404 responses to be accepted (ex, for termination conditions). allow404) Same as `execute(Supplier, Function, Predicate, boolean)` except it returns a `Callable` that can be invoked later.

public <

Request object class

REQUEST,

Response object class

RESPONSE> RESPONSE

Returns:

The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed).

execute(Supplier<REQUEST>

Supplier that provides a new request instance to fetch the current state.

requestSupplier, Function<REQUEST, RESPONSE>

Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier.

functionCall, Predicate<RESPONSE>

The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting.

terminationPredicate, boolean

True to allow 404 responses to be accepted (ex, for termination conditions).

allow404)

Blocks until a specific condition is met.

public <

Request object class

REQUEST,

Response object class

RESPONSE> Callable<RESPONSE>

Returns:

The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed).

toCallable(final Supplier<REQUEST>

Supplier that provides a new request instance to fetch the current state.

requestSupplier, final Function<REQUEST, RESPONSE>

Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier.

functionCall, final Predicate<RESPONSE>

The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting.

terminationPredicate, final boolean

True to allow 404 responses to be accepted (ex, for termination conditions).

allow404)

Same as execute(Supplier, Function, Predicate, boolean) except it returns a Callable that can be invoked later.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

LOG	back to summary
private static final Logger LOG

waiter	back to summary
private final GenericWaiter waiter

Constructor Detail

BmcGenericWaiter	back to summary
public BmcGenericWaiter(TerminationStrategy terminationStrategy, DelayStrategy delayStrategy) Creates a new waiter with the given strategies. Parameters terminationStrategy:TerminationStrategy The termination strategy to use. delayStrategy:DelayStrategy The delay strategy to use.

BmcGenericWaiter

back to summary

public BmcGenericWaiter(TerminationStrategy terminationStrategy, DelayStrategy delayStrategy)

Creates a new waiter with the given strategies.

Parameters

terminationStrategy:TerminationStrategy: The termination strategy to use.
delayStrategy:DelayStrategy: The delay strategy to use.

Method Detail

execute back to summary

execute	back to summary
public <REQUEST, RESPONSE> RESPONSE execute(Supplier<REQUEST> requestSupplier, Function<REQUEST, RESPONSE> functionCall, Predicate<RESPONSE> terminationPredicate, boolean allow404) throws WaitConditionFailedException Blocks until a specific condition is met. If the `allow404` param is set to true, the waiter will return null if the request fails with a 404 exception. Parameters <REQUEST> Request object class <RESPONSE> Response object class requestSupplier:Supplier<REQUEST> Supplier that provides a new request instance to fetch the current state. functionCall:Function<REQUEST, RESPONSE> Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier. terminationPredicate:Predicate<RESPONSE> The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting. allow404:boolean True to allow 404 responses to be accepted (ex, for termination conditions). Returns:RESPONSE The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed). Exceptions WaitConditionFailedException: If the termination condition was not met.

public <REQUEST, RESPONSE> RESPONSE execute(Supplier<REQUEST> requestSupplier, Function<REQUEST, RESPONSE> functionCall, Predicate<RESPONSE> terminationPredicate, boolean allow404) throws WaitConditionFailedException

Blocks until a specific condition is met.

If the allow404 param is set to true, the waiter will return null if the request fails with a 404 exception.

Parameters

<REQUEST>: Request object class
<RESPONSE>: Response object class
requestSupplier:Supplier<REQUEST>: Supplier that provides a new request instance to fetch the current state.
functionCall:Function<REQUEST, RESPONSE>: Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier.
terminationPredicate:Predicate<RESPONSE>: The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting.
allow404:boolean: True to allow 404 responses to be accepted (ex, for termination conditions).

Returns:RESPONSE

The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed).

Exceptions

WaitConditionFailedException:: If the termination condition was not met.

toCallable back to summary

toCallable	back to summary
public <REQUEST, RESPONSE> Callable<RESPONSE> toCallable(final Supplier<REQUEST> requestSupplier, final Function<REQUEST, RESPONSE> functionCall, final Predicate<RESPONSE> terminationPredicate, final boolean allow404) Same as `execute(Supplier, Function, Predicate, boolean)` except it returns a `Callable` that can be invoked later. Parameters <REQUEST> Request object class <RESPONSE> Response object class requestSupplier:Supplier<REQUEST> Supplier that provides a new request instance to fetch the current state. functionCall:Function<REQUEST, RESPONSE> Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier. terminationPredicate:Predicate<RESPONSE> The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting. allow404:boolean True to allow 404 responses to be accepted (ex, for termination conditions). Returns:Callable<RESPONSE> The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed). A new Callable instance.

public <REQUEST, RESPONSE> Callable<RESPONSE> toCallable(final Supplier<REQUEST> requestSupplier, final Function<REQUEST, RESPONSE> functionCall, final Predicate<RESPONSE> terminationPredicate, final boolean allow404)

Same as execute(Supplier, Function, Predicate, boolean) except it returns a Callable that can be invoked later.

Parameters

<REQUEST>: Request object class
<RESPONSE>: Response object class
requestSupplier:Supplier<REQUEST>: Supplier that provides a new request instance to fetch the current state.
functionCall:Function<REQUEST, RESPONSE>: Function that will be invoked to fetch the current state. It will be provided the request instance given by the requestSupplier.
terminationPredicate:Predicate<RESPONSE>: The termination predicate that will inspect the current state (returned response instance) to determine if it is done waiting.
allow404:boolean: True to allow 404 responses to be accepted (ex, for termination conditions).

Returns:Callable<RESPONSE>

The last response object that was received and was accepted by the termination predicate (or null if 404 was allowed).
A new Callable instance.

com.oracle.bmc.waiter back to summary

public final Class BmcGenericWaiter.WaitConditionFailedException

Class Inheritance

extends Exception

java.lang.Object
java.lang.Throwable
java.lang.Exception
com.oracle.bmc.waiter.BmcGenericWaiter.WaitConditionFailedException

Exception indicating the the condition being waited on was not met before the termination condition was satisfied.

Constructor Summary

Access	Constructor and Description
private	WaitConditionFailedException(String message)

Constructor Detail

WaitConditionFailedException	back to summary
private WaitConditionFailedException(String message)

public Class BmcGenericWaiter

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public final Class BmcGenericWaiter.WaitConditionFailedException

Constructor Summary

Constructor Detail