Route (AWS Java SDK :: Services :: ApiGatewayV2 2.15.45 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Route.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`apiGatewayManaged()` Specifies whether a route is managed by API Gateway.
`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.
`static Route.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAuthorizationScopes()` Returns true if the AuthorizationScopes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasRequestModels()` Returns true if the RequestModels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasRequestParameters()` Returns true if the RequestParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`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
  - apiGatewayManaged
```
public Boolean apiGatewayManaged()
```
    Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
    
    Returns:
    
    Specifies whether a route is managed by API Gateway. If you created an API using quick create, the $default route is managed by API Gateway. You can't modify the $default route key.
  - apiKeyRequired
```
public Boolean apiKeyRequired()
```
    Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
    
    Returns:
    
    Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
  - hasAuthorizationScopes
```
public boolean hasAuthorizationScopes()
```
    Returns true if the AuthorizationScopes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - authorizationScopes
```
public List<String> authorizationScopes()
```
    A list of authorization scopes configured on a route. The scopes are used with a JWT 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.
    
    You can use hasAuthorizationScopes() to see if a value was sent in this field.
    
    Returns:
    
    A list of authorization scopes configured on a route. The scopes are used with a JWT 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. 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.
    
    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. 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.
    
    See Also:
    
    AuthorizationType
  - authorizationTypeAsString
```
public String authorizationTypeAsString()
```
    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.
    
    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. 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.
    
    See Also:
    
    AuthorizationType
  - authorizerId
```
public 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.
    
    Returns:
    
    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.
  - modelSelectionExpression
```
public String modelSelectionExpression()
```
    The model selection expression for the route. Supported only for WebSocket APIs.
    
    Returns:
    
    The model selection expression for the route. Supported only for WebSocket APIs.
  - operationName
```
public String operationName()
```
    The operation name for the route.
    
    Returns:
    
    The operation name for the route.
  - hasRequestModels
```
public boolean hasRequestModels()
```
    Returns true if the RequestModels property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - requestModels
```
public Map<String,String> requestModels()
```
    The request models for the route. Supported only for WebSocket APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRequestModels() to see if a value was sent in this field.
    
    Returns:
    
    The request models for the route. Supported only for WebSocket APIs.
  - hasRequestParameters
```
public boolean hasRequestParameters()
```
    Returns true if the RequestParameters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - requestParameters
```
public Map<String,ParameterConstraints> requestParameters()
```
    The request parameters for the route. Supported only for WebSocket APIs.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasRequestParameters() to see if a value was sent in this field.
    
    Returns:
    
    The request parameters for the route. Supported only for WebSocket APIs.
  - 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. Supported only for WebSocket APIs.
    
    Returns:
    
    The route response selection expression for the route. Supported only for WebSocket APIs.
  - 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

Class Route

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

apiGatewayManaged

apiKeyRequired

hasAuthorizationScopes

authorizationScopes

authorizationType

authorizationTypeAsString

authorizerId

modelSelectionExpression

operationName

hasRequestModels

requestModels

hasRequestParameters

requestParameters

routeId

routeKey

routeResponseSelectionExpression

target

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields