software.amazon.awssdk.services.apigateway.model

Interface PutRestApiResponse.Builder

All Superinterfaces:

APIGatewayResponse.Builder, CopyableBuilder<PutRestApiResponse.Builder,PutRestApiResponse>, SdkBuilder<PutRestApiResponse.Builder,PutRestApiResponse>

Enclosing class:

PutRestApiResponse

public static interface PutRestApiResponse.Builder
extends APIGatewayResponse.Builder, CopyableBuilder<PutRestApiResponse.Builder,PutRestApiResponse>

Method Summary

Modifier and Type	Method and Description
PutRestApiResponse.Builder	binaryMediaTypes(Collection<String> binaryMediaTypes) The list of binary media types supported by the RestApi.
PutRestApiResponse.Builder	binaryMediaTypes(String... binaryMediaTypes) The list of binary media types supported by the RestApi.
PutRestApiResponse.Builder	createdDate(Instant createdDate) The timestamp when the API was created.
PutRestApiResponse.Builder	description(String description) The API's description.
default PutRestApiResponse.Builder	endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration) The endpoint configuration of this RestApi showing the endpoint types of the API.
PutRestApiResponse.Builder	endpointConfiguration(EndpointConfiguration endpointConfiguration) The endpoint configuration of this RestApi showing the endpoint types of the API.
PutRestApiResponse.Builder	id(String id) The API's identifier.
PutRestApiResponse.Builder	name(String name) The API's name.
PutRestApiResponse.Builder	version(String version) A version identifier for the API.
PutRestApiResponse.Builder	warnings(Collection<String> warnings) The warning messages reported when failonwarnings is turned on during API import.
PutRestApiResponse.Builder	warnings(String... warnings) The warning messages reported when failonwarnings is turned on during API import.

Methods inherited from interface software.amazon.awssdk.services.apigateway.model.APIGatewayResponse.Builder

build

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

id

PutRestApiResponse.Builder id(String id)

The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

Parameters:

id - The API's identifier. This identifier is unique across all of your APIs in Amazon API Gateway.

Returns:

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

name

PutRestApiResponse.Builder name(String name)

The API's name.

Parameters:

name - The API's name.

Returns:

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

description

PutRestApiResponse.Builder description(String description)

The API's description.

Parameters:

description - The API's description.

Returns:

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

createdDate

PutRestApiResponse.Builder createdDate(Instant createdDate)

The timestamp when the API was created.

Parameters:

createdDate - The timestamp when the API was created.

Returns:

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

version

PutRestApiResponse.Builder version(String version)

A version identifier for the API.

Parameters:

version - A version identifier for the API.

Returns:

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

warnings

PutRestApiResponse.Builder warnings(Collection<String> warnings)

The warning messages reported when failonwarnings is turned on during API import.

Parameters:

warnings - The warning messages reported when failonwarnings is turned on during API import.

Returns:

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

warnings

PutRestApiResponse.Builder warnings(String... warnings)

The warning messages reported when failonwarnings is turned on during API import.

Parameters:

warnings - The warning messages reported when failonwarnings is turned on during API import.

Returns:

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

binaryMediaTypes

PutRestApiResponse.Builder binaryMediaTypes(Collection<String> binaryMediaTypes)

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Parameters:

binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:

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

binaryMediaTypes

PutRestApiResponse.Builder binaryMediaTypes(String... binaryMediaTypes)

The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Parameters:

binaryMediaTypes - The list of binary media types supported by the RestApi. By default, the RestApi supports only UTF-8-encoded text payloads.

Returns:

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

endpointConfiguration

PutRestApiResponse.Builder endpointConfiguration(EndpointConfiguration endpointConfiguration)

The endpoint configuration of this RestApi showing the endpoint types of the API.

Parameters:

endpointConfiguration - The endpoint configuration of this RestApi showing the endpoint types of the API.

Returns:

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

endpointConfiguration

default PutRestApiResponse.Builder endpointConfiguration(Consumer<EndpointConfiguration.Builder> endpointConfiguration)

The endpoint configuration of this RestApi showing the endpoint types of the API.

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

Parameters:

endpointConfiguration - a consumer that will call methods on EndpointConfiguration.Builder

Returns:

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

See Also:

endpointConfiguration(EndpointConfiguration)