* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests.
* A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web
* ACL defines the label namespace.
*
* labels;
/**
*
* The CAPTCHA response for the request.
*
*/
private CaptchaResponse captchaResponse;
/**
*
* The Challenge response for the request.
*
*/
private ChallengeResponse challengeResponse;
/**
*
* Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that
* the rule group rule is configured for, and not the action that was applied to the request. The action that WAF
* applied is the Action value.
*
*/
private String overriddenAction;
/**
*
* A complex type that contains detailed information about the request.
*
*
* @param request
* A complex type that contains detailed information about the request.
*/
public void setRequest(HTTPRequest request) {
this.request = request;
}
/**
*
* A complex type that contains detailed information about the request.
*
*
* @return A complex type that contains detailed information about the request.
*/
public HTTPRequest getRequest() {
return this.request;
}
/**
*
* A complex type that contains detailed information about the request.
*
*
* @param request
* A complex type that contains detailed information about the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withRequest(HTTPRequest request) {
setRequest(request);
return this;
}
/**
*
* A value that indicates how one result in the response relates proportionally to other results in the response.
* For example, a result that has a weight of 2 represents roughly twice as many web requests as a
* result that has a weight of 1.
*
*
* @param weight
* A value that indicates how one result in the response relates proportionally to other results in the
* response. For example, a result that has a weight of 2 represents roughly twice as many web
* requests as a result that has a weight of 1.
*/
public void setWeight(Long weight) {
this.weight = weight;
}
/**
*
* A value that indicates how one result in the response relates proportionally to other results in the response.
* For example, a result that has a weight of 2 represents roughly twice as many web requests as a
* result that has a weight of 1.
*
*
* @return A value that indicates how one result in the response relates proportionally to other results in the
* response. For example, a result that has a weight of 2 represents roughly twice as many web
* requests as a result that has a weight of 1.
*/
public Long getWeight() {
return this.weight;
}
/**
*
* A value that indicates how one result in the response relates proportionally to other results in the response.
* For example, a result that has a weight of 2 represents roughly twice as many web requests as a
* result that has a weight of 1.
*
*
* @param weight
* A value that indicates how one result in the response relates proportionally to other results in the
* response. For example, a result that has a weight of 2 represents roughly twice as many web
* requests as a result that has a weight of 1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withWeight(Long weight) {
setWeight(weight);
return this;
}
/**
*
* The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in
* seconds).
*
*
* @param timestamp
* The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in
* seconds).
*/
public void setTimestamp(java.util.Date timestamp) {
this.timestamp = timestamp;
}
/**
*
* The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in
* seconds).
*
*
* @return The time at which WAF received the request from your Amazon Web Services resource, in Unix time format
* (in seconds).
*/
public java.util.Date getTimestamp() {
return this.timestamp;
}
/**
*
* The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in
* seconds).
*
*
* @param timestamp
* The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in
* seconds).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withTimestamp(java.util.Date timestamp) {
setTimestamp(timestamp);
return this;
}
/**
*
* The action that WAF applied to the request.
*
*
* @param action
* The action that WAF applied to the request.
*/
public void setAction(String action) {
this.action = action;
}
/**
*
* The action that WAF applied to the request.
*
*
* @return The action that WAF applied to the request.
*/
public String getAction() {
return this.action;
}
/**
*
* The action that WAF applied to the request.
*
*
* @param action
* The action that WAF applied to the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withAction(String action) {
setAction(action);
return this;
}
/**
*
* The name of the Rule that the request matched. For managed rule groups, the format for this name is
* <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the
* format for this name is <rule group name>#<rule name>. If the rule is not in a rule
* group, this field is absent.
*
*
* @param ruleNameWithinRuleGroup
* The name of the Rule that the request matched. For managed rule groups, the format for this
* name is <vendor name>#<managed rule group name>#<rule name>. For your own
* rule groups, the format for this name is <rule group name>#<rule name>. If the
* rule is not in a rule group, this field is absent.
*/
public void setRuleNameWithinRuleGroup(String ruleNameWithinRuleGroup) {
this.ruleNameWithinRuleGroup = ruleNameWithinRuleGroup;
}
/**
*
* The name of the Rule that the request matched. For managed rule groups, the format for this name is
* <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the
* format for this name is <rule group name>#<rule name>. If the rule is not in a rule
* group, this field is absent.
*
*
* @return The name of the Rule that the request matched. For managed rule groups, the format for this
* name is <vendor name>#<managed rule group name>#<rule name>. For your own
* rule groups, the format for this name is <rule group name>#<rule name>. If the
* rule is not in a rule group, this field is absent.
*/
public String getRuleNameWithinRuleGroup() {
return this.ruleNameWithinRuleGroup;
}
/**
*
* The name of the Rule that the request matched. For managed rule groups, the format for this name is
* <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the
* format for this name is <rule group name>#<rule name>. If the rule is not in a rule
* group, this field is absent.
*
*
* @param ruleNameWithinRuleGroup
* The name of the Rule that the request matched. For managed rule groups, the format for this
* name is <vendor name>#<managed rule group name>#<rule name>. For your own
* rule groups, the format for this name is <rule group name>#<rule name>. If the
* rule is not in a rule group, this field is absent.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withRuleNameWithinRuleGroup(String ruleNameWithinRuleGroup) {
setRuleNameWithinRuleGroup(ruleNameWithinRuleGroup);
return this;
}
/**
*
* Custom request headers inserted by WAF into the request, according to the custom request configuration for the
* matching rule action.
*
*
* @return Custom request headers inserted by WAF into the request, according to the custom request configuration
* for the matching rule action.
*/
public java.util.List getRequestHeadersInserted() {
return requestHeadersInserted;
}
/**
*
* Custom request headers inserted by WAF into the request, according to the custom request configuration for the
* matching rule action.
*
*
* @param requestHeadersInserted
* Custom request headers inserted by WAF into the request, according to the custom request configuration for
* the matching rule action.
*/
public void setRequestHeadersInserted(java.util.Collection requestHeadersInserted) {
if (requestHeadersInserted == null) {
this.requestHeadersInserted = null;
return;
}
this.requestHeadersInserted = new java.util.ArrayList(requestHeadersInserted);
}
/**
*
* Custom request headers inserted by WAF into the request, according to the custom request configuration for the
* matching rule action.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRequestHeadersInserted(java.util.Collection)} or
* {@link #withRequestHeadersInserted(java.util.Collection)} if you want to override the existing values.
*
*
* @param requestHeadersInserted
* Custom request headers inserted by WAF into the request, according to the custom request configuration for
* the matching rule action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withRequestHeadersInserted(HTTPHeader... requestHeadersInserted) {
if (this.requestHeadersInserted == null) {
setRequestHeadersInserted(new java.util.ArrayList(requestHeadersInserted.length));
}
for (HTTPHeader ele : requestHeadersInserted) {
this.requestHeadersInserted.add(ele);
}
return this;
}
/**
*
* Custom request headers inserted by WAF into the request, according to the custom request configuration for the
* matching rule action.
*
*
* @param requestHeadersInserted
* Custom request headers inserted by WAF into the request, according to the custom request configuration for
* the matching rule action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withRequestHeadersInserted(java.util.Collection requestHeadersInserted) {
setRequestHeadersInserted(requestHeadersInserted);
return this;
}
/**
*
* The response code that was sent for the request.
*
*
* @param responseCodeSent
* The response code that was sent for the request.
*/
public void setResponseCodeSent(Integer responseCodeSent) {
this.responseCodeSent = responseCodeSent;
}
/**
*
* The response code that was sent for the request.
*
*
* @return The response code that was sent for the request.
*/
public Integer getResponseCodeSent() {
return this.responseCodeSent;
}
/**
*
* The response code that was sent for the request.
*
*
* @param responseCodeSent
* The response code that was sent for the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withResponseCodeSent(Integer responseCodeSent) {
setResponseCodeSent(responseCodeSent);
return this;
}
/**
*
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests.
* A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web
* ACL defines the label namespace.
*
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
*
*
* @return Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web
* requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's
* rule group or web ACL defines the label namespace.
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
*/
public java.util.List getLabels() {
return labels;
}
/**
*
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests.
* A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web
* ACL defines the label namespace.
*
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
*
*
* @param labels
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web
* requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's
* rule group or web ACL defines the label namespace.
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
*/
public void setLabels(java.util.Collection labels) {
if (labels == null) {
this.labels = null;
return;
}
this.labels = new java.util.ArrayList(labels);
}
/**
*
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests.
* A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web
* ACL defines the label namespace.
*
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLabels(java.util.Collection)} or {@link #withLabels(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param labels
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web
* requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's
* rule group or web ACL defines the label namespace.
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withLabels(Label... labels) {
if (this.labels == null) {
setLabels(new java.util.ArrayList(labels.length));
}
for (Label ele : labels) {
this.labels.add(ele);
}
return this;
}
/**
*
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests.
* A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web
* ACL defines the label namespace.
*
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
*
*
* @param labels
* Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web
* requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's
* rule group or web ACL defines the label namespace.
*
* For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
* awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withLabels(java.util.Collection labels) {
setLabels(labels);
return this;
}
/**
*
* The CAPTCHA response for the request.
*
*
* @param captchaResponse
* The CAPTCHA response for the request.
*/
public void setCaptchaResponse(CaptchaResponse captchaResponse) {
this.captchaResponse = captchaResponse;
}
/**
*
* The CAPTCHA response for the request.
*
*
* @return The CAPTCHA response for the request.
*/
public CaptchaResponse getCaptchaResponse() {
return this.captchaResponse;
}
/**
*
* The CAPTCHA response for the request.
*
*
* @param captchaResponse
* The CAPTCHA response for the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withCaptchaResponse(CaptchaResponse captchaResponse) {
setCaptchaResponse(captchaResponse);
return this;
}
/**
*
* The Challenge response for the request.
*
*
* @param challengeResponse
* The Challenge response for the request.
*/
public void setChallengeResponse(ChallengeResponse challengeResponse) {
this.challengeResponse = challengeResponse;
}
/**
*
* The Challenge response for the request.
*
*
* @return The Challenge response for the request.
*/
public ChallengeResponse getChallengeResponse() {
return this.challengeResponse;
}
/**
*
* The Challenge response for the request.
*
*
* @param challengeResponse
* The Challenge response for the request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withChallengeResponse(ChallengeResponse challengeResponse) {
setChallengeResponse(challengeResponse);
return this;
}
/**
*
* Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that
* the rule group rule is configured for, and not the action that was applied to the request. The action that WAF
* applied is the Action value.
*
*
* @param overriddenAction
* Used only for rule group rules that have a rule action override in place in the web ACL. This is the
* action that the rule group rule is configured for, and not the action that was applied to the request. The
* action that WAF applied is the Action value.
*/
public void setOverriddenAction(String overriddenAction) {
this.overriddenAction = overriddenAction;
}
/**
*
* Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that
* the rule group rule is configured for, and not the action that was applied to the request. The action that WAF
* applied is the Action value.
*
*
* @return Used only for rule group rules that have a rule action override in place in the web ACL. This is the
* action that the rule group rule is configured for, and not the action that was applied to the request.
* The action that WAF applied is the Action value.
*/
public String getOverriddenAction() {
return this.overriddenAction;
}
/**
*
* Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that
* the rule group rule is configured for, and not the action that was applied to the request. The action that WAF
* applied is the Action value.
*
*
* @param overriddenAction
* Used only for rule group rules that have a rule action override in place in the web ACL. This is the
* action that the rule group rule is configured for, and not the action that was applied to the request. The
* action that WAF applied is the Action value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SampledHTTPRequest withOverriddenAction(String overriddenAction) {
setOverriddenAction(overriddenAction);
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 (getRequest() != null)
sb.append("Request: ").append(getRequest()).append(",");
if (getWeight() != null)
sb.append("Weight: ").append(getWeight()).append(",");
if (getTimestamp() != null)
sb.append("Timestamp: ").append(getTimestamp()).append(",");
if (getAction() != null)
sb.append("Action: ").append(getAction()).append(",");
if (getRuleNameWithinRuleGroup() != null)
sb.append("RuleNameWithinRuleGroup: ").append(getRuleNameWithinRuleGroup()).append(",");
if (getRequestHeadersInserted() != null)
sb.append("RequestHeadersInserted: ").append(getRequestHeadersInserted()).append(",");
if (getResponseCodeSent() != null)
sb.append("ResponseCodeSent: ").append(getResponseCodeSent()).append(",");
if (getLabels() != null)
sb.append("Labels: ").append(getLabels()).append(",");
if (getCaptchaResponse() != null)
sb.append("CaptchaResponse: ").append(getCaptchaResponse()).append(",");
if (getChallengeResponse() != null)
sb.append("ChallengeResponse: ").append(getChallengeResponse()).append(",");
if (getOverriddenAction() != null)
sb.append("OverriddenAction: ").append(getOverriddenAction());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SampledHTTPRequest == false)
return false;
SampledHTTPRequest other = (SampledHTTPRequest) obj;
if (other.getRequest() == null ^ this.getRequest() == null)
return false;
if (other.getRequest() != null && other.getRequest().equals(this.getRequest()) == false)
return false;
if (other.getWeight() == null ^ this.getWeight() == null)
return false;
if (other.getWeight() != null && other.getWeight().equals(this.getWeight()) == false)
return false;
if (other.getTimestamp() == null ^ this.getTimestamp() == null)
return false;
if (other.getTimestamp() != null && other.getTimestamp().equals(this.getTimestamp()) == false)
return false;
if (other.getAction() == null ^ this.getAction() == null)
return false;
if (other.getAction() != null && other.getAction().equals(this.getAction()) == false)
return false;
if (other.getRuleNameWithinRuleGroup() == null ^ this.getRuleNameWithinRuleGroup() == null)
return false;
if (other.getRuleNameWithinRuleGroup() != null && other.getRuleNameWithinRuleGroup().equals(this.getRuleNameWithinRuleGroup()) == false)
return false;
if (other.getRequestHeadersInserted() == null ^ this.getRequestHeadersInserted() == null)
return false;
if (other.getRequestHeadersInserted() != null && other.getRequestHeadersInserted().equals(this.getRequestHeadersInserted()) == false)
return false;
if (other.getResponseCodeSent() == null ^ this.getResponseCodeSent() == null)
return false;
if (other.getResponseCodeSent() != null && other.getResponseCodeSent().equals(this.getResponseCodeSent()) == false)
return false;
if (other.getLabels() == null ^ this.getLabels() == null)
return false;
if (other.getLabels() != null && other.getLabels().equals(this.getLabels()) == false)
return false;
if (other.getCaptchaResponse() == null ^ this.getCaptchaResponse() == null)
return false;
if (other.getCaptchaResponse() != null && other.getCaptchaResponse().equals(this.getCaptchaResponse()) == false)
return false;
if (other.getChallengeResponse() == null ^ this.getChallengeResponse() == null)
return false;
if (other.getChallengeResponse() != null && other.getChallengeResponse().equals(this.getChallengeResponse()) == false)
return false;
if (other.getOverriddenAction() == null ^ this.getOverriddenAction() == null)
return false;
if (other.getOverriddenAction() != null && other.getOverriddenAction().equals(this.getOverriddenAction()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getRequest() == null) ? 0 : getRequest().hashCode());
hashCode = prime * hashCode + ((getWeight() == null) ? 0 : getWeight().hashCode());
hashCode = prime * hashCode + ((getTimestamp() == null) ? 0 : getTimestamp().hashCode());
hashCode = prime * hashCode + ((getAction() == null) ? 0 : getAction().hashCode());
hashCode = prime * hashCode + ((getRuleNameWithinRuleGroup() == null) ? 0 : getRuleNameWithinRuleGroup().hashCode());
hashCode = prime * hashCode + ((getRequestHeadersInserted() == null) ? 0 : getRequestHeadersInserted().hashCode());
hashCode = prime * hashCode + ((getResponseCodeSent() == null) ? 0 : getResponseCodeSent().hashCode());
hashCode = prime * hashCode + ((getLabels() == null) ? 0 : getLabels().hashCode());
hashCode = prime * hashCode + ((getCaptchaResponse() == null) ? 0 : getCaptchaResponse().hashCode());
hashCode = prime * hashCode + ((getChallengeResponse() == null) ? 0 : getChallengeResponse().hashCode());
hashCode = prime * hashCode + ((getOverriddenAction() == null) ? 0 : getOverriddenAction().hashCode());
return hashCode;
}
@Override
public SampledHTTPRequest clone() {
try {
return (SampledHTTPRequest) 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.SampledHTTPRequestMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}
