SdkClientOption (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.utils.AttributeMap.Key<T>
- - com.ibm.cos.v2.core.client.config.ClientOption<T>
  - - com.ibm.cos.v2.core.client.config.SdkClientOption<T>

```
public final class SdkClientOption<T>
extends ClientOption<T>
```
A set of internal options required by the SDK via SdkClientConfiguration.

Nested Class Summary
- Nested classes/interfaces inherited from class com.ibm.cos.v2.utils.AttributeMap.Key
  AttributeMap.Key.UnsafeValueType

Field Summary

Fields
Modifier and Type	Field and 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` The `AuthSchemeProvider` configured on the client.
`static SdkClientOption<Map<String,AuthScheme<?>>>`	`AUTH_SCHEMES` The `AuthScheme`s configured on the client.
`static SdkClientOption<BusinessMetricCollection>`	`BUSINESS_METRICS` A user agent prefix that is specific to the client (agnostic of the request).
`static SdkClientOption<AttributeMap>`	`CLIENT_CONTEXT_PARAMS` The container for any client contexts parameters set on the client.
`static SdkClientOption<ClientEndpointProvider>`	`CLIENT_ENDPOINT_PROVIDER` A provider for the client-level endpoint configuration.
`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 the `CompressionConfiguration`.
`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<Consumer<RetryStrategy.Builder<?,?>>>`	`CONFIGURED_RETRY_CONFIGURATOR` The retry strategy builder consumer set by the customer using `ClientOverrideConfiguration.Builder#retryStrategy(Consumer)`.
`static SdkClientOption<RetryMode>`	`CONFIGURED_RETRY_MODE` The retry mode set by the customer using `ClientOverrideConfiguration.Builder.retryStrategy(RetryMode)`.
`static SdkClientOption<RetryStrategy>`	`CONFIGURED_RETRY_STRATEGY` The retry strategy set by the customer using `ClientOverrideConfiguration.Builder.retryStrategy(RetryStrategy)`.
`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` Deprecated. Use `CLIENT_ENDPOINT_PROVIDER` for client-level endpoint configuration, or `ENDPOINT_PROVIDER` for deriving the request-level endpoint.
`static SdkClientOption<Boolean>`	`ENDPOINT_DISCOVERY_ENABLED` Whether or not endpoint discovery is enabled for this client.
`static SdkClientOption<Boolean>`	`ENDPOINT_OVERRIDDEN` Deprecated. Use `CLIENT_ENDPOINT_PROVIDER`'s `ClientEndpointProvider.isEndpointOverridden()`.
`static SdkClientOption<EndpointProvider>`	`ENDPOINT_PROVIDER` The `EndpointProvider` 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 the `SYNC_HTTP_CLIENT` or `ASYNC_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 with `PROFILE_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<RequestChecksumCalculation>`	`REQUEST_CHECKSUM_CALCULATION` The request checksum calculation setting.
`static SdkClientOption<ResponseChecksumValidation>`	`RESPONSE_CHECKSUM_VALIDATION` The response checksum validation setting.
`static SdkClientOption<RetryPolicy>`	`RETRY_POLICY`
`static SdkClientOption<RetryStrategy>`	`RETRY_STRATEGY`
`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.
`static SdkClientOption<String>`	`USER_AGENT_APP_ID` An optional identification value to be appended to the user agent header.

Method Summary
- Methods inherited from class com.ibm.cos.v2.utils.AttributeMap.Key
  convertValue, toString
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 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
```
    See Also:
    
    ClientOverrideConfiguration.retryPolicy()
  - RETRY_STRATEGY
```
public static final SdkClientOption<RetryStrategy> RETRY_STRATEGY
```
    See Also:
    
    ClientOverrideConfiguration.retryStrategy()
  - CONFIGURED_RETRY_STRATEGY
```
public static final SdkClientOption<RetryStrategy> CONFIGURED_RETRY_STRATEGY
```
    The retry strategy set by the customer using ClientOverrideConfiguration.Builder.retryStrategy(RetryStrategy). This is likely only useful within configuration classes, and will be converted into a RETRY_STRATEGY for the SDK's runtime.
    
    See Also:
    
    ClientOverrideConfiguration.retryMode()
  - CONFIGURED_RETRY_MODE
```
public static final SdkClientOption<RetryMode> CONFIGURED_RETRY_MODE
```
    The retry mode set by the customer using ClientOverrideConfiguration.Builder.retryStrategy(RetryMode). This is likely only useful within configuration classes, and will be converted into a RETRY_STRATEGY for the SDK's runtime.
    
    See Also:
    
    ClientOverrideConfiguration.retryMode()
  - CONFIGURED_RETRY_CONFIGURATOR
```
public static final SdkClientOption<Consumer<RetryStrategy.Builder<?,?>>> CONFIGURED_RETRY_CONFIGURATOR
```
    The retry strategy builder consumer set by the customer using ClientOverrideConfiguration.Builder#retryStrategy(Consumer). This is likely only useful within configuration classes, and will be converted into a RETRY_STRATEGY for the SDK's runtime.
    
    See Also:
    
    ClientOverrideConfiguration.retryStrategy()
  - EXECUTION_INTERCEPTORS
```
public static final SdkClientOption<List<ExecutionInterceptor>> EXECUTION_INTERCEPTORS
```
    See Also:
    
    ClientOverrideConfiguration.executionInterceptors()
  - ENDPOINT
```
@Deprecated
public static final SdkClientOption<URI> ENDPOINT
```
    Deprecated. Use CLIENT_ENDPOINT_PROVIDER for client-level endpoint configuration, or ENDPOINT_PROVIDER for deriving the request-level 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
```
@Deprecated
public static final SdkClientOption<Boolean> ENDPOINT_OVERRIDDEN
```
    Deprecated. Use CLIENT_ENDPOINT_PROVIDER's ClientEndpointProvider.isEndpointOverridden().
    
    A flag that when set to true indicates the endpoint stored in ENDPOINT was a customer supplied value and not generated by the client based on Region metadata.
  - CLIENT_ENDPOINT_PROVIDER
```
public static final SdkClientOption<ClientEndpointProvider> CLIENT_ENDPOINT_PROVIDER
```
    A provider for the client-level endpoint configuration. This includes the default endpoint determined by the endpoint metadata or endpoint overrides specified by the customer.
    ENDPOINT_PROVIDER determines the request-level endpoint configuration.
  - 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 a SCHEDULED_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 a ASYNC_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 a ASYNC_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 a SYNC_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 a SYNC_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 the SYNC_HTTP_CLIENT or ASYNC_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
```
    See Also:
    
    ClientOverrideConfiguration.apiCallAttemptTimeout()
  - API_CALL_TIMEOUT
```
public static final SdkClientOption<Duration> API_CALL_TIMEOUT
```
    See Also:
    
    ClientOverrideConfiguration.apiCallTimeout()
  - 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 with PROFILE_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). Not currently in use, since the introduction of SdkClientUserAgentProperties
  - BUSINESS_METRICS
