CreateRouteRequest (AWS Java SDK :: Services

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>

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, if the authorizationType is CUSTOM .
`static CreateRouteRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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()`
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - apiId
```
public String apiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - apiKeyRequired
```
public Boolean apiKeyRequired()
```
    Specifies whether an API key is required for the route.
    
    Returns:
    
    Specifies whether an API key is required for the route.
  - authorizationScopes
```
public List<String> authorizationScopes()
```
    The authorization scopes supported by this route.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The authorization scopes supported by this route.
  - authorizationType
```
public 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.
    
    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. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
    
    See Also:
    
    AuthorizationType
  - authorizationTypeAsString
```
public String authorizationTypeAsString()
```
    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.
    
    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. Valid values are NONE for open access, AWS_IAM for using AWS IAM permissions, and CUSTOM for using a Lambda authorizer.
    
    See Also:
    
    AuthorizationType
  - authorizerId
```
public 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.
    
    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.
  - modelSelectionExpression
```
public String modelSelectionExpression()
```
    The model selection expression for the route.
    
    Returns:
    
    The model selection expression for the route.
  - operationName
```
public String operationName()
```
    The operation name for the route.
    
    Returns:
    
    The operation name for the route.
  - requestModels
```
public Map<String,String> requestModels()
```
    The request models for the route.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The request models for the route.
  - requestParameters
```
public Map<String,ParameterConstraints> requestParameters()
```
    The request parameters for the route.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    Returns:
    
    The request parameters for the route.
  - routeKey
```
public String routeKey()
```
    The route key for the route.
    
    Returns:
    
    The route key for the route.
  - routeResponseSelectionExpression
```
public String routeResponseSelectionExpression()
```
    The route response selection expression for the route.
    
    Returns:
    
    The route response selection expression for the route.
  - target
```
public String target()
```
    The target for the route.
    
    Returns:
    
    The target for the route.
  - toBuilder
```
public CreateRouteRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateRouteRequest.Builder,CreateRouteRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayV2Request
  - builder
```
public static CreateRouteRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRouteRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

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

authorizationScopes

authorizationType

authorizationTypeAsString

authorizerId

modelSelectionExpression

operationName

requestModels

requestParameters

routeKey

routeResponseSelectionExpression

target

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields