software.amazon.awssdk.services.apigatewayv2.model

Interface CreateRouteRequest.Builder

All Superinterfaces:

ApiGatewayV2Request.Builder, AwsRequest.Builder, Buildable, CopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>, SdkBuilder<CreateRouteRequest.Builder,CreateRouteRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateRouteRequest

public static interface CreateRouteRequest.Builder
extends ApiGatewayV2Request.Builder, SdkPojo, CopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>

Method Summary

Modifier and Type	Method and Description
CreateRouteRequest.Builder	apiId(String apiId) The API identifier.
CreateRouteRequest.Builder	apiKeyRequired(Boolean apiKeyRequired) Specifies whether an API key is required for the route.
CreateRouteRequest.Builder	authorizationScopes(Collection<String> authorizationScopes) The authorization scopes supported by this route.
CreateRouteRequest.Builder	authorizationScopes(String... authorizationScopes) The authorization scopes supported by this route.
CreateRouteRequest.Builder	authorizationType(AuthorizationType authorizationType) The authorization type for the route.
CreateRouteRequest.Builder	authorizationType(String authorizationType) The authorization type for the route.
CreateRouteRequest.Builder	authorizerId(String authorizerId) The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM .
CreateRouteRequest.Builder	modelSelectionExpression(String modelSelectionExpression) The model selection expression for the route.
CreateRouteRequest.Builder	operationName(String operationName) The operation name for the route.
CreateRouteRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
CreateRouteRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
CreateRouteRequest.Builder	requestModels(Map<String,String> requestModels) The request models for the route.
CreateRouteRequest.Builder	requestParameters(Map<String,ParameterConstraints> requestParameters) The request parameters for the route.
CreateRouteRequest.Builder	routeKey(String routeKey) The route key for the route.
CreateRouteRequest.Builder	routeResponseSelectionExpression(String routeResponseSelectionExpression) The route response selection expression for the route.
CreateRouteRequest.Builder	target(String target) The target for the route.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

apiId

CreateRouteRequest.Builder apiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

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

apiKeyRequired

CreateRouteRequest.Builder apiKeyRequired(Boolean apiKeyRequired)

Specifies whether an API key is required for the route.

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route.

Returns:

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

authorizationScopes

CreateRouteRequest.Builder authorizationScopes(Collection<String> authorizationScopes)

The authorization scopes supported by this route.

Parameters:

authorizationScopes - The authorization scopes supported by this route.

Returns:

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

authorizationScopes

CreateRouteRequest.Builder authorizationScopes(String... authorizationScopes)

The authorization scopes supported by this route.

Parameters:

authorizationScopes - The authorization scopes supported by this route.

Returns:

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

authorizationType

CreateRouteRequest.Builder authorizationType(String authorizationType)

The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Parameters:

authorizationType - The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Returns:

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

See Also:

AuthorizationType, AuthorizationType

authorizationType

CreateRouteRequest.Builder authorizationType(AuthorizationType authorizationType)

The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Parameters:

authorizationType - The authorization type for the route. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Returns:

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

See Also:

AuthorizationType, AuthorizationType

authorizerId

CreateRouteRequest.Builder authorizerId(String authorizerId)

The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

Parameters:

authorizerId - The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM . The authorizer identifier is generated by API Gateway when you created the authorizer.

Returns:

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

modelSelectionExpression

CreateRouteRequest.Builder modelSelectionExpression(String modelSelectionExpression)

The model selection expression for the route.

Parameters:

modelSelectionExpression - The model selection expression for the route.

Returns:

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

operationName

CreateRouteRequest.Builder operationName(String operationName)

The operation name for the route.

Parameters:

operationName - The operation name for the route.

Returns:

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

requestModels

CreateRouteRequest.Builder requestModels(Map<String,String> requestModels)

The request models for the route.

Parameters:

requestModels - The request models for the route.

Returns:

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

requestParameters

CreateRouteRequest.Builder requestParameters(Map<String,ParameterConstraints> requestParameters)

The request parameters for the route.

Parameters:

requestParameters - The request parameters for the route.

Returns:

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

routeKey

CreateRouteRequest.Builder routeKey(String routeKey)

The route key for the route.

Parameters:

routeKey - The route key for the route.

Returns:

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

routeResponseSelectionExpression

CreateRouteRequest.Builder routeResponseSelectionExpression(String routeResponseSelectionExpression)

The route response selection expression for the route.

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route.

Returns:

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

target

CreateRouteRequest.Builder target(String target)

The target for the route.

Parameters:

target - The target for the route.

Returns:

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

overrideConfiguration

CreateRouteRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CreateRouteRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder