Class ResponseInspectionStatusCode
- All Implemented Interfaces:
Serializable,SdkPojo,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:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final booleanfinal booleanequalsBySdkFields(Object obj) Status codes in the response that indicate a failed login or account creation attempt.final <T> Optional<T>getValueForField(String fieldName, Class<T> clazz) final booleanFor responses, this returns true if the service returned a value for the FailureCodes property.final inthashCode()final booleanFor responses, this returns true if the service returned a value for the SuccessCodes property.static Class<? extends ResponseInspectionStatusCode.Builder>Status codes in the response that indicate a successful login or account creation attempt.final StringtoString()Returns a string representation of this object.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
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 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. -
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 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. -
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
- Specified by:
toBuilderin interfaceToCopyableBuilder<ResponseInspectionStatusCode.Builder,ResponseInspectionStatusCode>
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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. -
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-