com.ibm.cos.v2.core.interceptor

Class SdkInternalExecutionAttribute

java.lang.Object

com.ibm.cos.v2.core.interceptor.SdkExecutionAttribute

com.ibm.cos.v2.core.interceptor.SdkInternalExecutionAttribute

public final class SdkInternalExecutionAttribute
extends SdkExecutionAttribute

Attributes that can be applied to all sdk requests. Only generated code from the SDK clients should set these values.

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionAttribute<Long>	API_CALL_ATTEMPT_START_NANO_TIME The nano time that the current API call attempt began.
static ExecutionAttribute<AuthSchemeProvider>	AUTH_SCHEME_RESOLVER The auth scheme provider used to resolve the auth scheme for a request.
static ExecutionAttribute<Map<String,AuthScheme<?>>>	AUTH_SCHEMES The auth schemes available for a request.
static ExecutionAttribute<BusinessMetricCollection>	BUSINESS_METRICS A collection of business metrics feature ids.
static ExecutionAttribute<AttributeMap>	CLIENT_CONTEXT_PARAMS The values of client context params declared for this service.
static ExecutionAttribute<ClientEndpointProvider>	CLIENT_ENDPOINT_PROVIDER The endpoint provider used to resolve the endpoint of the client.
static ExecutionAttribute<Boolean>	DISABLE_HOST_PREFIX_INJECTION Whether host prefix injection has been disabled on the client.
static ExecutionAttribute<EndpointProvider>	ENDPOINT_PROVIDER The endpoint provider used to resolve the destination endpoint for a request.
static ExecutionAttribute<Boolean>	HAS_INITIAL_REQUEST_EVENT If true, indicates that this is an event streaming request being sent over RPC, and therefore the serialized request object is encapsulated as an event of type initial-request.
static ExecutionAttribute<Long>	HEADERS_READ_END_NANO_TIME The nano time that reading the response headers is complete.
static ExecutionAttribute<HttpChecksum>	HTTP_CHECKSUM Key to indicate if the Http Checksums that are valid for an operation.
static ExecutionAttribute<HttpChecksumRequired>	HTTP_CHECKSUM_REQUIRED
static ExecutionAttribute<IdentityProviders>	IDENTITY_PROVIDERS The IdentityProviders for a request.
static ExecutionAttribute<Boolean>	IS_DISCOVERED_ENDPOINT Whether the endpoint on the request is the result of Endpoint Discovery.
static ExecutionAttribute<Boolean>	IS_FULL_DUPLEX The key to indicate if the request is for a full duplex operation ie., request and response are sent/received at the same time.
static ExecutionAttribute<Boolean>	IS_NONE_AUTH_TYPE_REQUEST
static ExecutionAttribute<SdkProtocolMetadata>	PROTOCOL_METADATA The key under which the protocol metadata is stored.
static ExecutionAttribute<RequestChecksumCalculation>	REQUEST_CHECKSUM_CALCULATION The request checksum calculation setting.
static ExecutionAttribute<RequestCompression>	REQUEST_COMPRESSION The supported compression algorithms for an operation, and whether the operation is streaming or not.
static ExecutionAttribute<Endpoint>	RESOLVED_ENDPOINT The resolved endpoint as computed by the client's configured EndpointProvider.
static ExecutionAttribute<AtomicLong>	RESPONSE_BYTES_READ The running count of bytes in the response body that have been read by the client.
static ExecutionAttribute<ResponseChecksumValidation>	RESPONSE_CHECKSUM_VALIDATION The response checksum validation setting.
static ExecutionAttribute<SdkClient>	SDK_CLIENT
static ExecutionAttribute<SdkHttpExecutionAttributes>	SDK_HTTP_EXECUTION_ATTRIBUTES The SDK HTTP attributes that can be passed to the HTTP client
static ExecutionAttribute<SelectedAuthScheme<?>>	SELECTED_AUTH_SCHEME The selected auth scheme for a request.

Fields inherited from class com.ibm.cos.v2.core.interceptor.SdkExecutionAttribute

API_CALL_ATTEMPT_METRIC_COLLECTOR, API_CALL_METRIC_COLLECTOR, CLIENT_ENDPOINT, CLIENT_TYPE, ENDPOINT_OVERRIDDEN, HTTP_CHECKSUM_VALIDATION_ALGORITHM, HTTP_CHECKSUM_VALIDATION_ALGORITHM_V2, HTTP_RESPONSE_CHECKSUM_VALIDATION, OPERATION_NAME, PROFILE_FILE, PROFILE_FILE_SUPPLIER, PROFILE_NAME, RESOLVED_CHECKSUM_SPECS, SERVICE_CONFIG, SERVICE_NAME, SIGNER_OVERRIDDEN, TIME_OFFSET

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IS_FULL_DUPLEX

public static final ExecutionAttribute<Boolean> IS_FULL_DUPLEX

