com.ibm.cos.v2.core.waiters

Class WaiterOverrideConfiguration.Builder

java.lang.Object

com.ibm.cos.v2.core.waiters.WaiterOverrideConfiguration.Builder

All Implemented Interfaces:

Buildable, CopyableBuilder<WaiterOverrideConfiguration.Builder,WaiterOverrideConfiguration>, SdkBuilder<WaiterOverrideConfiguration.Builder,WaiterOverrideConfiguration>

Enclosing class:

WaiterOverrideConfiguration

public static final class WaiterOverrideConfiguration.Builder
extends Object
implements CopyableBuilder<WaiterOverrideConfiguration.Builder,WaiterOverrideConfiguration>

Method Summary

Modifier and Type	Method and Description
WaiterOverrideConfiguration.Builder	backoffStrategy(BackoffStrategy backoffStrategy) Deprecated. Use instead backoffStrategyV2(BackoffStrategy)
WaiterOverrideConfiguration.Builder	backoffStrategyV2(BackoffStrategy backoffStrategy) Define the BackoffStrategy that computes the delay between resource polling.
WaiterOverrideConfiguration	build() An immutable object that is created from the properties that have been set on the builder.
WaiterOverrideConfiguration.Builder	maxAttempts(Integer maxAttempts) Define the maximum number of attempts to try before transitioning the waiter to a failure state.
WaiterOverrideConfiguration.Builder	waitTimeout(Duration waitTimeout) Define the amount of time to wait for the resource to transition to the desired state before timing out.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation

Method Detail

backoffStrategy

public WaiterOverrideConfiguration.Builder backoffStrategy(BackoffStrategy backoffStrategy)

Deprecated. Use instead backoffStrategyV2(BackoffStrategy)

Define the BackoffStrategy that computes the delay between resource polling. Only one of WaiterOverrideConfiguration.backoffStrategy() and WaiterOverrideConfiguration.backoffStrategyV2() may be defined.

Parameters:

backoffStrategy - The new backoffStrategy value.

Returns:

This object for method chaining.

backoffStrategyV2

public WaiterOverrideConfiguration.Builder backoffStrategyV2(BackoffStrategy backoffStrategy)

Define the BackoffStrategy that computes the delay between resource polling. Only one of WaiterOverrideConfiguration.backoffStrategy() and WaiterOverrideConfiguration.backoffStrategyV2() may be defined.

Parameters:

backoffStrategy - The new backoffStrategy value.

Returns:

This object for method chaining.

maxAttempts

public WaiterOverrideConfiguration.Builder maxAttempts(Integer maxAttempts)

Define the maximum number of attempts to try before transitioning the waiter to a failure state.

Parameters:

maxAttempts - The new maxAttempts value.

Returns:

This object for method chaining.

waitTimeout

public WaiterOverrideConfiguration.Builder waitTimeout(Duration waitTimeout)

Define the amount of time to wait for the resource to transition to the desired state before timing out. This wait timeout doesn't have strict guarantees on how quickly a request is aborted when the timeout is breached. The request can timeout early if it is determined that the next retry will breach the max wait time. It's disabled by default.

Parameters:

waitTimeout - The new waitTimeout value.

Returns:

This object for method chaining.

build

public WaiterOverrideConfiguration build()

Description copied from interface: SdkBuilder

An immutable object that is created from the properties that have been set on the builder.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<WaiterOverrideConfiguration.Builder,WaiterOverrideConfiguration>

Returns:

an instance of T