Class CustomResponseBody

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

The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey.

See Also:

  • Method Details

    • contentType

      public final ResponseContentType contentType()

      The type of content in the payload that you are defining in the Content string.

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

      Returns:
      The type of content in the payload that you are defining in the Content string.
      See Also:

    • contentTypeAsString

      public final String contentTypeAsString()

      The type of content in the payload that you are defining in the Content string.

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

      Returns:
      The type of content in the payload that you are defining in the Content string.
      See Also:

    • content

      public final String content()

      The payload of the custom response.

      You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

      For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

      Returns:
      The payload of the custom response.

      You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the ContentType setting.

      For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

    • toBuilder

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

    • builder

      public static CustomResponseBody.Builder builder()

    • serializableBuilderClass

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