Class GatewayResponse

java.lang.Object
software.amazon.awssdk.services.apigateway.model.GatewayResponse
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<GatewayResponse.Builder,GatewayResponse>
@Generated("software.amazon.awssdk:codegen") public final class GatewayResponse extends Object implements SdkPojo, Serializable, ToCopyableBuilder<GatewayResponse.Builder,GatewayResponse>

A gateway response of a given response type and status code, with optional response parameters and mapping templates.

See Also:

  • Method Details

    • responseType

      public final GatewayResponseType responseType()

      The response type of the associated GatewayResponse.

      If the service returns an enum value that is not available in the current SDK version, responseType will return GatewayResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseTypeAsString().

      Returns:
      The response type of the associated GatewayResponse.
      See Also:

    • responseTypeAsString

      public final String responseTypeAsString()

      The response type of the associated GatewayResponse.

      If the service returns an enum value that is not available in the current SDK version, responseType will return GatewayResponseType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from responseTypeAsString().

      Returns:
      The response type of the associated GatewayResponse.
      See Also:

    • statusCode

      public final String statusCode()

      The HTTP status code for this GatewayResponse.

      Returns:
      The HTTP status code for this GatewayResponse.

    • hasResponseParameters

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

    • responseParameters

      public final Map<String,String> responseParameters()

      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

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

      Returns:
      Response parameters (paths, query strings and headers) of the GatewayResponse as a string-to-string map of key-value pairs.

    • hasResponseTemplates

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

    • responseTemplates

      public final Map<String,String> responseTemplates()

      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

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

      Returns:
      Response templates of the GatewayResponse as a string-to-string map of key-value pairs.

    • defaultResponse

      public final Boolean defaultResponse()

      A Boolean flag to indicate whether this GatewayResponse is the default gateway response (true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

      Returns:
      A Boolean flag to indicate whether this GatewayResponse is the default gateway response ( true) or not (false). A default gateway response is one generated by API Gateway without any customization by an API developer.

    • toBuilder

      public GatewayResponse.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<GatewayResponse.Builder,GatewayResponse>
      Returns:
      a builder for type T

    • builder

      public static GatewayResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GatewayResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.