@Generated(value="software.amazon.awssdk:codegen") public final class CreateRouteRequest extends ApiGatewayV2Request implements ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>
Creates a new Route resource to represent a route.
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateRouteRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
String |
apiId()
The API identifier.
|
Boolean |
apiKeyRequired()
Specifies whether an API key is required for the route.
|
List<String> |
authorizationScopes()
The authorization scopes supported by this 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 CreateRouteRequest.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasAuthorizationScopes()
For responses, this returns true if the service returned a value for the AuthorizationScopes property.
|
int |
hashCode() |
boolean |
hasRequestModels()
For responses, this returns true if the service returned a value for the RequestModels property.
|
boolean |
hasRequestParameters()
For responses, this returns true if the service returned a value for the RequestParameters property.
|
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 |
routeKey()
The route key for the route.
|
String |
routeResponseSelectionExpression()
The route response selection expression for the route.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateRouteRequest.Builder> |
serializableBuilderClass() |
String |
target()
The target for the route.
|
CreateRouteRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String apiId()
The API identifier.
public final Boolean apiKeyRequired()
Specifies whether an API key is required for the route. Supported only for WebSocket APIs.
public final boolean hasAuthorizationScopes()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<String> authorizationScopes()
The authorization scopes supported by this route.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasAuthorizationScopes() method.
public final 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().
AuthorizationTypepublic final 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().
AuthorizationTypepublic final 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.
public final String modelSelectionExpression()
The model selection expression for the route. Supported only for WebSocket APIs.
public final String operationName()
The operation name for the route.
public final boolean hasRequestModels()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRequestModels() method.
public final boolean hasRequestParameters()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasRequestParameters() method.
public final String routeKey()
The route key for the route.
public final String routeResponseSelectionExpression()
The route response selection expression for the route. Supported only for WebSocket APIs.
public final String target()
The target for the route.
public CreateRouteRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>toBuilder in class ApiGatewayV2Requestpublic static CreateRouteRequest.Builder builder()
public static Class<? extends CreateRouteRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.