com.ibm.cos.v2.retries.internal

Class DefaultRetryToken.Builder

java.lang.Object

com.ibm.cos.v2.retries.internal.DefaultRetryToken.Builder

All Implemented Interfaces:

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

Enclosing class:

DefaultRetryToken

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

A builder class to create DefaultRetryToken instances or to mutate them.

Method Summary

Modifier and Type	Method and Description
DefaultRetryToken.Builder	addFailure(Throwable failure) Adds a Throwable to the retry-token.
DefaultRetryToken	build() Creates a new DefaultRetryToken with the configured values.
DefaultRetryToken.Builder	capacityAcquired(int capacityAcquired) Sets the capacity acquired from the token bucket.
DefaultRetryToken.Builder	capacityRemaining(int capacityRemaining) Sets the capacity remaining in the token bucket after the last acquire.
DefaultRetryToken.Builder	increaseAttempt() Increments the current attempt count.
DefaultRetryToken.Builder	scope(String scope) Sets the scope of the retry token.
DefaultRetryToken.Builder	state(DefaultRetryToken.TokenState state) Sets the state of the retry token.

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

scope

public DefaultRetryToken.Builder scope(String scope)

Sets the scope of the retry token.

state

public DefaultRetryToken.Builder state(DefaultRetryToken.TokenState state)

Sets the state of the retry token.

increaseAttempt

public DefaultRetryToken.Builder increaseAttempt()

Increments the current attempt count.

capacityAcquired

public DefaultRetryToken.Builder capacityAcquired(int capacityAcquired)

Sets the capacity acquired from the token bucket.

capacityRemaining

public DefaultRetryToken.Builder capacityRemaining(int capacityRemaining)

Sets the capacity remaining in the token bucket after the last acquire.

addFailure

public DefaultRetryToken.Builder addFailure(Throwable failure)

Adds a Throwable to the retry-token.

build

public DefaultRetryToken build()

Creates a new DefaultRetryToken with the configured values.

Specified by:

build in interface Buildable

Specified by:

build in interface SdkBuilder<DefaultRetryToken.Builder,DefaultRetryToken>

Returns:

an instance of T