CreateRouteResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
    - - software.amazon.awssdk.services.apigatewayv2.model.CreateRouteResponse

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

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRouteResponse
extends ApiGatewayV2Response
implements ToCopyableBuilder<CreateRouteResponse.Builder,CreateRouteResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateRouteResponse.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Boolean`	`apiGatewayManaged()` Specifies whether a route is managed by API Gateway.
`Boolean`	`apiKeyRequired()` Specifies whether an API key is required for this route.
`List<String>`	`authorizationScopes()` A list of authorization scopes configured on a 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 CreateRouteResponse.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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`	`routeId()` The route ID.
`String`	`routeKey()` The route key for the route.
`String`	`routeResponseSelectionExpression()` The route response selection expression for the route.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateRouteResponse.Builder>`	`serializableBuilderClass()`
`String`	`target()` The target for the route.
`CreateRouteResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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
  - apiGatewayManaged
```
public final 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.
    
    Returns:
    
    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.
  - apiKeyRequired
```
public final Boolean apiKeyRequired()
```
    Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
    
    Returns:
    
    Specifies whether an API key is required for this route. Supported only for WebSocket APIs.
  - hasAuthorizationScopes
```
public final boolean hasAuthorizationScopes()
```
    For responses, this returns true if the service returned a value for the AuthorizationScopes property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - authorizationScopes
```
public final List<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.
    
    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.
    
    Returns:
    
    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.
  - 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()
```
    For responses, this returns true if the service returned a value for the RequestModels property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - 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.
    
    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.
    
    Returns:
    
    The request models for the route. Supported only for WebSocket APIs.
  - hasRequestParameters
```
public final boolean hasRequestParameters()
```
    For responses, this returns true if the service returned a value for the RequestParameters property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - 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.
    
    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.
    
    Returns:
    
    The request parameters for the route. Supported only for WebSocket APIs.
  - routeId
```
public final String routeId()
```
    The route ID.
    
    Returns:
    
    The route ID.
  - 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 CreateRouteResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateRouteResponse.Builder,CreateRouteResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static CreateRouteResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateRouteResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateRouteResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Response

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

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

Method Detail

apiGatewayManaged

apiKeyRequired

hasAuthorizationScopes

authorizationScopes

authorizationType

authorizationTypeAsString

authorizerId

modelSelectionExpression

operationName

hasRequestModels

requestModels

hasRequestParameters

requestParameters

routeId

routeKey

routeResponseSelectionExpression

target

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields