Interface AcquireInitialTokenRequest
-
- All Known Implementing Classes:
AcquireInitialTokenRequestImpl
@ThreadSafe public interface AcquireInitialTokenRequest
Encapsulates the abstract scope to start the attempts about to be executed using a retry strategy.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Modifier and Type Method Description static AcquireInitialTokenRequestcreate(String scope)Creates a newAcquireInitialTokenRequestinstance with the given scope.Stringscope()An abstract scope for the attempts about to be executed.
-
-
-
Method Detail
-
scope
String scope()
An abstract scope for the attempts about to be executed.A scope should be a unique string describing the smallest possible scope of failure for the attempts about to be executed. In practical terms, this is a key for the token bucket used to throttle request attempts. All attempts with the same scope share the same token bucket within the same
RetryStrategy, ensuring that token-bucket throttling for requests against one resource do not result in throttling for requests against other, unrelated resources.
-
create
static AcquireInitialTokenRequest create(String scope)
Creates a newAcquireInitialTokenRequestinstance with the given scope.
-
-