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

Class GetUsageResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

software.amazon.awssdk.services.apigateway.model.GetUsageResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUsageResponse.Builder,GetUsageResponse>

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

Represents the usage data of a usage plan.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetUsageResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetUsageResponse.Builder	builder()
String	endDate()	The ending date of the usage data.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasItems()	For responses, this returns true if the service returned a value for the Items property.
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.
String	position()	Returns the value of the Position property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetUsageResponse.Builder>	serializableBuilderClass()
String	startDate()	The starting date of the usage data.
GetUsageResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	usagePlanId()	The plan Id associated with this usage data.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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 plan Id associated with this usage data.

Returns:

The plan Id associated with this usage data.

startDate

public final String startDate()

The starting date of the usage data.

Returns:

The starting date of the usage data.

endDate

public final String endDate()

The ending date of the usage data.

Returns:

The ending date of the usage data.

position

public final String position()

Returns the value of the Position property for this object.

Returns:

The value of the Position property for this object.

hasItems

public final boolean hasItems()

For responses, this returns true if the service returned a value for the Items property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

items

public final 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].

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasItems() method.

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].

toBuilder

public GetUsageResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUsageResponse.Builder,GetUsageResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetUsageResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo