software.amazon.awssdk.services.apigateway.model

Class ApiKey

java.lang.Object

software.amazon.awssdk.services.apigateway.model.ApiKey

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApiKey.Builder,ApiKey>

@Generated(value="software.amazon.awssdk:codegen")
public final class ApiKey
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApiKey.Builder,ApiKey>

A resource that can be distributed to callers for executing Method resources that require an API key. API keys can be mapped to any Stage on any RestApi, which indicates that the callers with the API key can make requests to that stage.

Use API Keys

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ApiKey.Builder

Method Summary

Modifier and Type	Method and Description
static ApiKey.Builder	builder()
Instant	createdDate() The timestamp when the API Key was created.
String	customerId() An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
String	description() The description of the API Key.
Boolean	enabled() Specifies whether the API Key can be used by callers.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The identifier of the API Key.
Instant	lastUpdatedDate() The timestamp when the API Key was last updated.
String	name() The name of the API Key.
List<SdkField<?>>	sdkFields()
static Class<? extends ApiKey.Builder>	serializableBuilderClass()
List<String>	stageKeys() A list of Stage resources that are associated with the ApiKey resource.
ApiKey.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
String	value() The value of the API Key.

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

id

public String id()

The identifier of the API Key.

Returns:

The identifier of the API Key.

value

public String value()

The value of the API Key.

Returns:

The value of the API Key.

name

public String name()

The name of the API Key.

Returns:

The name of 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.

description

public String description()

The description of the API Key.

Returns:

The description of the API Key.

enabled

public Boolean enabled()

Specifies whether the API Key can be used by callers.

Returns:

Specifies whether the API Key can be used by callers.

createdDate

public Instant createdDate()

The timestamp when the API Key was created.

Returns:

The timestamp when the API Key was created.

lastUpdatedDate

public Instant lastUpdatedDate()

The timestamp when the API Key was last updated.

Returns:

The timestamp when the API Key was last updated.

stageKeys

public List<String> stageKeys()

A list of Stage resources that are associated with the ApiKey resource.

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

Returns:

A list of Stage resources that are associated with the ApiKey resource.

toBuilder

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

Returns:

a builder for type T

builder

public static ApiKey.Builder builder()

serializableBuilderClass

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

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.