software.amazon.awssdk.services.apigateway.model

Class GetApiKeyRequest

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

All Implemented Interfaces:

ToCopyableBuilder<GetApiKeyRequest.Builder,GetApiKeyRequest>

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

A request to get information about the current ApiKey resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetApiKeyRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	apiKey() The identifier of the ApiKey resource.
static GetApiKeyRequest.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()
Boolean	includeValue() A boolean flag to specify whether (true) or not (false) the result contains the key value.
static Class<? extends GetApiKeyRequest.Builder>	serializableBuilderClass()
GetApiKeyRequest.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

apiKey

public String apiKey()

The identifier of the ApiKey resource.

Returns:

The identifier of the ApiKey resource.

includeValue

public Boolean includeValue()

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

Returns:

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

toBuilder

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

Specified by:

toBuilder in class APIGatewayRequest

Returns:

a builder for type T

builder

public static GetApiKeyRequest.Builder builder()

serializableBuilderClass

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