software.amazon.awssdk.retries.api.AcquireInitialTokenRequest Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package software.amazon.awssdk.retries.api;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.retries.api.internal.AcquireInitialTokenRequestImpl;
/**
* Encapsulates the abstract scope to start the attempts about to be executed using a retry strategy.
*/
@SdkPublicApi
@ThreadSafe
public interface AcquireInitialTokenRequest {
/**
* 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 {@link RetryStrategy}, ensuring that token-bucket throttling for
* requests against one resource do not result in throttling for requests against other, unrelated resources.
*/
String scope();
/**
* Creates a new {@link AcquireInitialTokenRequest} instance with the given scope.
*/
static AcquireInitialTokenRequest create(String scope) {
return AcquireInitialTokenRequestImpl.create(scope);
}
}