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

Interface CreateApiKeyRequest.Builder

All Superinterfaces:

CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

Enclosing class:

CreateApiKeyRequest

public static interface CreateApiKeyRequest.Builder
extends CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>

Method Summary

Modifier and Type	Method	Description
CreateApiKeyRequest.Builder	customerId(String customerId)	An AWS Marketplace customer identifier , when integrating with the AWS SaaS Marketplace.
CreateApiKeyRequest.Builder	description(String description)	The description of the ApiKey.
CreateApiKeyRequest.Builder	enabled(Boolean enabled)	Specifies whether the ApiKey can be used by callers.
CreateApiKeyRequest.Builder	generateDistinctId(Boolean generateDistinctId)	Specifies whether (true) or not (false) the key identifier is distinct from the created API key value.
CreateApiKeyRequest.Builder	name(String name)	The name of the ApiKey.
CreateApiKeyRequest.Builder	stageKeys(Collection<StageKey> stageKeys)	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CreateApiKeyRequest.Builder	stageKeys(StageKey... stageKeys)	DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CreateApiKeyRequest.Builder	value(String value)	Specifies a value of the API key.

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

copy

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

apply, build

Method Detail

name

CreateApiKeyRequest.Builder name(String name)

The name of the ApiKey.

Parameters:

name - The name of the ApiKey.

Returns:

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

description

CreateApiKeyRequest.Builder description(String description)

The description of the ApiKey.

Parameters:

description - The description of the ApiKey.

Returns:

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

enabled

CreateApiKeyRequest.Builder enabled(Boolean enabled)

Specifies whether the ApiKey can be used by callers.

Parameters:

enabled - Specifies whether the ApiKey can be used by callers.

Returns:

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

generateDistinctId

CreateApiKeyRequest.Builder generateDistinctId(Boolean generateDistinctId)

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

Parameters:

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

Returns:

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

value

CreateApiKeyRequest.Builder value(String value)

Specifies a value of the API key.

Parameters:

value - Specifies a value of the API key.

Returns:

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

stageKeys

CreateApiKeyRequest.Builder stageKeys(Collection<StageKey> stageKeys)

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

Parameters:

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

Returns:

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

stageKeys

CreateApiKeyRequest.Builder stageKeys(StageKey... stageKeys)

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

NOTE: This method appends the values to the existing list (if any). Use #setStageKeys(java.util.Collection) or #withStageKeys(java.util.Collection) if you want to override the existing values.

Parameters:

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

Returns:

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

customerId

CreateApiKeyRequest.Builder customerId(String customerId)

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

Parameters:

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

Returns:

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