com.amazonservices.mws.client

Class MwsResponseHeaderMetadata

java.lang.Object

com.amazonservices.mws.client.MwsResponseHeaderMetadata

Direct Known Subclasses:

ResponseHeaderMetadata

public class MwsResponseHeaderMetadata
extends Object

Response header metadata.

Author:

mayerj

Constructor Summary

Constructors

Constructor and Description
MwsResponseHeaderMetadata(MwsResponseHeaderMetadata a) Copy another instance.
MwsResponseHeaderMetadata(String requestId, List<String> responseContext, String timestamp) Create an immutable instance.
MwsResponseHeaderMetadata(String requestId, List<String> responseContext, String timestamp, Double quotaMax, Double quotaRemaining, Date quotaResetsAt) Create an immutable instance.

Method Summary

Methods

Modifier and Type	Method and Description
Double	getQuotaMax() Gets the max quota allowed for a quota period (from the x-mws-quota-max header)
Double	getQuotaRemaining() Gets the quota remaining within this quota period (from the x-mws-quota-remaining header)
Date	getQuotaResetsAt() Gets the time that this quota period ends (from the x-mws-quota-resetsOn header)
String	getRequestId() Gets the x-mws-request-id header value.
List<String>	getResponseContext() Gets the x-mws-response-context header value.
String	getTimestamp() Gets the x-mws-timestamp header value.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MwsResponseHeaderMetadata

public MwsResponseHeaderMetadata(String requestId,
                         List<String> responseContext,
                         String timestamp,
                         Double quotaMax,
                         Double quotaRemaining,
                         Date quotaResetsAt)

Create an immutable instance.

Parameters:

requestId -

responseContext -

timestamp -

quotaMax -

quotaRemaining -

quotaResetsAt -

MwsResponseHeaderMetadata

public MwsResponseHeaderMetadata(String requestId,
                         List<String> responseContext,
                         String timestamp)

Create an immutable instance.

Parameters:

requestId -

responseContext -

timestamp -

MwsResponseHeaderMetadata

public MwsResponseHeaderMetadata(MwsResponseHeaderMetadata a)

Copy another instance.

Parameters:

a -

Method Detail

getRequestId

public String getRequestId()

Gets the x-mws-request-id header value.

Returns:

The request id.

getResponseContext

public List<String> getResponseContext()

Gets the x-mws-response-context header value.

Returns:

The response context.

getTimestamp

public String getTimestamp()

Gets the x-mws-timestamp header value.

Returns:

The response timestamp.

getQuotaMax

public Double getQuotaMax()

Gets the max quota allowed for a quota period (from the x-mws-quota-max header)

Returns:

the max quota allowed for a quota period

getQuotaRemaining

public Double getQuotaRemaining()

Gets the quota remaining within this quota period (from the x-mws-quota-remaining header)

Returns:

the quota remaining within this quota period

getQuotaResetsAt

public Date getQuotaResetsAt()

Gets the time that this quota period ends (from the x-mws-quota-resetsOn header)

Returns:

the time that this quota period ends

toString

public String toString()

Overrides:

toString in class Object