Interface AwsApiGatewayRestApiDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AwsApiGatewayRestApiDetails.Builder,AwsApiGatewayRestApiDetails>, SdkBuilder<AwsApiGatewayRestApiDetails.Builder,AwsApiGatewayRestApiDetails>, SdkPojo

Enclosing class:

AwsApiGatewayRestApiDetails

@Mutable
@NotThreadSafe
public static interface AwsApiGatewayRestApiDetails.Builder
extends SdkPojo, CopyableBuilder<AwsApiGatewayRestApiDetails.Builder,AwsApiGatewayRestApiDetails>

Method Summary

Modifier and Type	Method	Description
AwsApiGatewayRestApiDetails.Builder	apiKeySource(String apiKeySource)	The source of the API key for metering requests according to a usage plan.
AwsApiGatewayRestApiDetails.Builder	binaryMediaTypes(String... binaryMediaTypes)	The list of binary media types supported by the REST API.
AwsApiGatewayRestApiDetails.Builder	binaryMediaTypes(Collection<String> binaryMediaTypes)	The list of binary media types supported by the REST API.
AwsApiGatewayRestApiDetails.Builder	createdDate(String createdDate)	Indicates when the API was created.
AwsApiGatewayRestApiDetails.Builder	description(String description)	A description of the REST API.
default AwsApiGatewayRestApiDetails.Builder	endpointConfiguration(Consumer<AwsApiGatewayEndpointConfiguration.Builder> endpointConfiguration)	The endpoint configuration of the REST API.
AwsApiGatewayRestApiDetails.Builder	endpointConfiguration(AwsApiGatewayEndpointConfiguration endpointConfiguration)	The endpoint configuration of the REST API.
AwsApiGatewayRestApiDetails.Builder	id(String id)	The identifier of the REST API.
AwsApiGatewayRestApiDetails.Builder	minimumCompressionSize(Integer minimumCompressionSize)	The minimum size in bytes of a payload before compression is enabled.
AwsApiGatewayRestApiDetails.Builder	name(String name)	The name of the REST API.
AwsApiGatewayRestApiDetails.Builder	version(String version)	The version identifier for the REST API.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

id

AwsApiGatewayRestApiDetails.Builder id(String id)

The identifier of the REST API.

Parameters:

id - The identifier of the REST API.

Returns:

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

name

AwsApiGatewayRestApiDetails.Builder name(String name)

The name of the REST API.

Parameters:

name - The name of the REST API.

Returns:

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

description

AwsApiGatewayRestApiDetails.Builder description(String description)

A description of the REST API.

Parameters:

description - A description of the REST API.

Returns:

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

createdDate

AwsApiGatewayRestApiDetails.Builder createdDate(String createdDate)

Indicates when the API was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestamps.

Parameters:

createdDate - Indicates when the API was created.

For more information about the validation and formatting of timestamp fields in Security Hub CSPM, see Timestampsinvalid input: '<'/ a>.

Returns:

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

version

AwsApiGatewayRestApiDetails.Builder version(String version)

The version identifier for the REST API.

Parameters:

version - The version identifier for the REST API.

Returns:

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

binaryMediaTypes

AwsApiGatewayRestApiDetails.Builder binaryMediaTypes(Collection<String> binaryMediaTypes)

The list of binary media types supported by the REST API.

Parameters:

binaryMediaTypes - The list of binary media types supported by the REST API.

Returns:

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

binaryMediaTypes

AwsApiGatewayRestApiDetails.Builder binaryMediaTypes(String... binaryMediaTypes)

The list of binary media types supported by the REST API.

Parameters:

binaryMediaTypes - The list of binary media types supported by the REST API.

Returns:

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

minimumCompressionSize

AwsApiGatewayRestApiDetails.Builder minimumCompressionSize(Integer minimumCompressionSize)

The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

Parameters:

minimumCompressionSize - The minimum size in bytes of a payload before compression is enabled.

If null, then compression is disabled.

If 0, then all payloads are compressed.

Returns:

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

apiKeySource

AwsApiGatewayRestApiDetails.Builder apiKeySource(String apiKeySource)

The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

Parameters:

apiKeySource - The source of the API key for metering requests according to a usage plan.

HEADER indicates whether to read the API key from the X-API-Key header of a request.

AUTHORIZER indicates whether to read the API key from the UsageIdentifierKey from a custom authorizer.

Returns:

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

endpointConfiguration

AwsApiGatewayRestApiDetails.Builder endpointConfiguration(AwsApiGatewayEndpointConfiguration endpointConfiguration)

The endpoint configuration of the REST API.

Parameters:

endpointConfiguration - The endpoint configuration of the REST API.

Returns:

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

endpointConfiguration

default AwsApiGatewayRestApiDetails.Builder endpointConfiguration(Consumer<AwsApiGatewayEndpointConfiguration.Builder> endpointConfiguration)

The endpoint configuration of the REST API.

This is a convenience method that creates an instance of the AwsApiGatewayEndpointConfiguration.Builder avoiding the need to create one manually via AwsApiGatewayEndpointConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfiguration(AwsApiGatewayEndpointConfiguration).

Parameters:

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

Returns:

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

See Also:

• endpointConfiguration(AwsApiGatewayEndpointConfiguration)