Package software.amazon.awssdk.services.apigateway.model

Class GetUsageRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.apigateway.model.GetUsageRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>

@Generated("software.amazon.awssdk:codegen")
public class GetUsageRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>

The GET request to get the usage data of a usage plan in a specified time interval.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetUsageRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static GetUsageRequest.Builder	builder()
String	endDate()	The ending date (e.g., 2016-12-31) of the usage data.
boolean	equals(Object obj)
int	hashCode()
String	keyId()	The Id of the API key associated with the resultant usage data.
Integer	limit()	The maximum number of returned results per page.
String	position()	The current pagination position in the paged result set.
static Class<? extends GetUsageRequest.Builder>	serializableBuilderClass()
String	startDate()	The starting date (e.g., 2016-01-01) of the usage data.
GetUsageRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	usagePlanId()	The Id of the usage plan associated with the usage data.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

usagePlanId

public String usagePlanId()

The Id of the usage plan associated with the usage data.

Returns:

The Id of the usage plan associated with the usage data.

keyId

public String keyId()

The Id of the API key associated with the resultant usage data.

Returns:

The Id of the API key associated with the resultant usage data.

startDate

public String startDate()

The starting date (e.g., 2016-01-01) of the usage data.

Returns:

The starting date (e.g., 2016-01-01) of the usage data.

endDate

public String endDate()

The ending date (e.g., 2016-12-31) of the usage data.

Returns:

The ending date (e.g., 2016-12-31) of the usage data.

position

public String position()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

limit

public Integer limit()

The maximum number of returned results per page.

Returns:

The maximum number of returned results per page.

toBuilder

public GetUsageRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>

Returns:

a builder for type T

builder

public static GetUsageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetUsageRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object