```
public static final SdkClientOption<BusinessMetricCollection> BUSINESS_METRICS
```
    A user agent prefix that is specific to the client (agnostic of the request). Not currently in use, since the introduction of SdkClientUserAgentProperties
  - DEFAULT_RETRY_MODE
```
public static final SdkClientOption<RetryMode> DEFAULT_RETRY_MODE
```
    Option to specify the default retry mode.
    
    See Also:
    
    RetryMode.Resolver#defaultRetryMode(RetryMode)
  - ENDPOINT_PROVIDER
```
public static final SdkClientOption<EndpointProvider> ENDPOINT_PROVIDER
```
    The EndpointProvider configured on the client.
  - AUTH_SCHEME_PROVIDER
```
public static final SdkClientOption<AuthSchemeProvider> AUTH_SCHEME_PROVIDER
```
    The AuthSchemeProvider configured on the client.
  - AUTH_SCHEMES
```
public static final SdkClientOption<Map<String,AuthScheme<?>>> AUTH_SCHEMES
```
    The AuthSchemes 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. Unlike COMPRESSION_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 the CompressionConfiguration. This will never contain null values.
  - REQUEST_CHECKSUM_CALCULATION
```
public static final SdkClientOption<RequestChecksumCalculation> REQUEST_CHECKSUM_CALCULATION
```
    The request checksum calculation setting. The default value is WHEN_SUPPORTED.
  - RESPONSE_CHECKSUM_VALIDATION
