software.amazon.awssdk.services.apigatewayv2.model

Interface UpdateRouteRequest.Builder

All Superinterfaces:

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

Enclosing class:

UpdateRouteRequest

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

Method Summary

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

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

UpdateRouteRequest.Builder apiKeyRequired(Boolean apiKeyRequired)

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Returns:

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

authorizationScopes

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

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

UpdateRouteRequest.Builder authorizationType(String authorizationType)

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Parameters:

authorizationType - The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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

UpdateRouteRequest.Builder authorizationType(AuthorizationType authorizationType)

The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.

Parameters:

authorizationType - The authorization type for the route. For WebSocket APIs, valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer For HTTP APIs, valid values are NONE for open access, JWT for using JSON Web Tokens, 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

UpdateRouteRequest.Builder authorizerId(String authorizerId)

The identifier of the Authorizer resource to be associated with this route. 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. 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

UpdateRouteRequest.Builder modelSelectionExpression(String modelSelectionExpression)

The model selection expression for the route. Supported only for WebSocket APIs.

Parameters:

modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

Returns:

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

operationName

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

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

The request models for the route. Supported only for WebSocket APIs.

Parameters:

requestModels - The request models for the route. Supported only for WebSocket APIs.

Returns:

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

requestParameters

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

The request parameters for the route. Supported only for WebSocket APIs.

Parameters:

requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

Returns:

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

routeId

UpdateRouteRequest.Builder routeId(String routeId)

The route ID.

Parameters:

routeId - The route ID.

Returns:

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

routeKey

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

UpdateRouteRequest.Builder routeResponseSelectionExpression(String routeResponseSelectionExpression)

The route response selection expression for the route. Supported only for WebSocket APIs.

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

Returns:

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

target

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

UpdateRouteRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder