Package software.amazon.awssdk.services.apigateway.model

Class ApiKey

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<ApiKey.Builder,ApiKey>

@Generated("software.amazon.awssdk:codegen")
public class ApiKey
extends Object
implements StructuredPojo, 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ApiKey.Builder

Method Summary

Modifier and Type	Method	Description
static ApiKey.Builder	builder()
Date	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)
int	hashCode()
String	id()	The identifier of the API Key.
Date	lastUpdatedDate()	The timestamp when the API Key was last updated.
void	marshall(ProtocolMarshaller protocolMarshaller)	Marshalls this structured data using the given ProtocolMarshaller.
String	name()	The name of the API Key.
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

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 Date createdDate()

The timestamp when the API Key was created.

Returns:

The timestamp when the API Key was created.

lastUpdatedDate

public Date 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.

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.