```
public static final SdkClientOption<ResponseChecksumValidation> RESPONSE_CHECKSUM_VALIDATION
```
    The response checksum validation setting. The default value is WHEN_SUPPORTED.
  - USER_AGENT_APP_ID
```
public static final SdkClientOption<String> USER_AGENT_APP_ID
```
    An optional identification value to be appended to the user agent header. The value should be less than 50 characters in length and is null by default.
    Users can additionally supply the appId value through environment and JVM settings, and it will be resolved using the following order of precedence (highest first):
    1. This client option configuration
    2. The AWS_SDK_UA_APP_ID environment variable
    3. The sdk.ua.appId JVM system property
    4. The sdk_ua_app_id setting in the profile file for the active profile
    This configuration option supersedes SdkAdvancedClientOption.USER_AGENT_PREFIX and SdkAdvancedClientOption.USER_AGENT_SUFFIX and should be used instead of those options.
  - SDK_CLIENT
```
public static final SdkClientOption<SdkClient> SDK_CLIENT
```
    Option to specify a reference to the SDK client in use.

Class SdkClientOption<T>

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.cos.v2.utils.AttributeMap.Key

Field Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.utils.AttributeMap.Key

Methods inherited from class java.lang.Object

Field Detail

ADDITIONAL_HTTP_HEADERS

RETRY_POLICY

RETRY_STRATEGY

CONFIGURED_RETRY_STRATEGY

CONFIGURED_RETRY_MODE

CONFIGURED_RETRY_CONFIGURATOR

EXECUTION_INTERCEPTORS

ENDPOINT

ENDPOINT_OVERRIDDEN

CLIENT_ENDPOINT_PROVIDER

SERVICE_CONFIGURATION

CRC32_FROM_COMPRESSED_DATA_ENABLED

SCHEDULED_EXECUTOR_SERVICE

CONFIGURED_SCHEDULED_EXECUTOR_SERVICE

ASYNC_HTTP_CLIENT

CONFIGURED_ASYNC_HTTP_CLIENT

CONFIGURED_ASYNC_HTTP_CLIENT_BUILDER

SYNC_HTTP_CLIENT

CONFIGURED_SYNC_HTTP_CLIENT

CONFIGURED_SYNC_HTTP_CLIENT_BUILDER

HTTP_CLIENT_CONFIG

CLIENT_TYPE

API_CALL_ATTEMPT_TIMEOUT

API_CALL_TIMEOUT

SERVICE_NAME

ENDPOINT_DISCOVERY_ENABLED

PROFILE_FILE

PROFILE_FILE_SUPPLIER

PROFILE_NAME

METRIC_PUBLISHERS

SIGNER_OVERRIDDEN

EXECUTION_ATTRIBUTES

INTERNAL_USER_AGENT

CLIENT_USER_AGENT

BUSINESS_METRICS

DEFAULT_RETRY_MODE

ENDPOINT_PROVIDER

AUTH_SCHEME_PROVIDER

AUTH_SCHEMES

IDENTITY_PROVIDERS

CLIENT_CONTEXT_PARAMS

CONFIGURED_COMPRESSION_CONFIGURATION

COMPRESSION_CONFIGURATION

REQUEST_CHECKSUM_CALCULATION

RESPONSE_CHECKSUM_VALIDATION

USER_AGENT_APP_ID

SDK_CLIENT