Class TestInvokeAuthorizerRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
software.amazon.awssdk.services.apigateway.model.TestInvokeAuthorizerRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>
@Generated("software.amazon.awssdk:codegen") public final class TestInvokeAuthorizerRequest extends ApiGatewayRequest implements ToCopyableBuilder<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>

Make a request to simulate the invocation of an Authorizer.

  • Method Details

    • restApiId

      public final String restApiId()

      The string identifier of the associated RestApi.

      Returns:
      The string identifier of the associated RestApi.

    • authorizerId

      public final String authorizerId()

      Specifies a test invoke authorizer request's Authorizer ID.

      Returns:
      Specifies a test invoke authorizer request's Authorizer ID.

    • hasHeaders

      public final boolean hasHeaders()
      For responses, this returns true if the service returned a value for the Headers 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.

    • headers

      public final Map<String,String> headers()

      A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

      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 hasHeaders() method.

      Returns:
      A key-value map of headers to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, should be specified.

    • hasMultiValueHeaders

      public final boolean hasMultiValueHeaders()
      For responses, this returns true if the service returned a value for the MultiValueHeaders 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.

    • multiValueHeaders

      public final Map<String,List<String>> multiValueHeaders()

      The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

      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 hasMultiValueHeaders() method.

      Returns:
      The headers as a map from string to list of values to simulate an incoming invocation request. This is where the incoming authorization token, or identity source, may be specified.

    • pathWithQueryString

      public final String pathWithQueryString()

      The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

      Returns:
      The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.

    • body

      public final String body()

      The simulated request body of an incoming invocation request.

      Returns:
      The simulated request body of an incoming invocation request.

    • hasStageVariables

      public final boolean hasStageVariables()
      For responses, this returns true if the service returned a value for the StageVariables 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.

    • stageVariables

      public final Map<String,String> stageVariables()

      A key-value map of stage variables to simulate an invocation on a deployed Stage.

      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 hasStageVariables() method.

      Returns:
      A key-value map of stage variables to simulate an invocation on a deployed Stage.

    • hasAdditionalContext

      public final boolean hasAdditionalContext()
      For responses, this returns true if the service returned a value for the AdditionalContext 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.

    • additionalContext

      public final Map<String,String> additionalContext()

      A key-value map of additional context variables.

      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 hasAdditionalContext() method.

      Returns:
      A key-value map of additional context variables.

    • toBuilder

      public TestInvokeAuthorizerRequest.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<TestInvokeAuthorizerRequest.Builder,TestInvokeAuthorizerRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest
      Returns:
      a builder for type T

    • builder

      public static TestInvokeAuthorizerRequest.Builder builder()

    • serializableBuilderClass

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