Class SdkClientOption<T>
- java.lang.Object
-
- software.amazon.awssdk.utils.AttributeMap.Key<T>
-
- software.amazon.awssdk.core.client.config.ClientOption<T>
-
- software.amazon.awssdk.core.client.config.SdkClientOption<T>
-
public final class SdkClientOption<T> extends ClientOption<T>
A set of internal options required by the SDK viaSdkClientConfiguration
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class software.amazon.awssdk.utils.AttributeMap.Key
AttributeMap.Key.UnsafeValueType
-
-
Field Summary
Fields Modifier and Type Field Description static SdkClientOption<Map<String,List<String>>>
ADDITIONAL_HTTP_HEADERS
static SdkClientOption<Duration>
API_CALL_ATTEMPT_TIMEOUT
static SdkClientOption<Duration>
API_CALL_TIMEOUT
static SdkClientOption<SdkAsyncHttpClient>
ASYNC_HTTP_CLIENT
The asynchronous HTTP client implementation to make HTTP requests with.static SdkClientOption<AuthSchemeProvider>
AUTH_SCHEME_PROVIDER
TheAuthSchemeProvider
configured on the client.static SdkClientOption<Map<String,AuthScheme<?>>>
AUTH_SCHEMES
TheAuthScheme
s configured on the client.static SdkClientOption<AttributeMap>
CLIENT_CONTEXT_PARAMS
The container for any client contexts parameters set on the client.static SdkClientOption<ClientType>
CLIENT_TYPE
The type of client used to make requests.static SdkClientOption<String>
CLIENT_USER_AGENT
A user agent prefix that is specific to the client (agnostic of the request).static SdkClientOption<CompressionConfiguration>
COMPRESSION_CONFIGURATION
Option used by the rest of the SDK to read theCompressionConfiguration
.static SdkClientOption<SdkAsyncHttpClient>
CONFIGURED_ASYNC_HTTP_CLIENT
An asynchronous HTTP client set by the customer.static SdkClientOption<SdkAsyncHttpClient.Builder<?>>
CONFIGURED_ASYNC_HTTP_CLIENT_BUILDER
An asynchronous HTTP client builder set by the customer.static SdkClientOption<CompressionConfiguration>
CONFIGURED_COMPRESSION_CONFIGURATION
Configuration of the COMPRESSION_CONFIGURATION.static SdkClientOption<ScheduledExecutorService>
CONFIGURED_SCHEDULED_EXECUTOR_SERVICE
The internal SDK scheduled executor service that is set by the customer.static SdkClientOption<SdkHttpClient>
CONFIGURED_SYNC_HTTP_CLIENT
An HTTP client set by the customer.static SdkClientOption<SdkHttpClient.Builder<?>>
CONFIGURED_SYNC_HTTP_CLIENT_BUILDER
An HTTP client builder set by the customer.static SdkClientOption<Boolean>
CRC32_FROM_COMPRESSED_DATA_ENABLED
Whether to calculate the CRC 32 checksum of a message based on the uncompressed data.static SdkClientOption<RetryMode>
DEFAULT_RETRY_MODE
Option to specify the default retry mode.static SdkClientOption<URI>
ENDPOINT
The effective endpoint the client is configured to make requests to.static SdkClientOption<Boolean>
ENDPOINT_DISCOVERY_ENABLED
Whether or not endpoint discovery is enabled for this client.static SdkClientOption<Boolean>
ENDPOINT_OVERRIDDEN
A flag that when set to true indicates the endpoint stored inENDPOINT
was a customer supplied value and not generated by the client based on Region metadata.static SdkClientOption<EndpointProvider>
ENDPOINT_PROVIDER
TheEndpointProvider
configured on the client.static SdkClientOption<ExecutionAttributes>
EXECUTION_ATTRIBUTES
Option to specify additional execution attributes to each client call.static SdkClientOption<List<ExecutionInterceptor>>
EXECUTION_INTERCEPTORS
static SdkClientOption<AttributeMap>
HTTP_CLIENT_CONFIG
Configuration that should be used to build theSYNC_HTTP_CLIENT
orASYNC_HTTP_CLIENT
.static SdkClientOption<IdentityProviders>
IDENTITY_PROVIDERS
The IdentityProviders configured on the client.static SdkClientOption<String>
INTERNAL_USER_AGENT
Option to specify the internal user agent.static SdkClientOption<List<MetricPublisher>>
METRIC_PUBLISHERS
static SdkClientOption<ProfileFile>
PROFILE_FILE
Deprecated.This option was used to: - Read configuration options in profile files in aws-core, sdk-core - Build service configuration objects from profile files in codegen, s3control - Build service configuration objects from profile files, set endpoint options in s3 - Set retry mode in dynamodb, kinesis This has been replaced withPROFILE_FILE_SUPPLIER.get()
.static SdkClientOption<Supplier<ProfileFile>>
PROFILE_FILE_SUPPLIER
The profile file supplier to use for this client.static SdkClientOption<String>
PROFILE_NAME
The profile name to use for this client.static SdkClientOption<RetryPolicy>
RETRY_POLICY
static SdkClientOption<ScheduledExecutorService>
SCHEDULED_EXECUTOR_SERVICE
The internal SDK scheduled executor service that is used for scheduling tasks such as async retry attempts and timeout task.static SdkClientOption<SdkClient>
SDK_CLIENT
Option to specify a reference to the SDK client in use.static SdkClientOption<ServiceConfiguration>
SERVICE_CONFIGURATION
Service-specific configuration used by some services, like S3.static SdkClientOption<String>
SERVICE_NAME
Descriptive name for the service.static SdkClientOption<Boolean>
SIGNER_OVERRIDDEN
Option to specify if the default signer has been overridden on the client.static SdkClientOption<SdkHttpClient>
SYNC_HTTP_CLIENT
The HTTP client implementation to make HTTP requests with.
-
-
-
Field Detail
-
ADDITIONAL_HTTP_HEADERS
public static final SdkClientOption<Map<String,List<String>>> ADDITIONAL_HTTP_HEADERS
- See Also:
ClientOverrideConfiguration.headers()
-
RETRY_POLICY
public static final SdkClientOption<RetryPolicy> RETRY_POLICY
-
EXECUTION_INTERCEPTORS
public static final SdkClientOption<List<ExecutionInterceptor>> EXECUTION_INTERCEPTORS
-
ENDPOINT
public static final SdkClientOption<URI> ENDPOINT
The effective endpoint the client is configured to make requests to. If the client has been configured with an endpoint override then this value will be the provided endpoint value.
-
ENDPOINT_OVERRIDDEN
public static final SdkClientOption<Boolean> ENDPOINT_OVERRIDDEN
A flag that when set to true indicates the endpoint stored inENDPOINT
was a customer supplied value and not generated by the client based on Region metadata.
-
SERVICE_CONFIGURATION
public static final SdkClientOption<ServiceConfiguration> SERVICE_CONFIGURATION
Service-specific configuration used by some services, like S3.
-
CRC32_FROM_COMPRESSED_DATA_ENABLED
public static final SdkClientOption<Boolean> CRC32_FROM_COMPRESSED_DATA_ENABLED
Whether to calculate the CRC 32 checksum of a message based on the uncompressed data. By default, this is false.
-
SCHEDULED_EXECUTOR_SERVICE
public static final SdkClientOption<ScheduledExecutorService> SCHEDULED_EXECUTOR_SERVICE
The internal SDK scheduled executor service that is used for scheduling tasks such as async retry attempts and timeout task.
-
CONFIGURED_SCHEDULED_EXECUTOR_SERVICE
public static final SdkClientOption<ScheduledExecutorService> CONFIGURED_SCHEDULED_EXECUTOR_SERVICE
The internal SDK scheduled executor service that is set by the customer. This is likely only useful within configuration classes, and will be converted into aSCHEDULED_EXECUTOR_SERVICE
for the SDK's runtime.
-
ASYNC_HTTP_CLIENT
public static final SdkClientOption<SdkAsyncHttpClient> ASYNC_HTTP_CLIENT
The asynchronous HTTP client implementation to make HTTP requests with.
-
CONFIGURED_ASYNC_HTTP_CLIENT
public static final SdkClientOption<SdkAsyncHttpClient> CONFIGURED_ASYNC_HTTP_CLIENT
An asynchronous HTTP client set by the customer. This is likely only useful within configuration classes, and will be converted into aASYNC_HTTP_CLIENT
for the SDK's runtime.
-
CONFIGURED_ASYNC_HTTP_CLIENT_BUILDER
public static final SdkClientOption<SdkAsyncHttpClient.Builder<?>> CONFIGURED_ASYNC_HTTP_CLIENT_BUILDER
An asynchronous HTTP client builder set by the customer. This is likely only useful within configuration classes, and will be converted into aASYNC_HTTP_CLIENT
for the SDK's runtime.
-
SYNC_HTTP_CLIENT
public static final SdkClientOption<SdkHttpClient> SYNC_HTTP_CLIENT
The HTTP client implementation to make HTTP requests with.
-
CONFIGURED_SYNC_HTTP_CLIENT
public static final SdkClientOption<SdkHttpClient> CONFIGURED_SYNC_HTTP_CLIENT
An HTTP client set by the customer. This is likely only useful within configuration classes, and will be converted into aSYNC_HTTP_CLIENT
for the SDK's runtime.
-
CONFIGURED_SYNC_HTTP_CLIENT_BUILDER
public static final SdkClientOption<SdkHttpClient.Builder<?>> CONFIGURED_SYNC_HTTP_CLIENT_BUILDER
An HTTP client builder set by the customer. This is likely only useful within configuration classes, and will be converted into aSYNC_HTTP_CLIENT
for the SDK's runtime.
-
HTTP_CLIENT_CONFIG
public static final SdkClientOption<AttributeMap> HTTP_CLIENT_CONFIG
Configuration that should be used to build theSYNC_HTTP_CLIENT
orASYNC_HTTP_CLIENT
.
-
CLIENT_TYPE
public static final SdkClientOption<ClientType> CLIENT_TYPE
The type of client used to make requests.
-
API_CALL_ATTEMPT_TIMEOUT
public static final SdkClientOption<Duration> API_CALL_ATTEMPT_TIMEOUT
-
API_CALL_TIMEOUT
public static final SdkClientOption<Duration> API_CALL_TIMEOUT
-
SERVICE_NAME
public static final SdkClientOption<String> SERVICE_NAME
Descriptive name for the service. Used primarily for metrics and also in metadata like AwsErrorDetails.
-
ENDPOINT_DISCOVERY_ENABLED
public static final SdkClientOption<Boolean> ENDPOINT_DISCOVERY_ENABLED
Whether or not endpoint discovery is enabled for this client.
-
PROFILE_FILE
@Deprecated public static final SdkClientOption<ProfileFile> PROFILE_FILE
Deprecated.This option was used to: - Read configuration options in profile files in aws-core, sdk-core - Build service configuration objects from profile files in codegen, s3control - Build service configuration objects from profile files, set endpoint options in s3 - Set retry mode in dynamodb, kinesis This has been replaced withPROFILE_FILE_SUPPLIER.get()
.The profile file to use for this client.
-
PROFILE_FILE_SUPPLIER
public static final SdkClientOption<Supplier<ProfileFile>> PROFILE_FILE_SUPPLIER
The profile file supplier to use for this client.
-
PROFILE_NAME
public static final SdkClientOption<String> PROFILE_NAME
The profile name to use for this client.
-
METRIC_PUBLISHERS
public static final SdkClientOption<List<MetricPublisher>> METRIC_PUBLISHERS
-
SIGNER_OVERRIDDEN
public static final SdkClientOption<Boolean> SIGNER_OVERRIDDEN
Option to specify if the default signer has been overridden on the client.
-
EXECUTION_ATTRIBUTES
public static final SdkClientOption<ExecutionAttributes> EXECUTION_ATTRIBUTES
Option to specify additional execution attributes to each client call.
-
INTERNAL_USER_AGENT
public static final SdkClientOption<String> INTERNAL_USER_AGENT
Option to specify the internal user agent.
-
CLIENT_USER_AGENT
public static final SdkClientOption<String> CLIENT_USER_AGENT
A user agent prefix that is specific to the client (agnostic of the request).
-
DEFAULT_RETRY_MODE
public static final SdkClientOption<RetryMode> DEFAULT_RETRY_MODE
Option to specify the default retry mode.
-
ENDPOINT_PROVIDER
public static final SdkClientOption<EndpointProvider> ENDPOINT_PROVIDER
TheEndpointProvider
configured on the client.
-
AUTH_SCHEME_PROVIDER
public static final SdkClientOption<AuthSchemeProvider> AUTH_SCHEME_PROVIDER
TheAuthSchemeProvider
configured on the client.
-
AUTH_SCHEMES
public static final SdkClientOption<Map<String,AuthScheme<?>>> AUTH_SCHEMES
TheAuthScheme
s configured on the client.
-
IDENTITY_PROVIDERS
public static final SdkClientOption<IdentityProviders> IDENTITY_PROVIDERS
The IdentityProviders configured on the client.
-
CLIENT_CONTEXT_PARAMS
public static final SdkClientOption<AttributeMap> CLIENT_CONTEXT_PARAMS
The container for any client contexts parameters set on the client.
-
CONFIGURED_COMPRESSION_CONFIGURATION
public static final SdkClientOption<CompressionConfiguration> CONFIGURED_COMPRESSION_CONFIGURATION
Configuration of the COMPRESSION_CONFIGURATION. UnlikeCOMPRESSION_CONFIGURATION
, this may contain null values.
-
COMPRESSION_CONFIGURATION
public static final SdkClientOption<CompressionConfiguration> COMPRESSION_CONFIGURATION
Option used by the rest of the SDK to read theCompressionConfiguration
. This will never contain null values.
-
SDK_CLIENT
public static final SdkClientOption<SdkClient> SDK_CLIENT
Option to specify a reference to the SDK client in use.
-
-