com.ibm.cos.v2.core.interceptor

Class SdkExecutionAttribute

java.lang.Object

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

Direct Known Subclasses:

AwsExecutionAttribute, AwsSignerExecutionAttribute, IBMSignerExecutionAttribute, InternalCoreExecutionAttribute, S3MultipartExecutionAttribute, S3SignerExecutionAttribute, SdkInternalExecutionAttribute

public class SdkExecutionAttribute
extends Object

Contains attributes attached to the execution. This information is available to ExecutionInterceptors and Signers.

Field Summary

Fields

Modifier and Type	Field and Description
static ExecutionAttribute<MetricCollector>	API_CALL_ATTEMPT_METRIC_COLLECTOR The MetricCollector associated with the current, ongoing API call attempt.
static ExecutionAttribute<MetricCollector>	API_CALL_METRIC_COLLECTOR The MetricCollector associated with the overall API call.
static ExecutionAttribute<URI>	CLIENT_ENDPOINT Deprecated. This value is not usually accurate, now that the endpoint is almost entirely determined by the service's endpoint rules. Use SdkHttpRequest.getUri() from interceptors, to get or modify the actual endpoint.
static ExecutionAttribute<ClientType>	CLIENT_TYPE
static ExecutionAttribute<Boolean>	ENDPOINT_OVERRIDDEN Deprecated. This value should not be trusted. To modify the endpoint used for requests, you should decorate the EndpointProvider of the client. This value can be determined there, by checking for the existence of an override endpoint.
static ExecutionAttribute<Algorithm>	HTTP_CHECKSUM_VALIDATION_ALGORITHM Deprecated. use HTTP_CHECKSUM_VALIDATION_ALGORITHM_V2 instead
static ExecutionAttribute<ChecksumAlgorithm>	HTTP_CHECKSUM_VALIDATION_ALGORITHM_V2 The algorithm used for checksum validation of a response.
static ExecutionAttribute<ChecksumValidation>	HTTP_RESPONSE_CHECKSUM_VALIDATION Provides the status of ChecksumValidation performed on the response.
static ExecutionAttribute<String>	OPERATION_NAME
static ExecutionAttribute<ProfileFile>	PROFILE_FILE Deprecated. This attribute is used for: - Set profile file of service endpoint builder docdb, nepture, rds This has been replaced with PROFILE_FILE_SUPPLIER.get().
static ExecutionAttribute<Supplier<ProfileFile>>	PROFILE_FILE_SUPPLIER
static ExecutionAttribute<String>	PROFILE_NAME
static ExecutionAttribute<ChecksumSpecs>	RESOLVED_CHECKSUM_SPECS The checksum algorithm is resolved based on the Request member.
static ExecutionAttribute<ServiceConfiguration>	SERVICE_CONFIG Handler context key for advanced configuration.
static ExecutionAttribute<String>	SERVICE_NAME The key under which the service name is stored.
static ExecutionAttribute<Boolean>	SIGNER_OVERRIDDEN If the client signer value has been overridden.
static ExecutionAttribute<Integer>	TIME_OFFSET The key under which the time offset (for clock skew correction) is stored.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SdkExecutionAttribute()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

SERVICE_CONFIG

public static final ExecutionAttribute<ServiceConfiguration> SERVICE_CONFIG

Handler context key for advanced configuration.

SERVICE_NAME

public static final ExecutionAttribute<String> SERVICE_NAME

The key under which the service name is stored.

TIME_OFFSET

public static final ExecutionAttribute<Integer> TIME_OFFSET

The key under which the time offset (for clock skew correction) is stored.

CLIENT_TYPE

public static final ExecutionAttribute<ClientType> CLIENT_TYPE

OPERATION_NAME

public static final ExecutionAttribute<String> OPERATION_NAME

API_CALL_METRIC_COLLECTOR

public static final ExecutionAttribute<MetricCollector> API_CALL_METRIC_COLLECTOR

The MetricCollector associated with the overall API call.

API_CALL_ATTEMPT_METRIC_COLLECTOR

public static final ExecutionAttribute<MetricCollector> API_CALL_ATTEMPT_METRIC_COLLECTOR

The MetricCollector associated with the current, ongoing API call attempt. This is not set until the actual internal API call attempt starts.

ENDPOINT_OVERRIDDEN

@Deprecated
public static final ExecutionAttribute<Boolean> ENDPOINT_OVERRIDDEN

Deprecated. This value should not be trusted. To modify the endpoint used for requests, you should decorate the EndpointProvider of the client. This value can be determined there, by checking for the existence of an override endpoint.

True indicates that the configured endpoint of the client is a value that was supplied as an override and not generated from regional metadata.

CLIENT_ENDPOINT

@Deprecated
public static final ExecutionAttribute<URI> CLIENT_ENDPOINT

Deprecated. This value is not usually accurate, now that the endpoint is almost entirely determined by the service's endpoint rules. Use SdkHttpRequest.getUri() from interceptors, to get or modify the actual endpoint.

This is the endpointOverride (if ENDPOINT_OVERRIDDEN is true), otherwise the endpoint generated from regional metadata.

SIGNER_OVERRIDDEN

public static final ExecutionAttribute<Boolean> SIGNER_OVERRIDDEN

If the client signer value has been overridden.

PROFILE_FILE

@Deprecated
public static final ExecutionAttribute<ProfileFile> PROFILE_FILE

Deprecated. This attribute is used for: - Set profile file of service endpoint builder docdb, nepture, rds This has been replaced with PROFILE_FILE_SUPPLIER.get().

PROFILE_FILE_SUPPLIER

public static final ExecutionAttribute<Supplier<ProfileFile>> PROFILE_FILE_SUPPLIER

PROFILE_NAME

public static final ExecutionAttribute<String> PROFILE_NAME

RESOLVED_CHECKSUM_SPECS

public static final ExecutionAttribute<ChecksumSpecs> RESOLVED_CHECKSUM_SPECS

The checksum algorithm is resolved based on the Request member. The RESOLVED_CHECKSUM_SPECS holds the final checksum which will be used for checksum computation.

HTTP_CHECKSUM_VALIDATION_ALGORITHM

@Deprecated
public static final ExecutionAttribute<Algorithm> HTTP_CHECKSUM_VALIDATION_ALGORITHM

Deprecated. use HTTP_CHECKSUM_VALIDATION_ALGORITHM_V2 instead

The algorithm used for checksum validation of a response.

HTTP_CHECKSUM_VALIDATION_ALGORITHM_V2

public static final ExecutionAttribute<ChecksumAlgorithm> HTTP_CHECKSUM_VALIDATION_ALGORITHM_V2

The algorithm used for checksum validation of a response.

HTTP_RESPONSE_CHECKSUM_VALIDATION

public static final ExecutionAttribute<ChecksumValidation> HTTP_RESPONSE_CHECKSUM_VALIDATION

Provides the status of ChecksumValidation performed on the response.

Constructor Detail

SdkExecutionAttribute

protected SdkExecutionAttribute()