@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Route extends Object implements Serializable, Cloneable, StructuredPojo
Represents a route.
Constructor and Description |
---|
Route() |
Modifier and Type | Method and Description |
---|---|
Route |
addRequestModelsEntry(String key,
String value)
Add a single RequestModels entry
|
Route |
addRequestParametersEntry(String key,
ParameterConstraints value)
Add a single RequestParameters entry
|
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 |
getApiGatewayManaged()
Specifies whether a route is managed by API Gateway.
|
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.
|
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 |
isApiGatewayManaged()
Specifies whether a route is managed by API Gateway.
|
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 |
setApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether a route is managed by API Gateway.
|
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.
|
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 |
withApiGatewayManaged(Boolean apiGatewayManaged)
Specifies whether a route is managed by API Gateway.
|
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.
|
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.
|
public void setApiGatewayManaged(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.
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.public Boolean getApiGatewayManaged()
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.
public Route withApiGatewayManaged(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.
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.public Boolean isApiGatewayManaged()
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.
public void setApiKeyRequired(Boolean apiKeyRequired)
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
apiKeyRequired
- Specifies whether an API key is required for this route. Supported only for WebSocket APIs.public Boolean getApiKeyRequired()
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
public Route withApiKeyRequired(Boolean apiKeyRequired)
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
apiKeyRequired
- Specifies whether an API key is required for this route. Supported only for WebSocket APIs.public Boolean isApiKeyRequired()
Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
public List<String> getAuthorizationScopes()
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.
public void setAuthorizationScopes(Collection<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.
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.public Route withAuthorizationScopes(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.
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.
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.public Route withAuthorizationScopes(Collection<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.
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.public void setAuthorizationType(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.
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.AuthorizationType
public String getAuthorizationType()
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.
AuthorizationType
public Route withAuthorizationType(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.
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.AuthorizationType
public Route withAuthorizationType(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.
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.AuthorizationType
public void setAuthorizerId(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.
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.public String getAuthorizerId()
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.
public Route withAuthorizerId(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.
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.public void setModelSelectionExpression(String modelSelectionExpression)
The model selection expression for the route. Supported only for WebSocket APIs.
modelSelectionExpression
- The model selection expression for the route. Supported only for WebSocket APIs.public String getModelSelectionExpression()
The model selection expression for the route. Supported only for WebSocket APIs.
public Route withModelSelectionExpression(String modelSelectionExpression)
The model selection expression for the route. Supported only for WebSocket APIs.
modelSelectionExpression
- The model selection expression for the route. Supported only for WebSocket APIs.public void setOperationName(String operationName)
The operation name for the route.
operationName
- The operation name for the route.public String getOperationName()
The operation name for the route.
public Route withOperationName(String operationName)
The operation name for the route.
operationName
- The operation name for the route.public Map<String,String> getRequestModels()
The request models for the route. Supported only for WebSocket APIs.
public void setRequestModels(Map<String,String> requestModels)
The request models for the route. Supported only for WebSocket APIs.
requestModels
- The request models for the route. Supported only for WebSocket APIs.public Route withRequestModels(Map<String,String> requestModels)
The request models for the route. Supported only for WebSocket APIs.
requestModels
- The request models for the route. Supported only for WebSocket APIs.public Route addRequestModelsEntry(String key, String value)
public Route clearRequestModelsEntries()
public Map<String,ParameterConstraints> getRequestParameters()
The request parameters for the route. Supported only for WebSocket APIs.
public void setRequestParameters(Map<String,ParameterConstraints> requestParameters)
The request parameters for the route. Supported only for WebSocket APIs.
requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.public Route withRequestParameters(Map<String,ParameterConstraints> requestParameters)
The request parameters for the route. Supported only for WebSocket APIs.
requestParameters
- The request parameters for the route. Supported only for WebSocket APIs.public Route addRequestParametersEntry(String key, ParameterConstraints value)
public Route clearRequestParametersEntries()
public void setRouteId(String routeId)
The route ID.
routeId
- The route ID.public String getRouteId()
The route ID.
public Route withRouteId(String routeId)
The route ID.
routeId
- The route ID.public void setRouteKey(String routeKey)
The route key for the route.
routeKey
- The route key for the route.public String getRouteKey()
The route key for the route.
public Route withRouteKey(String routeKey)
The route key for the route.
routeKey
- The route key for the route.public void setRouteResponseSelectionExpression(String routeResponseSelectionExpression)
The route response selection expression for the route. Supported only for WebSocket APIs.
routeResponseSelectionExpression
- The route response selection expression for the route. Supported only for WebSocket APIs.public String getRouteResponseSelectionExpression()
The route response selection expression for the route. Supported only for WebSocket APIs.
public Route withRouteResponseSelectionExpression(String routeResponseSelectionExpression)
The route response selection expression for the route. Supported only for WebSocket APIs.
routeResponseSelectionExpression
- The route response selection expression for the route. Supported only for WebSocket APIs.public void setTarget(String target)
The target for the route.
target
- The target for the route.public String getTarget()
The target for the route.
public Route withTarget(String target)
The target for the route.
target
- The target for the route.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.