CreateRouteRequest (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request
    - - software.amazon.awssdk.services.apigatewayv2.model.CreateRouteRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateRouteRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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`	`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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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

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

- Method Detail
  - apiId
```
public final String apiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - apiKeyRequired
```
public final Boolean apiKeyRequired()
```
    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.
  - hasAuthorizationScopes
```
public final 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 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.
    
    You can use hasAuthorizationScopes() to see if a value was sent in this field.
    
    Returns:
    
    The authorization scopes supported by this route.
  - authorizationType
```
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().
    
    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 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().
    
    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 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.
    
    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 final 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 final String operationName()
```
    The operation name for the route.
    
    Returns:
    
    The operation name for the route.
  - hasRequestModels
```
public final 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 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.
    
    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 final 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 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.
    
    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.
  - routeKey
```
public final String routeKey()
```
    The route key for the route.
    
    Returns:
    
    The route key for the route.
  - routeResponseSelectionExpression
```
public final 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 final String target()
```
    The target for the route.
    
    Returns:
    
    The target for the route.
  - toBuilder
```
public CreateRouteRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayV2Request
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateRouteRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRouteRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo 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.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. 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.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.16.39

Class CreateRouteRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

apiId

apiKeyRequired

hasAuthorizationScopes

authorizationScopes

authorizationType

authorizationTypeAsString

authorizerId

modelSelectionExpression

operationName

hasRequestModels

requestModels

hasRequestParameters

requestParameters

routeKey

routeResponseSelectionExpression

target

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields