com.ibm.cloud.objectstorage

Class ResponseMetadata

java.lang.Object

com.ibm.cloud.objectstorage.ResponseMetadata

Direct Known Subclasses:

S3ResponseMetadata

public class ResponseMetadata
extends Object

Represents additional metadata included with a response from AWS. Response metadata varies by service, but all services return an AWS request ID that can be used in the event a service call isn't working as expected and you need to work with AWS support to debug an issue.

Access to AWS request IDs is also available through the com.ibm.cloud.objectstorage.request logger in the AWS SDK for Java.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AWS_EXTENDED_REQUEST_ID
static String	AWS_REQUEST_ID
static String	IBM_PROTECTION_MANAGEMENT_STATE
protected Map<String,String>	metadata

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getIbmProtectionManagementState() Returns the IBM Protection Management State contained in this response metadata object.
String	getRequestId() Returns the AWS request ID contained in this response metadata object.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

AWS_REQUEST_ID

public static final String AWS_REQUEST_ID

See Also:

Constant Field Values

AWS_EXTENDED_REQUEST_ID

public static final String AWS_EXTENDED_REQUEST_ID

See Also:

Constant Field Values

metadata

protected final Map<String,String> metadata

IBM_PROTECTION_MANAGEMENT_STATE

public static final String IBM_PROTECTION_MANAGEMENT_STATE

See Also:

Constant Field Values

Constructor Detail

ResponseMetadata

public ResponseMetadata(Map<String,String> metadata)

Creates a new ResponseMetadata object from a specified map of raw metadata information.

Parameters:

metadata - The raw metadata for the new ResponseMetadata object.

ResponseMetadata

public ResponseMetadata(ResponseMetadata originalResponseMetadata)

Creates a new ResponseMetadata object from an existing ResponseMetadata object.

Parameters:

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

Method Detail

getRequestId

public String getRequestId()

Returns the AWS request ID contained in this response metadata object. AWS request IDs can be used in the event a service call isn't working as expected and you need to work with AWS support to debug an issue.

Returns:

The AWS request ID contained in this response metadata object.

getIbmProtectionManagementState

public String getIbmProtectionManagementState()

Returns the IBM Protection Management State contained in this response metadata object. Indicates whether this bucket has an active protection management state. This header is only included if protection management is activated on a bucket.

Returns:

The AWS request ID contained in this response metadata object.

toString

public String toString()

Overrides:

toString in class Object