software.amazon.awssdk.services.apigatewayv2.model

Class Route

java.lang.Object

software.amazon.awssdk.services.apigatewayv2.model.Route

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Route.Builder,Route>

@Generated(value="software.amazon.awssdk:codegen")
public final class Route
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Route.Builder,Route>

Represents a route.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Route.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	apiKeyRequired() Specifies whether an API key is required for this route.
List<String>	authorizationScopes() A list of authorization scopes configured on a route.
AuthorizationType	authorizationType() The authorization type for the route.
String	authorizationTypeAsString() The authorization type for the route.
String	authorizerId() The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM .
static Route.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	modelSelectionExpression() The model selection expression for the route.
String	operationName() The operation name for the route.
Map<String,String>	requestModels() The request models for the route.
Map<String,ParameterConstraints>	requestParameters() The request parameters for the route.
String	routeId() The route ID.
String	routeKey() The route key for the route.
String	routeResponseSelectionExpression() The route response selection expression for the route.
List<SdkField<?>>	sdkFields()
static Class<? extends Route.Builder>	serializableBuilderClass()
String	target() The target for the route.
Route.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

apiKeyRequired

public Boolean apiKeyRequired()

Specifies whether an API key is required for this route.

Returns:

Specifies whether an API key is required for this route.

authorizationScopes

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

authorizationType

public 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

If the service returns an enum value that is not available in the current SDK version, authorizationType will return AuthorizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizationTypeAsString().

Returns:

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

See Also:

AuthorizationType

authorizationTypeAsString

public String authorizationTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, authorizationType will return AuthorizationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authorizationTypeAsString().

Returns:

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

See Also:

AuthorizationType

authorizerId

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

Returns:

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.

modelSelectionExpression

public String modelSelectionExpression()

The model selection expression for the route.

Returns:

The model selection expression for the route.

operationName

public String operationName()

The operation name for the route.

Returns:

The operation name for the route.

requestModels

public Map<String,String> requestModels()

The request models for the route.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The request models for the route.

requestParameters

public Map<String,ParameterConstraints> requestParameters()

The request parameters for the route.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The request parameters for the route.

routeId

public String routeId()

The route ID.

Returns:

The route ID.

routeKey

public String routeKey()

The route key for the route.

Returns:

The route key for the route.

routeResponseSelectionExpression

public String routeResponseSelectionExpression()

The route response selection expression for the route.

Returns:

The route response selection expression for the route.

target

public String target()

The target for the route.

Returns:

The target for the route.

toBuilder

public Route.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Route.Builder,Route>

builder

public static Route.Builder builder()

serializableBuilderClass

public static Class<? extends Route.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo