software.amazon.awssdk.services.apigateway.model

Interface PutRestApiRequest.Builder

All Superinterfaces:

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

Enclosing class:

PutRestApiRequest

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

Method Summary

Modifier and Type	Method and Description
PutRestApiRequest.Builder	body(ByteBuffer body) The PUT request body containing external API definitions.
PutRestApiRequest.Builder	failOnWarnings(Boolean failOnWarnings) A query parameter to indicate whether to rollback the API update (true) or not ( false) when a warning is encountered.
PutRestApiRequest.Builder	mode(PutMode mode) The mode query parameter to specify the update mode.
PutRestApiRequest.Builder	mode(String mode) The mode query parameter to specify the update mode.
PutRestApiRequest.Builder	parameters(Map<String,String> parameters) Custom header parameters as part of the request.
PutRestApiRequest.Builder	requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig) Add an optional request override configuration.
PutRestApiRequest.Builder	requestOverrideConfig(Consumer<AwsRequestOverrideConfig.Builder> builderConsumer) Add an optional request override configuration.
PutRestApiRequest.Builder	restApiId(String restApiId) The string identifier of the associated RestApi.

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

restApiId

PutRestApiRequest.Builder restApiId(String restApiId)

The string identifier of the associated RestApi.

Parameters:

restApiId - The string identifier of the associated RestApi.

Returns:

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

mode

PutRestApiRequest.Builder mode(String mode)

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Parameters:

mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Returns:

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

See Also:

PutMode, PutMode

mode

PutRestApiRequest.Builder mode(PutMode mode)

The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Parameters:

mode - The mode query parameter to specify the update mode. Valid values are "merge" and "overwrite". By default, the update mode is "merge".

Returns:

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

See Also:

PutMode, PutMode

failOnWarnings

PutRestApiRequest.Builder failOnWarnings(Boolean failOnWarnings)

A query parameter to indicate whether to rollback the API update (true) or not ( false) when a warning is encountered. The default value is false.

Parameters:

failOnWarnings - A query parameter to indicate whether to rollback the API update (true) or not ( false) when a warning is encountered. The default value is false.

Returns:

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

parameters

PutRestApiRequest.Builder parameters(Map<String,String> parameters)

Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json .

Parameters:

parameters - Custom header parameters as part of the request. For example, to exclude DocumentationParts from an imported API, set ignore=documentation as a parameters value, as in the AWS CLI command of aws apigateway import-rest-api --parameters ignore=documentation --body 'file:///path/to/imported-api-body.json .

Returns:

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

body

PutRestApiRequest.Builder body(ByteBuffer body)

The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

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

Parameters:

body - The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported. The maximum size of the API definition file is 2MB.

Returns:

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

requestOverrideConfig

PutRestApiRequest.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

PutRestApiRequest.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.