software.amazon.awssdk.services.apigateway.model

Interface ApiKey.Builder

All Superinterfaces:

Buildable, CopyableBuilder<ApiKey.Builder,ApiKey>, SdkBuilder<ApiKey.Builder,ApiKey>, SdkPojo

Enclosing class:

ApiKey

public static interface ApiKey.Builder
extends SdkPojo, CopyableBuilder<ApiKey.Builder,ApiKey>

Method Summary

Modifier and Type	Method and Description
ApiKey.Builder	createdDate(Instant createdDate) The timestamp when the API Key was created.
ApiKey.Builder	customerId(String customerId) An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.
ApiKey.Builder	description(String description) The description of the API Key.
ApiKey.Builder	enabled(Boolean enabled) Specifies whether the API Key can be used by callers.
ApiKey.Builder	id(String id) The identifier of the API Key.
ApiKey.Builder	lastUpdatedDate(Instant lastUpdatedDate) The timestamp when the API Key was last updated.
ApiKey.Builder	name(String name) The name of the API Key.
ApiKey.Builder	stageKeys(Collection<String> stageKeys) A list of Stage resources that are associated with the ApiKey resource.
ApiKey.Builder	stageKeys(String... stageKeys) A list of Stage resources that are associated with the ApiKey resource.
ApiKey.Builder	tags(Map<String,String> tags) The collection of tags.
ApiKey.Builder	value(String value) The value of the API Key.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

id

ApiKey.Builder id(String id)

The identifier of the API Key.

Parameters:

id - The identifier of the API Key.

Returns:

Returns a reference to this object so that method calls can be chained together.

value

ApiKey.Builder value(String value)

The value of the API Key.

Parameters:

value - The value of the API Key.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

ApiKey.Builder name(String name)

The name of the API Key.

Parameters:

name - The name of the API Key.

Returns:

Returns a reference to this object so that method calls can be chained together.

customerId

ApiKey.Builder customerId(String customerId)

An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

Parameters:

customerId - An Amazon Web Services Marketplace customer identifier, when integrating with the Amazon Web Services SaaS Marketplace.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ApiKey.Builder description(String description)

The description of the API Key.

Parameters:

description - The description of the API Key.

Returns:

Returns a reference to this object so that method calls can be chained together.

enabled

ApiKey.Builder enabled(Boolean enabled)

Specifies whether the API Key can be used by callers.

Parameters:

enabled - Specifies whether the API Key can be used by callers.

Returns:

Returns a reference to this object so that method calls can be chained together.

createdDate

ApiKey.Builder createdDate(Instant createdDate)

The timestamp when the API Key was created.

Parameters:

createdDate - The timestamp when the API Key was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastUpdatedDate

ApiKey.Builder lastUpdatedDate(Instant lastUpdatedDate)

The timestamp when the API Key was last updated.

Parameters:

lastUpdatedDate - The timestamp when the API Key was last updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

stageKeys

ApiKey.Builder stageKeys(Collection<String> stageKeys)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

stageKeys

ApiKey.Builder stageKeys(String... stageKeys)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

tags

ApiKey.Builder tags(Map<String,String> tags)

The collection of tags. Each tag element is associated with a given resource.

Parameters:

tags - The collection of tags. Each tag element is associated with a given resource.

Returns:

Returns a reference to this object so that method calls can be chained together.