software.amazon.awssdk.services.apigateway.model

Interface CreateApiKeyRequest.Builder

All Superinterfaces:

ApiGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkBuilder<CreateApiKeyRequest.Builder,CreateApiKeyRequest>, SdkRequest.Builder

Enclosing class:

CreateApiKeyRequest

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

Method Summary

Modifier and Type	Method and 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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateApiKeyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateApiKeyRequest.Builder	stageKeys(Collection<StageKey> stageKeys) DEPRECATED FOR USAGE PLANS - Specifies stages associated with the API key.
CreateApiKeyRequest.Builder	stageKeys(Consumer<StageKey.Builder>... 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.services.apigateway.model.ApiGatewayRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

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.

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(Consumer<StageKey.Builder>... stageKeys)

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

This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #stageKeys(List).

Parameters:

stageKeys - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#stageKeys(List)

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.

overrideConfiguration

CreateApiKeyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

CreateApiKeyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.