software.amazon.awssdk.services.apigateway.model

Interface ImportDocumentationPartsRequest.Builder

All Superinterfaces:

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

Enclosing class:

ImportDocumentationPartsRequest

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

Method Summary

Modifier and Type	Method and Description
ImportDocumentationPartsRequest.Builder	body(SdkBytes 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(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	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	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
ImportDocumentationPartsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
ImportDocumentationPartsRequest.Builder	restApiId(String restApiId) [Required] 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

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

restApiId

ImportDocumentationPartsRequest.Builder restApiId(String restApiId)

[Required] The string identifier of the associated RestApi.

Parameters:

restApiId - [Required] The string identifier of the associated RestApi.

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, 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, 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(SdkBytes 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.

overrideConfiguration

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

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