Class ResponseInspectionBodyContains
- java.lang.Object
-
- software.amazon.awssdk.services.wafv2.model.ResponseInspectionBodyContains
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ResponseInspectionBodyContains.Builder,ResponseInspectionBodyContains>
@Generated("software.amazon.awssdk:codegen") public final class ResponseInspectionBodyContains extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ResponseInspectionBodyContains.Builder,ResponseInspectionBodyContains>
Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the
ResponseInspectionconfiguration forAWSManagedRulesATPRuleSetandAWSManagedRulesACFPRuleSet.Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceResponseInspectionBodyContains.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ResponseInspectionBodyContains.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>failureStrings()Strings in the body of the response that indicate a failed login or account creation attempt.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFailureStrings()For responses, this returns true if the service returned a value for the FailureStrings property.inthashCode()booleanhasSuccessStrings()For responses, this returns true if the service returned a value for the SuccessStrings property.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends ResponseInspectionBodyContains.Builder>serializableBuilderClass()List<String>successStrings()Strings in the body of the response that indicate a successful login or account creation attempt.ResponseInspectionBodyContains.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasSuccessStrings
public final boolean hasSuccessStrings()
For responses, this returns true if the service returned a value for the SuccessStrings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
successStrings
public final List<String> successStrings()
Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]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
hasSuccessStrings()method.- Returns:
- Strings in the body of the response that indicate a successful login or account creation attempt. To be
counted as a success, the string can be anywhere in the body and must be an exact match, including case.
Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
-
hasFailureStrings
public final boolean hasFailureStrings()
For responses, this returns true if the service returned a value for the FailureStrings property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
failureStrings
public final List<String> failureStrings()
Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]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
hasFailureStrings()method.- Returns:
- Strings in the body of the response that indicate a failed login or account creation attempt. To be
counted as a failure, the string can be anywhere in the body and must be an exact match, including case.
Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
-
toBuilder
public ResponseInspectionBodyContains.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<ResponseInspectionBodyContains.Builder,ResponseInspectionBodyContains>
-
builder
public static ResponseInspectionBodyContains.Builder builder()
-
serializableBuilderClass
public static Class<? extends ResponseInspectionBodyContains.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-