software.amazon.awssdk.services.apigateway.model

Class GetUsagePlansRequest

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

All Implemented Interfaces:

ToCopyableBuilder<GetUsagePlansRequest.Builder,GetUsagePlansRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class GetUsagePlansRequest
extends APIGatewayRequest
implements ToCopyableBuilder<GetUsagePlansRequest.Builder,GetUsagePlansRequest>

The GET request to get all the usage plans of the caller's account.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetUsagePlansRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetUsagePlansRequest.Builder	builder()
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 identifier of the API key associated with the usage plans.
Integer	limit() The maximum number of returned results per page.
String	position() The current pagination position in the paged result set.
static Class<? extends GetUsagePlansRequest.Builder>	serializableBuilderClass()
GetUsagePlansRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

requestOverrideConfig

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

position

public String position()

The current pagination position in the paged result set.

Returns:

The current pagination position in the paged result set.

keyId

public String keyId()

The identifier of the API key associated with the usage plans.

Returns:

The identifier of the API key associated with the usage plans.

limit

public Integer limit()

The maximum number of returned results per page.

Returns:

The maximum number of returned results per page.

toBuilder

public GetUsagePlansRequest.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<GetUsagePlansRequest.Builder,GetUsagePlansRequest>

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static GetUsagePlansRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetUsagePlansRequest.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