Package 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:

SdkPojo, ToCopyableBuilder<GetApiKeysRequest.Builder,GetApiKeysRequest>

@Generated("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	Description
static interface	GetApiKeysRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetApiKeysRequest.Builder	builder()
String	customerId()	The identifier of a customer in Amazon Web Services Marketplace or an external system, such as a developer portal.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends GetApiKeysRequest.Builder>	serializableBuilderClass()
GetApiKeysRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

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.

nameQuery

public final String nameQuery()

The name of queried API keys.

Returns:

The name of queried API keys.

customerId

public final String customerId()

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

Returns:

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

includeValues

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

Specified by:

toBuilder in interface ToCopyableBuilder<GetApiKeysRequest.Builder,GetApiKeysRequest>

Specified by:

toBuilder in class ApiGatewayRequest

builder

public static GetApiKeysRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo