Class CustomResponse

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

A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

See Also:

  • Method Details

    • responseCode

      public final Integer responseCode()

      The HTTP status code to return to the client.

      For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

      Returns:
      The HTTP status code to return to the client.

      For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.

    • customResponseBodyKey

      public final String customResponseBodyKey()

      References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

      Returns:
      References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the CustomResponseBodies setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default action BlockAction setting, you reference the response body using this key.

    • hasResponseHeaders

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

    • responseHeaders

      public final List<CustomHTTPHeader> responseHeaders()

      The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

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

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

      Returns:
      The HTTP headers to use in the response. You can specify any header name except for content-type. Duplicate header names are not allowed.

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

    • builder

      public static CustomResponse.Builder builder()

    • serializableBuilderClass

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