com.ibm.cloud.objectstorage.services.s3

Class S3ResponseMetadata

java.lang.Object

com.ibm.cloud.objectstorage.ResponseMetadata

com.ibm.cloud.objectstorage.services.s3.S3ResponseMetadata

public class S3ResponseMetadata
extends ResponseMetadata

Extension of ResponseMetadata with Amazon S3 specific data. In addition to the standard Amazon Web Services request ID contained in all services' response metadata, Amazon S3 also includes a host ID that can be provided to Amazon Web Services support when debugging an issue with Amazon S3.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLOUD_FRONT_ID
static String	HOST_ID

Fields inherited from class com.ibm.cloud.objectstorage.ResponseMetadata

AWS_EXTENDED_REQUEST_ID, AWS_REQUEST_ID, IBM_PROTECTION_MANAGEMENT_STATE, metadata

Constructor Summary

Constructors

Constructor and Description
S3ResponseMetadata(Map<String,String> metadata) Creates a new S3ResponseMetadata object from a specified map of metadata information.
S3ResponseMetadata(ResponseMetadata originalResponseMetadata) Creates a new S3ResponseMetadata object from an existing ResponseMetadata object.

Method Summary

Modifier and Type	Method and Description
String	getCloudFrontId()
String	getHostId() Returns the Amazon S3 host ID, providing additional debugging information about how a request was handled.

Methods inherited from class com.ibm.cloud.objectstorage.ResponseMetadata

getIbmProtectionManagementState, getRequestId, toString

Methods inherited from class java.lang.Object

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

Field Detail

HOST_ID

public static final String HOST_ID

See Also:

Constant Field Values

CLOUD_FRONT_ID

public static final String CLOUD_FRONT_ID

See Also:

Constant Field Values

Constructor Detail

S3ResponseMetadata

public S3ResponseMetadata(Map<String,String> metadata)

Creates a new S3ResponseMetadata object from a specified map of metadata information.

Parameters:

metadata - The raw metadata for the new S3ResponseMetadata object.

S3ResponseMetadata

public S3ResponseMetadata(ResponseMetadata originalResponseMetadata)

Creates a new S3ResponseMetadata object from an existing ResponseMetadata object.

Parameters:

originalResponseMetadata - The ResponseMetadata object from which to create the new object.

Method Detail

getHostId

public String getHostId()

Returns the Amazon S3 host ID, providing additional debugging information about how a request was handled. You can provide Amazon Web Services support with this ID to help troubleshoot issues where Amazon S3 isn't handling your request as expected.

Returns:

The Amazon S3 host ID, providing additional debugging information about how a request was handled.

getCloudFrontId

public String getCloudFrontId()