DefaultRetryToken (AWS Java SDK :: Retries 2.37.3 API)

java.lang.Object
- software.amazon.awssdk.retries.internal.DefaultRetryToken

All Implemented Interfaces:

RetryToken, ToCopyableBuilder<DefaultRetryToken.Builder,DefaultRetryToken>
```
@SdkInternalApi
public final class DefaultRetryToken
extends Object
implements RetryToken, ToCopyableBuilder<DefaultRetryToken.Builder,DefaultRetryToken>
```
A data rich RetryToken implementation. The data contained in this class is not part of the interface but is needed for the calling code to test and generate meaningful logs using its current state.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`DefaultRetryToken.Builder`	A builder class to create `DefaultRetryToken` instances or to mutate them.
`static class`	`DefaultRetryToken.TokenState`	Set of possibles states on which the RetryToken can be, in-progress, succeeded and all the possible failure modes.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`attempt()`	Returns the latest attempt count.
`static DefaultRetryToken.Builder`	`builder()`	Returns a new builder to create new instances of the `DefaultRetryToken` class.
`int`	`capacityAcquired()`	Returns the latest capacity acquired from the token bucket.
`int`	`capacityRemaining()`	Returns the capacity remaining in the token bucket when the last acquire request was done.
`String`	`scope()`	Returns the token scope.
`DefaultRetryToken.TokenState`	`state()`	Returns the state of the token.
`DefaultRetryToken.Builder`	`toBuilder()`	Creates a new builder to mutate the current instance.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - attempt
```
public int attempt()
```
    Returns the latest attempt count.
  - scope
```
public String scope()
```
    Returns the token scope.
  - capacityAcquired
```
public int capacityAcquired()
```
    Returns the latest capacity acquired from the token bucket.
  - capacityRemaining
```
public int capacityRemaining()
```
    Returns the capacity remaining in the token bucket when the last acquire request was done.
  - state
```
public DefaultRetryToken.TokenState state()
```
    Returns the state of the token.
  - toBuilder
```
public DefaultRetryToken.Builder toBuilder()
```
    Creates a new builder to mutate the current instance.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DefaultRetryToken.Builder,DefaultRetryToken>
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - builder
```
public static DefaultRetryToken.Builder builder()
```
    Returns a new builder to create new instances of the DefaultRetryToken class.