com.ibm.cos.v2.retries.internal.circuitbreaker

Class AcquireResponse

java.lang.Object

com.ibm.cos.v2.retries.internal.circuitbreaker.AcquireResponse

All Implemented Interfaces:

ToCopyableBuilder<AcquireResponse.Builder,AcquireResponse>

public final class AcquireResponse
extends Object
implements ToCopyableBuilder<AcquireResponse.Builder,AcquireResponse>

The number of tokens in the token bucket after a specific token acquisition succeeds.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AcquireResponse.Builder

Method Summary

Modifier and Type	Method and Description
boolean	acquisitionFailed() Returns true if the requested capacity was not successfully acquired.
static AcquireResponse.Builder	builder()
int	capacityAcquired() The number of tokens acquired by the last token acquisition.
int	capacityRemaining() The number of tokens in the token bucket.
int	capacityRequested() The numbers of token requested by the last token acquisition.
int	maxCapacity() The max capacity.
AcquireResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.

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.ToCopyableBuilder

copy

Method Detail

builder

public static AcquireResponse.Builder builder()

maxCapacity

public int maxCapacity()

The max capacity.

capacityRequested

public int capacityRequested()

The numbers of token requested by the last token acquisition.

capacityAcquired

public int capacityAcquired()

The number of tokens acquired by the last token acquisition.

capacityRemaining

public int capacityRemaining()

The number of tokens in the token bucket.

acquisitionFailed

public boolean acquisitionFailed()

Returns true if the requested capacity was not successfully acquired.

toBuilder

public AcquireResponse.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AcquireResponse.Builder,AcquireResponse>

Returns:

a builder for type T