software.amazon.awssdk.services.apigatewayv2.model

Interface CreateApiResponse.Builder

All Superinterfaces:

ApiGatewayV2Response.Builder, AwsResponse.Builder, Buildable, CopyableBuilder<CreateApiResponse.Builder,CreateApiResponse>, SdkBuilder<CreateApiResponse.Builder,CreateApiResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreateApiResponse

public static interface CreateApiResponse.Builder
extends ApiGatewayV2Response.Builder, SdkPojo, CopyableBuilder<CreateApiResponse.Builder,CreateApiResponse>

Method Summary

Modifier and Type	Method and Description
CreateApiResponse.Builder	apiEndpoint(String apiEndpoint) The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com.
CreateApiResponse.Builder	apiId(String apiId) The API ID.
CreateApiResponse.Builder	apiKeySelectionExpression(String apiKeySelectionExpression) An API key selection expression.
CreateApiResponse.Builder	createdDate(Instant createdDate) The timestamp when the API was created.
CreateApiResponse.Builder	description(String description) The description of the API.
CreateApiResponse.Builder	disableSchemaValidation(Boolean disableSchemaValidation) Avoid validating models when creating a deployment.
CreateApiResponse.Builder	name(String name) The name of the API.
CreateApiResponse.Builder	protocolType(ProtocolType protocolType) The API protocol: Currently only WEBSOCKET is supported.
CreateApiResponse.Builder	protocolType(String protocolType) The API protocol: Currently only WEBSOCKET is supported.
CreateApiResponse.Builder	routeSelectionExpression(String routeSelectionExpression) The route selection expression for the API.
CreateApiResponse.Builder	tags(Map<String,String> tags) The key-value map of strings.
CreateApiResponse.Builder	version(String version) A version identifier for the API.
CreateApiResponse.Builder	warnings(Collection<String> warnings) The warning messages reported when failonwarnings is turned on during API import.
CreateApiResponse.Builder	warnings(String... warnings) The warning messages reported when failonwarnings is turned on during API import.

Methods inherited from interface software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response.Builder

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

apiEndpoint

CreateApiResponse.Builder apiEndpoint(String apiEndpoint)

The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

Parameters:

apiEndpoint - The URI of the API, of the form {api-id}.execute-api.{region}.amazonaws.com. The stage name is typically appended to this URI to form a complete path to a deployed API stage.

Returns:

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

apiId

CreateApiResponse.Builder apiId(String apiId)

The API ID.

Parameters:

apiId - The API ID.

Returns:

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

apiKeySelectionExpression

CreateApiResponse.Builder apiKeySelectionExpression(String apiKeySelectionExpression)

An API key selection expression. See API Key Selection Expressions.

Parameters:

apiKeySelectionExpression - An API key selection expression. See API Key Selection Expressions.

Returns:

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

createdDate

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

description

CreateApiResponse.Builder description(String description)

The description of the API.

Parameters:

description - The description of the API.

Returns:

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

disableSchemaValidation

CreateApiResponse.Builder disableSchemaValidation(Boolean disableSchemaValidation)

Avoid validating models when creating a deployment.

Parameters:

disableSchemaValidation - Avoid validating models when creating a deployment.

Returns:

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

name

CreateApiResponse.Builder name(String name)

The name of the API.

Parameters:

name - The name of the API.

Returns:

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

protocolType

CreateApiResponse.Builder protocolType(String protocolType)

The API protocol: Currently only WEBSOCKET is supported.

Parameters:

protocolType - The API protocol: Currently only WEBSOCKET is supported.

Returns:

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

See Also:

ProtocolType, ProtocolType

protocolType

CreateApiResponse.Builder protocolType(ProtocolType protocolType)

The API protocol: Currently only WEBSOCKET is supported.

Parameters:

protocolType - The API protocol: Currently only WEBSOCKET is supported.

Returns:

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

See Also:

ProtocolType, ProtocolType

routeSelectionExpression

CreateApiResponse.Builder routeSelectionExpression(String routeSelectionExpression)

The route selection expression for the API.

Parameters:

routeSelectionExpression - The route selection expression for the API.

Returns:

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

version

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

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

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

tags

CreateApiResponse.Builder tags(Map<String,String> tags)

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Parameters:

tags - The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters..

Returns:

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