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	apiGatewayManaged(Boolean apiGatewayManaged) Specifies whether an API is managed by API Gateway.
CreateApiResponse.Builder	apiId(String apiId) The API ID.
CreateApiResponse.Builder	apiKeySelectionExpression(String apiKeySelectionExpression) An API key selection expression.
default CreateApiResponse.Builder	corsConfiguration(Consumer<Cors.Builder> corsConfiguration) A CORS configuration.
CreateApiResponse.Builder	corsConfiguration(Cors corsConfiguration) A CORS configuration.
CreateApiResponse.Builder	createdDate(Instant createdDate) The timestamp when the API was created.
CreateApiResponse.Builder	description(String description) The description of the API.
CreateApiResponse.Builder	disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint) Specifies whether clients can invoke your API by using the default execute-api endpoint.
CreateApiResponse.Builder	disableSchemaValidation(Boolean disableSchemaValidation) Avoid validating models when creating a deployment.
CreateApiResponse.Builder	importInfo(Collection<String> importInfo) The validation information during API import.
CreateApiResponse.Builder	importInfo(String... importInfo) The validation information during API import.
CreateApiResponse.Builder	name(String name) The name of the API.
CreateApiResponse.Builder	protocolType(ProtocolType protocolType) The API protocol.
CreateApiResponse.Builder	protocolType(String protocolType) The API protocol.
CreateApiResponse.Builder	routeSelectionExpression(String routeSelectionExpression) The route selection expression for the API.
CreateApiResponse.Builder	tags(Map<String,String> tags) A collection of tags associated with the API.
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.

apiGatewayManaged

CreateApiResponse.Builder apiGatewayManaged(Boolean apiGatewayManaged)

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

Parameters:

apiGatewayManaged - Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

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. Supported only for WebSocket APIs. See API Key Selection Expressions.

Parameters:

apiKeySelectionExpression - An API key selection expression. Supported only for WebSocket APIs. See API Key Selection Expressions.

Returns:

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

corsConfiguration

CreateApiResponse.Builder corsConfiguration(Cors corsConfiguration)

A CORS configuration. Supported only for HTTP APIs.

Parameters:

corsConfiguration - A CORS configuration. Supported only for HTTP APIs.

Returns:

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

corsConfiguration

default CreateApiResponse.Builder corsConfiguration(Consumer<Cors.Builder> corsConfiguration)

A CORS configuration. Supported only for HTTP APIs.

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

Parameters:

corsConfiguration - a consumer that will call methods on Cors.Builder

Returns:

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

See Also:

corsConfiguration(Cors)

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. Supported only for WebSocket APIs.

Parameters:

disableSchemaValidation - Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

Returns:

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

disableExecuteApiEndpoint

CreateApiResponse.Builder disableExecuteApiEndpoint(Boolean disableExecuteApiEndpoint)

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Parameters:

disableExecuteApiEndpoint - Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

Returns:

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

importInfo

CreateApiResponse.Builder importInfo(Collection<String> importInfo)

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

Parameters:

importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

Returns:

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

importInfo

CreateApiResponse.Builder importInfo(String... importInfo)

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

Parameters:

importInfo - The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

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.

Parameters:

protocolType - The API protocol.

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.

Parameters:

protocolType - The API protocol.

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. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Parameters:

routeSelectionExpression - The route selection expression for the API. For HTTP APIs, the routeSelectionExpression must be ${request.method} ${request.path}. If not provided, this will be the default for HTTP APIs. This property is required for WebSocket APIs.

Returns:

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

tags

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

A collection of tags associated with the API.

Parameters:

tags - A collection of tags associated with 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.