software.amazon.awssdk.services.apigateway.model

Class CreateApiKeyRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

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

Request to create an ApiKey resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateApiKeyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateApiKeyRequest.Builder	builder()
String	customerId() An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String	description() The description of the ApiKey.
Boolean	enabled() Specifies whether the ApiKey can be used by callers.
boolean	equals(Object obj)
Boolean	generateDistinctId() Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
<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	name() The name of the ApiKey.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateApiKeyRequest.Builder>	serializableBuilderClass()
List<StageKey>	stageKeys() DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CreateApiKeyRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	value() Specifies a value of the API key.

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

name

public String name()

The name of the ApiKey.

Returns:

The name of the ApiKey.

description

public String description()

The description of the ApiKey.

Returns:

The description of the ApiKey.

enabled

public Boolean enabled()

Specifies whether the ApiKey can be used by callers.

Returns:

Specifies whether the ApiKey can be used by callers.

generateDistinctId

public Boolean generateDistinctId()

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

Returns:

Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.

value

public String value()

Specifies a value of the API key.

Returns:

Specifies a value of the API key.

stageKeys

public List<StageKey> stageKeys()

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.

customerId

public String customerId()

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

Returns:

An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.

toBuilder

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

Specified by:

toBuilder in class ApiGatewayRequest

Returns:

a builder for type T

builder

public static CreateApiKeyRequest.Builder builder()

serializableBuilderClass

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