Class UpdateRouteRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateRouteRequest.Builder,
UpdateRouteRequest>
Updates a Route.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
apiId()
The API identifier.final Boolean
Specifies whether an API key is required for the route.The authorization scopes supported by this route.final AuthorizationType
The authorization type for the route.final String
The authorization type for the route.final String
The identifier of the Authorizer resource to be associated with this route.static UpdateRouteRequest.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the AuthorizationScopes property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RequestModels property.final boolean
For responses, this returns true if the service returned a value for the RequestParameters property.final String
The model selection expression for the route.final String
The operation name for the route.The request models for the route.final Map
<String, ParameterConstraints> The request parameters for the route.final String
routeId()
The route ID.final String
routeKey()
The route key for the route.final String
The route response selection expression for the route.static Class
<? extends UpdateRouteRequest.Builder> final String
target()
The target for the route.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
apiId
The API identifier.
- Returns:
- The API identifier.
-
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()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 theisEmpty()
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
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.- Returns:
- The authorization scopes supported by this route.
-
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 returnAuthorizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthorizationTypeAsString()
.- 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:
-
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 returnAuthorizationType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromauthorizationTypeAsString()
.- 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:
-
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
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
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 theisEmpty()
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
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 theisEmpty()
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
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
The route ID.
- Returns:
- The route ID.
-
routeKey
The route key for the route.
- Returns:
- The route key for the route.
-
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
The target for the route.
- Returns:
- The target for the route.
-
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 interfaceToCopyableBuilder<UpdateRouteRequest.Builder,
UpdateRouteRequest> - Specified by:
toBuilder
in classApiGatewayV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-