Package software.amazon.awssdk.services.apigateway.model

Class TestInvokeMethodRequest

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

Make a request to simulate the invocation of a Method.

  • Method Details

    • restApiId

      public final String restApiId()

      The string identifier of the associated RestApi.

      Returns:
      The string identifier of the associated RestApi.

    • resourceId

      public final String resourceId()

      Specifies a test invoke method request's resource ID.

      Returns:
      Specifies a test invoke method request's resource ID.

    • httpMethod

      public final String httpMethod()

      Specifies a test invoke method request's HTTP method.

      Returns:
      Specifies a test invoke method request's HTTP method.

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

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

      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.

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

      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.

    • clientCertificateId

      public final String clientCertificateId()

      A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

      Returns:
      A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.

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

    • toBuilder

      public TestInvokeMethodRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<TestInvokeMethodRequest.Builder,TestInvokeMethodRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest

    • builder

      public static TestInvokeMethodRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends TestInvokeMethodRequest.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)
      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 SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo