software.amazon.awssdk.services.apigateway.model

Interface CreateDocumentationPartRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreateDocumentationPartRequest

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

Method Summary

Modifier and Type	Method and Description
default CreateDocumentationPartRequest.Builder	location(Consumer<DocumentationPartLocation.Builder> location) [Required] The location of the targeted API entity of the to-be-created documentation part.
CreateDocumentationPartRequest.Builder	location(DocumentationPartLocation location) [Required] The location of the targeted API entity of the to-be-created documentation part.
CreateDocumentationPartRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateDocumentationPartRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateDocumentationPartRequest.Builder	properties(String properties) [Required] The new documentation content map of the targeted API entity.
CreateDocumentationPartRequest.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

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

location

CreateDocumentationPartRequest.Builder location(DocumentationPartLocation location)

[Required] The location of the targeted API entity of the to-be-created documentation part.

Parameters:

location - [Required] The location of the targeted API entity of the to-be-created documentation part.

Returns:

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

location

default CreateDocumentationPartRequest.Builder location(Consumer<DocumentationPartLocation.Builder> location)

[Required] The location of the targeted API entity of the to-be-created documentation part.

This is a convenience that creates an instance of the DocumentationPartLocation.Builder avoiding the need to create one manually via DocumentationPartLocation.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to location(DocumentationPartLocation).

Parameters:

location - a consumer that will call methods on DocumentationPartLocation.Builder

Returns:

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

See Also:

location(DocumentationPartLocation)

properties

CreateDocumentationPartRequest.Builder properties(String properties)

[Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.

Parameters:

properties - [Required] The new documentation content map of the targeted API entity. Enclosed key-value pairs are API-specific, but only Swagger-compliant key-value pairs can be exported and, hence, published.

Returns:

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

overrideConfiguration

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

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