software.amazon.awssdk.services.apigatewayv2.model

Interface UpdateRouteResponse.Builder

All Superinterfaces:

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

Enclosing class:

UpdateRouteResponse

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

Method Summary

Modifier and Type	Method and Description
UpdateRouteResponse.Builder	apiKeyRequired(Boolean apiKeyRequired) Specifies whether an API key is required for this route.
UpdateRouteResponse.Builder	authorizationScopes(Collection<String> authorizationScopes) A list of authorization scopes configured on a route.
UpdateRouteResponse.Builder	authorizationScopes(String... authorizationScopes) A list of authorization scopes configured on a route.
UpdateRouteResponse.Builder	authorizationType(AuthorizationType authorizationType) The authorization type for the route.
UpdateRouteResponse.Builder	authorizationType(String authorizationType) The authorization type for the route.
UpdateRouteResponse.Builder	authorizerId(String authorizerId) The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM .
UpdateRouteResponse.Builder	modelSelectionExpression(String modelSelectionExpression) The model selection expression for the route.
UpdateRouteResponse.Builder	operationName(String operationName) The operation name for the route.
UpdateRouteResponse.Builder	requestModels(Map<String,String> requestModels) The request models for the route.
UpdateRouteResponse.Builder	requestParameters(Map<String,ParameterConstraints> requestParameters) The request parameters for the route.
UpdateRouteResponse.Builder	routeId(String routeId) The route ID.
UpdateRouteResponse.Builder	routeKey(String routeKey) The route key for the route.
UpdateRouteResponse.Builder	routeResponseSelectionExpression(String routeResponseSelectionExpression) The route response selection expression for the route.
UpdateRouteResponse.Builder	target(String target) The target for the route.

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

apiKeyRequired

UpdateRouteResponse.Builder apiKeyRequired(Boolean apiKeyRequired)

Specifies whether an API key is required for this route.

Parameters:

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

Returns:

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

authorizationScopes

UpdateRouteResponse.Builder authorizationScopes(Collection<String> authorizationScopes)

A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Parameters:

authorizationScopes - A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Returns:

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

authorizationScopes

UpdateRouteResponse.Builder authorizationScopes(String... authorizationScopes)

A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Parameters:

authorizationScopes - A list of authorization scopes configured on a route. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the route scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any route scope matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the route scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

Returns:

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

authorizationType

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

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

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

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

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

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

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

routeId

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

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

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

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