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

Interface PutRestApiRequest.Builder

All Superinterfaces:

CopyableBuilder<PutRestApiRequest.Builder,PutRestApiRequest>, SdkBuilder<PutRestApiRequest.Builder,PutRestApiRequest>

Enclosing class:

PutRestApiRequest

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

Method Summary

Modifier and Type	Method	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(String mode)	The mode query parameter to specify the update mode.
PutRestApiRequest.Builder	mode(PutMode mode)	The mode query parameter to specify the update mode.
PutRestApiRequest.Builder	parameters(Map<String,String> parameters)	Custom headers supplied as part of the request.
PutRestApiRequest.Builder	restApiId(String restApiId)	The identifier of the RestApi to be updated.

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 identifier of the RestApi to be updated.

Parameters:

restApiId - The identifier of the RestApi to be updated.

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

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

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 headers supplied as part of the request.

Parameters:

parameters - Custom headers supplied as part of the request.

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.

Parameters:

body - The PUT request body containing external API definitions. Currently, only Swagger definition JSON files are supported.

Returns:

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