software.amazon.awssdk.services.apigateway.model

Class GetApiKeysRequest

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

All Implemented Interfaces:

ToCopyableBuilder<GetApiKeysRequest.Builder,GetApiKeysRequest>

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

A request to get information about the current ApiKeys resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetApiKeysRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetApiKeysRequest.Builder	builder()
String	customerId() The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.
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()
Boolean	includeValues() A boolean flag to specify whether (true) or not (false) the result contains key values.
Integer	limit() The maximum number of returned results per page.
String	nameQuery() The name of queried API keys.
String	position() The current pagination position in the paged result set.
static Class<? extends GetApiKeysRequest.Builder>	serializableBuilderClass()
GetApiKeysRequest.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

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

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.

Returns:

The maximum number of returned results per page.

nameQuery

public String nameQuery()

The name of queried API keys.

Returns:

The name of queried API keys.

customerId

public String customerId()

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

Returns:

The identifier of a customer in AWS Marketplace or an external system, such as a developer portal.

includeValues

public Boolean includeValues()

A boolean flag to specify whether (true) or not (false) the result contains key values.

Returns:

A boolean flag to specify whether (true) or not (false) the result contains key values.

toBuilder

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

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static GetApiKeysRequest.Builder builder()

serializableBuilderClass

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