The key to indicate if the request is for a full duplex operation ie., request and response are sent/received at the same time.

BUSINESS_METRICS

public static final ExecutionAttribute<BusinessMetricCollection> BUSINESS_METRICS

A collection of business metrics feature ids.

HAS_INITIAL_REQUEST_EVENT

public static final ExecutionAttribute<Boolean> HAS_INITIAL_REQUEST_EVENT

If true, indicates that this is an event streaming request being sent over RPC, and therefore the serialized request object is encapsulated as an event of type initial-request.

HTTP_CHECKSUM_REQUIRED

public static final ExecutionAttribute<HttpChecksumRequired> HTTP_CHECKSUM_REQUIRED

DISABLE_HOST_PREFIX_INJECTION

public static final ExecutionAttribute<Boolean> DISABLE_HOST_PREFIX_INJECTION

Whether host prefix injection has been disabled on the client. See SdkAdvancedClientOption.DISABLE_HOST_PREFIX_INJECTION

HTTP_CHECKSUM

public static final ExecutionAttribute<HttpChecksum> HTTP_CHECKSUM

Key to indicate if the Http Checksums that are valid for an operation.

SDK_HTTP_EXECUTION_ATTRIBUTES

public static final ExecutionAttribute<SdkHttpExecutionAttributes> SDK_HTTP_EXECUTION_ATTRIBUTES

The SDK HTTP attributes that can be passed to the HTTP client

IS_NONE_AUTH_TYPE_REQUEST

public static final ExecutionAttribute<Boolean> IS_NONE_AUTH_TYPE_REQUEST

CLIENT_ENDPOINT_PROVIDER

public static final ExecutionAttribute<ClientEndpointProvider> CLIENT_ENDPOINT_PROVIDER

The endpoint provider used to resolve the endpoint of the client. This will be overridden during the request pipeline by the ENDPOINT_PROVIDER.

ENDPOINT_PROVIDER

public static final ExecutionAttribute<EndpointProvider> ENDPOINT_PROVIDER

The endpoint provider used to resolve the destination endpoint for a request.

RESOLVED_ENDPOINT

public static final ExecutionAttribute<Endpoint> RESOLVED_ENDPOINT

The resolved endpoint as computed by the client's configured EndpointProvider.

CLIENT_CONTEXT_PARAMS

public static final ExecutionAttribute<AttributeMap> CLIENT_CONTEXT_PARAMS

The values of client context params declared for this service. Client contet params are one possible source of inputs into the endpoint provider for the client.

IS_DISCOVERED_ENDPOINT

public static final ExecutionAttribute<Boolean> IS_DISCOVERED_ENDPOINT

Whether the endpoint on the request is the result of Endpoint Discovery.

API_CALL_ATTEMPT_START_NANO_TIME

public static final ExecutionAttribute<Long> API_CALL_ATTEMPT_START_NANO_TIME

The nano time that the current API call attempt began.

HEADERS_READ_END_NANO_TIME

public static final ExecutionAttribute<Long> HEADERS_READ_END_NANO_TIME

The nano time that reading the response headers is complete.

RESPONSE_BYTES_READ

public static final ExecutionAttribute<AtomicLong> RESPONSE_BYTES_READ

The running count of bytes in the response body that have been read by the client. This is updated atomically as the response is being read.

This attribute is set before every API call attempt.

AUTH_SCHEME_RESOLVER

public static final ExecutionAttribute<AuthSchemeProvider> AUTH_SCHEME_RESOLVER

The auth scheme provider used to resolve the auth scheme for a request.

AUTH_SCHEMES

public static final ExecutionAttribute<Map<String,AuthScheme<?>>> AUTH_SCHEMES

The auth schemes available for a request.

IDENTITY_PROVIDERS

public static final ExecutionAttribute<IdentityProviders> IDENTITY_PROVIDERS

The IdentityProviders for a request.

SELECTED_AUTH_SCHEME

public static final ExecutionAttribute<SelectedAuthScheme<?>> SELECTED_AUTH_SCHEME

The selected auth scheme for a request.

REQUEST_COMPRESSION

public static final ExecutionAttribute<RequestCompression> REQUEST_COMPRESSION

The supported compression algorithms for an operation, and whether the operation is streaming or not.

PROTOCOL_METADATA

public static final ExecutionAttribute<SdkProtocolMetadata> PROTOCOL_METADATA

The key under which the protocol metadata is stored.

SDK_CLIENT

public static final ExecutionAttribute<SdkClient> SDK_CLIENT

REQUEST_CHECKSUM_CALCULATION

public static final ExecutionAttribute<RequestChecksumCalculation> REQUEST_CHECKSUM_CALCULATION

The request checksum calculation setting.

RESPONSE_CHECKSUM_VALIDATION

public static final ExecutionAttribute<ResponseChecksumValidation> RESPONSE_CHECKSUM_VALIDATION

The response checksum validation setting.