Class ResponseInspectionStatusCode

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

Configures inspection of the response status code. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet.

Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

See Also:

  • Method Details

    • hasSuccessCodes

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

    • successCodes

      public final List<Integer> successCodes()

      Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.

      JSON example: "SuccessCodes": [ 200, 201 ]

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

      Returns:
      Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.

      JSON example: "SuccessCodes": [ 200, 201 ]

    • hasFailureCodes

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

    • failureCodes

      public final List<Integer> failureCodes()

      Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.

      JSON example: "FailureCodes": [ 400, 404 ]

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

      Returns:
      Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.

      JSON example: "FailureCodes": [ 400, 404 ]

    • toBuilder

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

    • builder

      public static ResponseInspectionStatusCode.Builder builder()

    • serializableBuilderClass

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