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

Interface ImportDocumentationPartsRequest.Builder

All Superinterfaces:

CopyableBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>, SdkBuilder<ImportDocumentationPartsRequest.Builder,ImportDocumentationPartsRequest>

Enclosing class:

ImportDocumentationPartsRequest

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

Method Summary

Modifier and Type	Method	Description
ImportDocumentationPartsRequest.Builder	body(ByteBuffer body)	[Required] Raw byte array representing the to-be-imported documentation parts.
ImportDocumentationPartsRequest.Builder	failOnWarnings(Boolean failOnWarnings)	A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered.
ImportDocumentationPartsRequest.Builder	mode(String mode)	A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one.
ImportDocumentationPartsRequest.Builder	mode(PutMode mode)	A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one.
ImportDocumentationPartsRequest.Builder	restApiId(String restApiId)	[Required] The identifier of an API of the to-be-imported documentation parts.

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

ImportDocumentationPartsRequest.Builder restApiId(String restApiId)

[Required] The identifier of an API of the to-be-imported documentation parts.

Parameters:

restApiId - [Required] The identifier of an API of the to-be-imported documentation parts.

Returns:

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

mode

ImportDocumentationPartsRequest.Builder mode(String mode)

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Parameters:

mode - A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Returns:

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

See Also:

PutMode

mode

ImportDocumentationPartsRequest.Builder mode(PutMode mode)

A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Parameters:

mode - A query parameter to indicate whether to overwrite (OVERWRITE) any existing DocumentationParts definition or to merge (MERGE) the new definition into the existing one. The default value is MERGE.

Returns:

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

See Also:

PutMode

failOnWarnings

ImportDocumentationPartsRequest.Builder failOnWarnings(Boolean failOnWarnings)

A query parameter to specify whether to rollback the documentation importation (true) or not ( false) when a warning is encountered. The default value is false.

Parameters:

failOnWarnings - A query parameter to specify whether to rollback the documentation importation (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.

body

ImportDocumentationPartsRequest.Builder body(ByteBuffer body)

[Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

Parameters:

body - [Required] Raw byte array representing the to-be-imported documentation parts. To import from a Swagger file, this is a JSON object.

Returns:

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