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() The ending date (e.g., 2016-12-31) of the usage data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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() The starting date (e.g., 2016-01-01) of the usage data.
GetUsageRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	usagePlanId() 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

usagePlanId

public final 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 final 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 final 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 final 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 final String position()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

limit

public final 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()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUsageRequest.Builder,GetUsageRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static GetUsageRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo