software.amazon.awssdk.services.apigateway.model

Class GetUsagePlanKeysRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUsagePlanKeysRequest.Builder,GetUsagePlanKeysRequest>

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

The GET request to get all the usage plan keys representing the API keys added to a specified usage plan.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetUsagePlanKeysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetUsagePlanKeysRequest.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()
Integer	limit() The maximum number of returned results per page.
String	nameQuery() A query parameter specifying the name of the to-be-returned usage plan keys.
String	position() The current pagination position in the paged result set.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUsagePlanKeysRequest.Builder>	serializableBuilderClass()
GetUsagePlanKeysRequest.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 UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

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 UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

Returns:

[Required] The Id of the UsagePlan resource representing the usage plan containing the to-be-retrieved UsagePlanKey resource representing a plan customer.

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.

nameQuery

public String nameQuery()

A query parameter specifying the name of the to-be-returned usage plan keys.

Returns:

A query parameter specifying the name of the to-be-returned usage plan keys.

toBuilder

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

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static GetUsagePlanKeysRequest.Builder builder()

serializableBuilderClass

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