Route (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.apigatewayv2.model.Route

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Route
extends Object
implements Serializable, Cloneable, StructuredPojo

Represents a route.

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

Route()

Constructors
Constructor and Description
`Route()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Route`	`addRequestModelsEntry(String key, String value)`
`Route`	`addRequestParametersEntry(String key, ParameterConstraints value)`
`Route`	`clearRequestModelsEntries()` Removes all the entries added into RequestModels.
`Route`	`clearRequestParametersEntries()` Removes all the entries added into RequestParameters.
`Route`	`clone()`
`boolean`	`equals(Object obj)`
`Boolean`	`getApiKeyRequired()` Specifies whether an API key is required for this route.
`List<String>`	`getAuthorizationScopes()` A list of authorization scopes configured on a route.
`String`	`getAuthorizationType()` The authorization type for the route.
`String`	`getAuthorizerId()` The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM .
`String`	`getModelSelectionExpression()` The model selection expression for the route.
`String`	`getOperationName()` The operation name for the route.
`Map<String,String>`	`getRequestModels()` The request models for the route.
`Map<String,ParameterConstraints>`	`getRequestParameters()` The request parameters for the route.
`String`	`getRouteId()` The route ID.
`String`	`getRouteKey()` The route key for the route.
`String`	`getRouteResponseSelectionExpression()` The route response selection expression for the route.
`String`	`getTarget()` The target for the route.
`int`	`hashCode()`
`Boolean`	`isApiKeyRequired()` Specifies whether an API key is required for this route.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApiKeyRequired(Boolean apiKeyRequired)` Specifies whether an API key is required for this route.
`void`	`setAuthorizationScopes(Collection<String> authorizationScopes)` A list of authorization scopes configured on a route.
`void`	`setAuthorizationType(String authorizationType)` The authorization type for the route.
`void`	`setAuthorizerId(String authorizerId)` The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM .
`void`	`setModelSelectionExpression(String modelSelectionExpression)` The model selection expression for the route.
`void`	`setOperationName(String operationName)` The operation name for the route.
`void`	`setRequestModels(Map<String,String> requestModels)` The request models for the route.
`void`	`setRequestParameters(Map<String,ParameterConstraints> requestParameters)` The request parameters for the route.
`void`	`setRouteId(String routeId)` The route ID.
`void`	`setRouteKey(String routeKey)` The route key for the route.
`void`	`setRouteResponseSelectionExpression(String routeResponseSelectionExpression)` The route response selection expression for the route.
`void`	`setTarget(String target)` The target for the route.
`String`	`toString()` Returns a string representation of this object.
`Route`	`withApiKeyRequired(Boolean apiKeyRequired)` Specifies whether an API key is required for this route.
`Route`	`withAuthorizationScopes(Collection<String> authorizationScopes)` A list of authorization scopes configured on a route.
`Route`	`withAuthorizationScopes(String... authorizationScopes)` A list of authorization scopes configured on a route.
`Route`	`withAuthorizationType(AuthorizationType authorizationType)` The authorization type for the route.
`Route`	`withAuthorizationType(String authorizationType)` The authorization type for the route.
`Route`	`withAuthorizerId(String authorizerId)` The identifier of the Authorizer resource to be associated with this route, if the authorizationType is CUSTOM .
`Route`	`withModelSelectionExpression(String modelSelectionExpression)` The model selection expression for the route.
`Route`	`withOperationName(String operationName)` The operation name for the route.
`Route`	`withRequestModels(Map<String,String> requestModels)` The request models for the route.
`Route`	`withRequestParameters(Map<String,ParameterConstraints> requestParameters)` The request parameters for the route.
`Route`	`withRouteId(String routeId)` The route ID.
`Route`	`withRouteKey(String routeKey)` The route key for the route.
`Route`	`withRouteResponseSelectionExpression(String routeResponseSelectionExpression)` The route response selection expression for the route.
`Route`	`withTarget(String target)` The target for the route.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Route
```
public Route()
```
- Method Detail
  - setApiKeyRequired
```
public void setApiKeyRequired(Boolean apiKeyRequired)
```
    Specifies whether an API key is required for this route.
    
    Parameters:
    
    apiKeyRequired - Specifies whether an API key is required for this route.
  - getApiKeyRequired
```
public Boolean getApiKeyRequired()
```
    Specifies whether an API key is required for this route.
    
    Returns:
    
    Specifies whether an API key is required for this route.
  - withApiKeyRequired
```
public Route withApiKeyRequired(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.
  - isApiKeyRequired
```
public Boolean isApiKeyRequired()
```
    Specifies whether an API key is required for this route.
    
    Returns:
    
    Specifies whether an API key is required for this route.
  - getAuthorizationScopes
```
public List<String> getAuthorizationScopes()
```
    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:
    
    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.
  - setAuthorizationScopes
```
public void setAuthorizationScopes(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.
  - withAuthorizationScopes
```
public Route withAuthorizationScopes(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAuthorizationScopes(java.util.Collection) or withAuthorizationScopes(java.util.Collection) if you want to override the existing values.
    
    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.
  - withAuthorizationScopes
```
public Route withAuthorizationScopes(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.
  - setAuthorizationType
```
public void setAuthorizationType(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
    
    See Also:
    
    AuthorizationType
  - getAuthorizationType
```
public String getAuthorizationType()
```
    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:
    
    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
  - withAuthorizationType
```
public Route withAuthorizationType(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
  - withAuthorizationType
```
public Route withAuthorizationType(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
  - setAuthorizerId
```
public void setAuthorizerId(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.
  - getAuthorizerId
```
public String getAuthorizerId()
```
    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.
  - withAuthorizerId
```
public Route withAuthorizerId(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.
  - setModelSelectionExpression
```
public void setModelSelectionExpression(String modelSelectionExpression)
```
    The model selection expression for the route.
    
    Parameters:
    
    modelSelectionExpression - The model selection expression for the route.
  - getModelSelectionExpression
```
public String getModelSelectionExpression()
```
    The model selection expression for the route.
    
    Returns:
    
    The model selection expression for the route.
  - withModelSelectionExpression
```
public Route withModelSelectionExpression(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.
  - setOperationName
```
public void setOperationName(String operationName)
```
    The operation name for the route.
    
    Parameters:
    
    operationName - The operation name for the route.
  - getOperationName
```
public String getOperationName()
```
    The operation name for the route.
    
    Returns:
    
    The operation name for the route.
  - withOperationName
```
public Route withOperationName(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.
  - getRequestModels
```
public Map<String,String> getRequestModels()
```
    The request models for the route.
    
    Returns:
    
    The request models for the route.
  - setRequestModels
```
public void setRequestModels(Map<String,String> requestModels)
```
    The request models for the route.
    
    Parameters:
    
    requestModels - The request models for the route.
  - withRequestModels
```
public Route withRequestModels(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.
  - addRequestModelsEntry
```
public Route addRequestModelsEntry(String key,
                                   String value)
```
  - clearRequestModelsEntries
```
public Route clearRequestModelsEntries()
```
    Removes all the entries added into RequestModels.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequestParameters
```
public Map<String,ParameterConstraints> getRequestParameters()
```
    The request parameters for the route.
    
    Returns:
    
    The request parameters for the route.
  - setRequestParameters
```
public void setRequestParameters(Map<String,ParameterConstraints> requestParameters)
```
    The request parameters for the route.
    
    Parameters:
    
    requestParameters - The request parameters for the route.
  - withRequestParameters
```
public Route withRequestParameters(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.
  - addRequestParametersEntry
```
public Route addRequestParametersEntry(String key,
                                       ParameterConstraints value)
```
  - clearRequestParametersEntries
```
public Route clearRequestParametersEntries()
```
    Removes all the entries added into RequestParameters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRouteId
```
public void setRouteId(String routeId)
```
    The route ID.
    
    Parameters:
    
    routeId - The route ID.
  - getRouteId
```
public String getRouteId()
```
    The route ID.
    
    Returns:
    
    The route ID.
  - withRouteId
```
public Route withRouteId(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.
  - setRouteKey
```
public void setRouteKey(String routeKey)
```
    The route key for the route.
    
    Parameters:
    
    routeKey - The route key for the route.
  - getRouteKey
```
public String getRouteKey()
```
    The route key for the route.
    
    Returns:
    
    The route key for the route.
  - withRouteKey
```
public Route withRouteKey(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.
  - setRouteResponseSelectionExpression
```
public void setRouteResponseSelectionExpression(String routeResponseSelectionExpression)
```
    The route response selection expression for the route.
    
    Parameters:
    
    routeResponseSelectionExpression - The route response selection expression for the route.
  - getRouteResponseSelectionExpression
```
public String getRouteResponseSelectionExpression()
```
    The route response selection expression for the route.
    
    Returns:
    
    The route response selection expression for the route.
  - withRouteResponseSelectionExpression
```
public Route withRouteResponseSelectionExpression(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.
  - setTarget
```
public void setTarget(String target)
```
    The target for the route.
    
    Parameters:
    
    target - The target for the route.
  - getTarget
```
public String getTarget()
```
    The target for the route.
    
    Returns:
    
    The target for the route.
  - withTarget
```
public Route withTarget(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.
  - 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Route clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Route

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Route

Method Detail

setApiKeyRequired

getApiKeyRequired

withApiKeyRequired

isApiKeyRequired

getAuthorizationScopes

setAuthorizationScopes

withAuthorizationScopes

withAuthorizationScopes

setAuthorizationType

getAuthorizationType

withAuthorizationType

withAuthorizationType

setAuthorizerId

getAuthorizerId

withAuthorizerId

setModelSelectionExpression

getModelSelectionExpression

withModelSelectionExpression

setOperationName

getOperationName

withOperationName

getRequestModels

setRequestModels

withRequestModels

addRequestModelsEntry

clearRequestModelsEntries

getRequestParameters

setRequestParameters

withRequestParameters

addRequestParametersEntry

clearRequestParametersEntries

setRouteId

getRouteId

withRouteId

setRouteKey

getRouteKey

withRouteKey

setRouteResponseSelectionExpression

getRouteResponseSelectionExpression

withRouteResponseSelectionExpression

setTarget

getTarget

withTarget

toString

equals

hashCode

clone

marshall