com.amazonaws.services.apigateway.model

Class GetUsageResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.apigateway.model.GetUsageResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUsageResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

Represents the usage data of a usage plan.

Create and Use Usage Plans, Manage Usage in a Usage Plan

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetUsageResult()

Method Summary

Modifier and Type	Method and Description
GetUsageResult	addItemsEntry(String key, List<List<Long>> value)
GetUsageResult	clearItemsEntries() Removes all the entries added into Items.
GetUsageResult	clone()
boolean	equals(Object obj)
String	getEndDate() The ending date of the usage data.
Map<String,List<List<Long>>>	getItems() The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan.
String	getPosition()
String	getStartDate() The starting date of the usage data.
String	getUsagePlanId() The plan Id associated with this usage data.
int	hashCode()
void	setEndDate(String endDate) The ending date of the usage data.
void	setItems(Map<String,List<List<Long>>> items) The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan.
void	setPosition(String position)
void	setStartDate(String startDate) The starting date of the usage data.
void	setUsagePlanId(String usagePlanId) The plan Id associated with this usage data.
String	toString() Returns a string representation of this object; useful for testing and debugging.
GetUsageResult	withEndDate(String endDate) The ending date of the usage data.
GetUsageResult	withItems(Map<String,List<List<Long>>> items) The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan.
GetUsageResult	withPosition(String position)
GetUsageResult	withStartDate(String startDate) The starting date of the usage data.
GetUsageResult	withUsagePlanId(String usagePlanId) The plan Id associated with this usage data.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetUsageResult

public GetUsageResult()

Method Detail

setUsagePlanId

public void setUsagePlanId(String usagePlanId)

The plan Id associated with this usage data.

Parameters:

usagePlanId - The plan Id associated with this usage data.

getUsagePlanId

public String getUsagePlanId()

The plan Id associated with this usage data.

Returns:

The plan Id associated with this usage data.

withUsagePlanId

public GetUsageResult withUsagePlanId(String usagePlanId)

The plan Id associated with this usage data.

Parameters:

usagePlanId - The plan Id associated with this usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStartDate

public void setStartDate(String startDate)

The starting date of the usage data.

Parameters:

startDate - The starting date of the usage data.

getStartDate

public String getStartDate()

The starting date of the usage data.

Returns:

The starting date of the usage data.

withStartDate

public GetUsageResult withStartDate(String startDate)

The starting date of the usage data.

Parameters:

startDate - The starting date of the usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEndDate

public void setEndDate(String endDate)

The ending date of the usage data.

Parameters:

endDate - The ending date of the usage data.

getEndDate

public String getEndDate()

The ending date of the usage data.

Returns:

The ending date of the usage data.

withEndDate

public GetUsageResult withEndDate(String endDate)

The ending date of the usage data.

Parameters:

endDate - The ending date of the usage data.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPosition

public void setPosition(String position)

Parameters:

position -

getPosition

public String getPosition()

Returns:

withPosition

public GetUsageResult withPosition(String position)

Parameters:

position -

Returns:

Returns a reference to this object so that method calls can be chained together.

getItems

public Map<String,List<List<Long>>> getItems()

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Returns:

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

setItems

public void setItems(Map<String,List<List<Long>>> items)

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Parameters:

items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

withItems

public GetUsageResult withItems(Map<String,List<List<Long>>> items)

The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Parameters:

items - The usage data, as daily logs of used and remaining quotas, over the specified time interval indexed over the API keys in a usage plan. For example, {..., "values" : { "{api_key}" : [ [0, 100], [10, 90], [100, 10]]}, where {api_key} stands for an API key value and the daily log entry is of the format [used quota, remaining quota].

Returns:

Returns a reference to this object so that method calls can be chained together.

addItemsEntry

public GetUsageResult addItemsEntry(String key,
                                    List<List<Long>> value)

clearItemsEntries

public GetUsageResult clearItemsEntries()

Removes all the entries added into Items.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetUsageResult clone()

Overrides:

clone in class Object