com.amazonaws.services.wafv2.model.CaptchaResponse Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The result from the inspection of the web request for a valid CAPTCHA token.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CaptchaResponse implements Serializable, Cloneable, StructuredPojo {
/**
*
* The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token
* is missing, invalid, or expired, this code is 405 Method Not Allowed.
*
*/
private Integer responseCode;
/**
*
* The time that the CAPTCHA was last solved for the supplied token.
*
*/
private Long solveTimestamp;
/**
*
* The reason for failure, populated when the evaluation of the token fails.
*
*/
private String failureReason;
/**
*
* The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token
* is missing, invalid, or expired, this code is 405 Method Not Allowed.
*
*
* @param responseCode
* The HTTP response code indicating the status of the CAPTCHA token in the web request. If the
* token is missing, invalid, or expired, this code is 405 Method Not Allowed.
*/
public void setResponseCode(Integer responseCode) {
this.responseCode = responseCode;
}
/**
*
* The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token
* is missing, invalid, or expired, this code is 405 Method Not Allowed.
*
*
* @return The HTTP response code indicating the status of the CAPTCHA token in the web request. If the
* token is missing, invalid, or expired, this code is 405 Method Not Allowed.
*/
public Integer getResponseCode() {
return this.responseCode;
}
/**
*
* The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token
* is missing, invalid, or expired, this code is 405 Method Not Allowed.
*
*
* @param responseCode
* The HTTP response code indicating the status of the CAPTCHA token in the web request. If the
* token is missing, invalid, or expired, this code is 405 Method Not Allowed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CaptchaResponse withResponseCode(Integer responseCode) {
setResponseCode(responseCode);
return this;
}
/**
*
* The time that the CAPTCHA was last solved for the supplied token.
*
*
* @param solveTimestamp
* The time that the CAPTCHA was last solved for the supplied token.
*/
public void setSolveTimestamp(Long solveTimestamp) {
this.solveTimestamp = solveTimestamp;
}
/**
*
* The time that the CAPTCHA was last solved for the supplied token.
*
*
* @return The time that the CAPTCHA was last solved for the supplied token.
*/
public Long getSolveTimestamp() {
return this.solveTimestamp;
}
/**
*
* The time that the CAPTCHA was last solved for the supplied token.
*
*
* @param solveTimestamp
* The time that the CAPTCHA was last solved for the supplied token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CaptchaResponse withSolveTimestamp(Long solveTimestamp) {
setSolveTimestamp(solveTimestamp);
return this;
}
/**
*
* The reason for failure, populated when the evaluation of the token fails.
*
*
* @param failureReason
* The reason for failure, populated when the evaluation of the token fails.
* @see FailureReason
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* The reason for failure, populated when the evaluation of the token fails.
*
*
* @return The reason for failure, populated when the evaluation of the token fails.
* @see FailureReason
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* The reason for failure, populated when the evaluation of the token fails.
*
*
* @param failureReason
* The reason for failure, populated when the evaluation of the token fails.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FailureReason
*/
public CaptchaResponse withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* The reason for failure, populated when the evaluation of the token fails.
*
*
* @param failureReason
* The reason for failure, populated when the evaluation of the token fails.
* @return Returns a reference to this object so that method calls can be chained together.
* @see FailureReason
*/
public CaptchaResponse withFailureReason(FailureReason failureReason) {
this.failureReason = failureReason.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getResponseCode() != null)
sb.append("ResponseCode: ").append(getResponseCode()).append(",");
if (getSolveTimestamp() != null)
sb.append("SolveTimestamp: ").append(getSolveTimestamp()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CaptchaResponse == false)
return false;
CaptchaResponse other = (CaptchaResponse) obj;
if (other.getResponseCode() == null ^ this.getResponseCode() == null)
return false;
if (other.getResponseCode() != null && other.getResponseCode().equals(this.getResponseCode()) == false)
return false;
if (other.getSolveTimestamp() == null ^ this.getSolveTimestamp() == null)
return false;
if (other.getSolveTimestamp() != null && other.getSolveTimestamp().equals(this.getSolveTimestamp()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getResponseCode() == null) ? 0 : getResponseCode().hashCode());
hashCode = prime * hashCode + ((getSolveTimestamp() == null) ? 0 : getSolveTimestamp().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
return hashCode;
}
@Override
public CaptchaResponse clone() {
try {
return (CaptchaResponse) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.wafv2.model.transform.CaptchaResponseMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}