Class UpdateRouteRequest

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.UpdateRouteRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateRouteRequest.Builder,UpdateRouteRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateRouteRequest extends ApiGatewayV2Request implements ToCopyableBuilder<UpdateRouteRequest.Builder,UpdateRouteRequest>

Updates a Route.

  • Method Details

    • 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()
      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()

      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

      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:

    • 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:

    • 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 UpdateRouteRequest.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<UpdateRouteRequest.Builder,UpdateRouteRequest>
      Specified by:
      toBuilder in class ApiGatewayV2Request
      Returns:
      a builder for type T

    • builder

      public static UpdateRouteRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateRouteRequest.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.