software.amazon.awssdk.services.apigateway.model

Class GetUsageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetUsageRequest
extends ApiGatewayRequest
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 and Description
static interface	GetUsageRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetUsageRequest.Builder	builder()
String	endDate() [Required] The ending date (e.g., 2016-12-31) of the usage data.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
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.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUsageRequest.Builder>	serializableBuilderClass()
String	startDate() [Required] 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() [Required] The Id of the usage plan associated with the usage data.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

usagePlanId

public String usagePlanId()

[Required] The Id of the usage plan associated with the usage data.

Returns:

[Required] 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()

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

Returns:

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

endDate

public String endDate()

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

Returns:

[Required] 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. The default value is 25 and the maximum value is 500.

Returns:

The maximum number of returned results per page. The default value is 25 and the maximum value is 500.

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>

Specified by:

toBuilder in class ApiGatewayRequest

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.