com.amazonaws.services.apigatewayv2.model

Class CreateRouteRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.apigatewayv2.model.CreateRouteRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Creates a new Route resource to represent a route.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRouteRequest()

Method Summary

Modifier and Type	Method and Description
CreateRouteRequest	addRequestModelsEntry(String key, String value) Add a single RequestModels entry
CreateRouteRequest	addRequestParametersEntry(String key, ParameterConstraints value) Add a single RequestParameters entry
CreateRouteRequest	clearRequestModelsEntries() Removes all the entries added into RequestModels.
CreateRouteRequest	clearRequestParametersEntries() Removes all the entries added into RequestParameters.
CreateRouteRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApiId() The API identifier.
Boolean	getApiKeyRequired() Specifies whether an API key is required for the route.
List<String>	getAuthorizationScopes() The authorization scopes supported by this 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	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 the route.
void	setApiId(String apiId) The API identifier.
void	setApiKeyRequired(Boolean apiKeyRequired) Specifies whether an API key is required for the route.
void	setAuthorizationScopes(Collection<String> authorizationScopes) The authorization scopes supported by this 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	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.
CreateRouteRequest	withApiId(String apiId) The API identifier.
CreateRouteRequest	withApiKeyRequired(Boolean apiKeyRequired) Specifies whether an API key is required for the route.
CreateRouteRequest	withAuthorizationScopes(Collection<String> authorizationScopes) The authorization scopes supported by this route.
CreateRouteRequest	withAuthorizationScopes(String... authorizationScopes) The authorization scopes supported by this route.
CreateRouteRequest	withAuthorizationType(AuthorizationType authorizationType) The authorization type for the route.
CreateRouteRequest	withAuthorizationType(String authorizationType) The authorization type for the route.
CreateRouteRequest	withAuthorizerId(String authorizerId) The identifier of the Authorizer resource to be associated with this route.
CreateRouteRequest	withModelSelectionExpression(String modelSelectionExpression) The model selection expression for the route.
CreateRouteRequest	withOperationName(String operationName) The operation name for the route.
CreateRouteRequest	withRequestModels(Map<String,String> requestModels) The request models for the route.
CreateRouteRequest	withRequestParameters(Map<String,ParameterConstraints> requestParameters) The request parameters for the route.
CreateRouteRequest	withRouteKey(String routeKey) The route key for the route.
CreateRouteRequest	withRouteResponseSelectionExpression(String routeResponseSelectionExpression) The route response selection expression for the route.
CreateRouteRequest	withTarget(String target) The target for the route.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRouteRequest

public CreateRouteRequest()

Method Detail

setApiId

public void setApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

getApiId

public String getApiId()

The API identifier.

Returns:

The API identifier.

withApiId

public CreateRouteRequest withApiId(String apiId)

The API identifier.

Parameters:

apiId - The API identifier.

Returns:

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

setApiKeyRequired

public void setApiKeyRequired(Boolean apiKeyRequired)

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

getApiKeyRequired

public Boolean getApiKeyRequired()

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Returns:

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

withApiKeyRequired

public CreateRouteRequest withApiKeyRequired(Boolean apiKeyRequired)

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

Parameters:

apiKeyRequired - Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

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 the route. Supported only for WebSocket APIs.

Returns:

Specifies whether an API key is required for the route. Supported only for WebSocket APIs.

getAuthorizationScopes

public List<String> getAuthorizationScopes()

The authorization scopes supported by this route.

Returns:

The authorization scopes supported by this route.

setAuthorizationScopes

public void setAuthorizationScopes(Collection<String> authorizationScopes)

The authorization scopes supported by this route.

Parameters:

authorizationScopes - The authorization scopes supported by this route.

withAuthorizationScopes

public CreateRouteRequest withAuthorizationScopes(String... authorizationScopes)

The authorization scopes supported by this route.

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 - The authorization scopes supported by this route.

Returns:

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

withAuthorizationScopes

public CreateRouteRequest withAuthorizationScopes(Collection<String> authorizationScopes)

The authorization scopes supported by this route.

Parameters:

authorizationScopes - The authorization scopes supported by this route.

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

Parameters:

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.

See Also:

AuthorizationType

getAuthorizationType

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.

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

withAuthorizationType

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

Parameters:

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.

Returns:

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

See Also:

AuthorizationType

withAuthorizationType

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

Parameters:

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.

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

withAuthorizerId

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

Parameters:

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:

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. Supported only for WebSocket APIs.

Parameters:

modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

getModelSelectionExpression

public String getModelSelectionExpression()

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.

withModelSelectionExpression

public CreateRouteRequest withModelSelectionExpression(String modelSelectionExpression)

The model selection expression for the route. Supported only for WebSocket APIs.

Parameters:

modelSelectionExpression - The model selection expression for the route. Supported only for WebSocket APIs.

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 CreateRouteRequest 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. Supported only for WebSocket APIs.

Returns:

The request models for the route. Supported only for WebSocket APIs.

setRequestModels

public void setRequestModels(Map<String,String> requestModels)

The request models for the route. Supported only for WebSocket APIs.

Parameters:

requestModels - The request models for the route. Supported only for WebSocket APIs.

withRequestModels

public CreateRouteRequest withRequestModels(Map<String,String> requestModels)

The request models for the route. Supported only for WebSocket APIs.

Parameters:

requestModels - The request models for the route. Supported only for WebSocket APIs.

Returns:

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

addRequestModelsEntry

public CreateRouteRequest addRequestModelsEntry(String key,
                                                String value)

Add a single RequestModels entry

See Also:

withRequestModels(java.util.Map<java.lang.String, java.lang.String>)

clearRequestModelsEntries

public CreateRouteRequest 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. Supported only for WebSocket APIs.

Returns:

The request parameters for the route. Supported only for WebSocket APIs.

setRequestParameters

public void setRequestParameters(Map<String,ParameterConstraints> requestParameters)

The request parameters for the route. Supported only for WebSocket APIs.

Parameters:

requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

withRequestParameters

public CreateRouteRequest withRequestParameters(Map<String,ParameterConstraints> requestParameters)

The request parameters for the route. Supported only for WebSocket APIs.

Parameters:

requestParameters - The request parameters for the route. Supported only for WebSocket APIs.

Returns:

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

addRequestParametersEntry

public CreateRouteRequest addRequestParametersEntry(String key,
                                                    ParameterConstraints value)

Add a single RequestParameters entry

See Also:

withRequestParameters(java.util.Map<java.lang.String, com.amazonaws.services.apigatewayv2.model.ParameterConstraints>)

clearRequestParametersEntries

public CreateRouteRequest clearRequestParametersEntries()

Removes all the entries added into RequestParameters.

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 CreateRouteRequest 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. Supported only for WebSocket APIs.

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

getRouteResponseSelectionExpression

public String getRouteResponseSelectionExpression()

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.

withRouteResponseSelectionExpression

public CreateRouteRequest withRouteResponseSelectionExpression(String routeResponseSelectionExpression)

The route response selection expression for the route. Supported only for WebSocket APIs.

Parameters:

routeResponseSelectionExpression - The route response selection expression for the route. Supported only for WebSocket APIs.

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 CreateRouteRequest 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 CreateRouteRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()