software.amazon.awssdk.services.apigateway.model

Interface ImportApiKeysRequest.Builder

All Superinterfaces:

APIGatewayRequest.Builder, AwsRequest.Builder, CopyableBuilder<ImportApiKeysRequest.Builder,ImportApiKeysRequest>, SdkBuilder<ImportApiKeysRequest.Builder,ImportApiKeysRequest>, SdkRequest.Builder

Enclosing class:

ImportApiKeysRequest

public static interface ImportApiKeysRequest.Builder
extends APIGatewayRequest.Builder, CopyableBuilder<ImportApiKeysRequest.Builder,ImportApiKeysRequest>

Method Summary

Modifier and Type	Method and Description
ImportApiKeysRequest.Builder	body(ByteBuffer body) The payload of the POST request to import API keys.
ImportApiKeysRequest.Builder	failOnWarnings(Boolean failOnWarnings) A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.
ImportApiKeysRequest.Builder	format(ApiKeysFormat format) A query parameter to specify the input format to imported API keys.
ImportApiKeysRequest.Builder	format(String format) A query parameter to specify the input format to imported API keys.
ImportApiKeysRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
ImportApiKeysRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.APIGatewayRequest.Builder

build

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

requestOverrideConfig

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

body

ImportApiKeysRequest.Builder body(ByteBuffer body)

The payload of the POST request to import API keys. For the payload format, see API Key File Format.

To preserve immutability, the remaining bytes in the provided buffer will be copied into a new buffer when set.

Parameters:

body - The payload of the POST request to import API keys. For the payload format, see API Key File Format.

Returns:

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

format

ImportApiKeysRequest.Builder format(String format)

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Parameters:

format - A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Returns:

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

See Also:

ApiKeysFormat, ApiKeysFormat

format

ImportApiKeysRequest.Builder format(ApiKeysFormat format)

A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Parameters:

format - A query parameter to specify the input format to imported API keys. Currently, only the csv format is supported.

Returns:

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

See Also:

ApiKeysFormat, ApiKeysFormat

failOnWarnings

ImportApiKeysRequest.Builder failOnWarnings(Boolean failOnWarnings)

A query parameter to indicate whether to rollback ApiKey importation (true) or not ( false) when error is encountered.

Parameters:

failOnWarnings - A query parameter to indicate whether to rollback ApiKey importation (true) or not (false) when error is encountered.

Returns:

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

requestOverrideConfig

ImportApiKeysRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

awsRequestOverrideConfig - The override configuration.

Returns:

This object for method chaining.

requestOverrideConfig

ImportApiKeysRequest.Builder requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

requestOverrideConfig in interface AwsRequest.Builder

Parameters:

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

Returns:

This object for method chaining.