com.amazonaws.services.waf.model.UpdateWebACLRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-waf Show documentation
/*
* Copyright 2015-2020 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.waf.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateWebACLRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The WebACLId of the WebACL that you want to update. WebACLId is returned by
* CreateWebACL and by ListWebACLs.
*
*/
private String webACLId;
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*/
private String changeToken;
/**
*
* An array of updates to make to the WebACL.
*
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For
* more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when updating
* or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used
* instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*
*/
private java.util.List updates;
/**
*
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't
* match the criteria in any of the rules in a web ACL.
*
*/
private WafAction defaultAction;
/**
*
* The WebACLId of the WebACL that you want to update. WebACLId is returned by
* CreateWebACL and by ListWebACLs.
*
*
* @param webACLId
* The WebACLId of the WebACL that you want to update. WebACLId is returned
* by CreateWebACL and by ListWebACLs.
*/
public void setWebACLId(String webACLId) {
this.webACLId = webACLId;
}
/**
*
* The WebACLId of the WebACL that you want to update. WebACLId is returned by
* CreateWebACL and by ListWebACLs.
*
*
* @return The WebACLId of the WebACL that you want to update. WebACLId is returned
* by CreateWebACL and by ListWebACLs.
*/
public String getWebACLId() {
return this.webACLId;
}
/**
*
* The WebACLId of the WebACL that you want to update. WebACLId is returned by
* CreateWebACL and by ListWebACLs.
*
*
* @param webACLId
* The WebACLId of the WebACL that you want to update. WebACLId is returned
* by CreateWebACL and by ListWebACLs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withWebACLId(String webACLId) {
setWebACLId(webACLId);
return this;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @param changeToken
* The value returned by the most recent call to GetChangeToken.
*/
public void setChangeToken(String changeToken) {
this.changeToken = changeToken;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @return The value returned by the most recent call to GetChangeToken.
*/
public String getChangeToken() {
return this.changeToken;
}
/**
*
* The value returned by the most recent call to GetChangeToken.
*
*
* @param changeToken
* The value returned by the most recent call to GetChangeToken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withChangeToken(String changeToken) {
setChangeToken(changeToken);
return this;
}
/**
*
* An array of updates to make to the WebACL.
*
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For
* more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when updating
* or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used
* instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*
*
* @return An array of updates to make to the WebACL.
*
* An array of WebACLUpdate objects that you want to insert into or delete from a
* WebACL. For more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when
* updating or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is
* used instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*/
public java.util.List getUpdates() {
return updates;
}
/**
*
* An array of updates to make to the WebACL.
*
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For
* more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when updating
* or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used
* instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*
*
* @param updates
* An array of updates to make to the WebACL.
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL.
* For more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when
* updating or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is
* used instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*/
public void setUpdates(java.util.Collection updates) {
if (updates == null) {
this.updates = null;
return;
}
this.updates = new java.util.ArrayList(updates);
}
/**
*
* An array of updates to make to the WebACL.
*
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For
* more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when updating
* or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used
* instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUpdates(java.util.Collection)} or {@link #withUpdates(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param updates
* An array of updates to make to the WebACL.
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL.
* For more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when
* updating or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is
* used instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withUpdates(WebACLUpdate... updates) {
if (this.updates == null) {
setUpdates(new java.util.ArrayList(updates.length));
}
for (WebACLUpdate ele : updates) {
this.updates.add(ele);
}
return this;
}
/**
*
* An array of updates to make to the WebACL.
*
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For
* more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when updating
* or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used
* instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
*
*
* @param updates
* An array of updates to make to the WebACL.
*
* An array of WebACLUpdate objects that you want to insert into or delete from a WebACL.
* For more information, see the applicable data types:
*
*
* -
*
* WebACLUpdate: Contains Action and ActivatedRule
*
*
* -
*
* ActivatedRule: Contains Action, OverrideAction, Priority,
* RuleId, and Type. ActivatedRule|OverrideAction applies only when
* updating or adding a RuleGroup to a WebACL. In this case, you do not use
* ActivatedRule|Action. For all other update requests, ActivatedRule|Action is
* used instead of ActivatedRule|OverrideAction.
*
*
* -
*
* WafAction: Contains Type
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withUpdates(java.util.Collection updates) {
setUpdates(updates);
return this;
}
/**
*
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't
* match the criteria in any of the rules in a web ACL.
*
*
* @param defaultAction
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request
* doesn't match the criteria in any of the rules in a web ACL.
*/
public void setDefaultAction(WafAction defaultAction) {
this.defaultAction = defaultAction;
}
/**
*
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't
* match the criteria in any of the rules in a web ACL.
*
*
* @return A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request
* doesn't match the criteria in any of the rules in a web ACL.
*/
public WafAction getDefaultAction() {
return this.defaultAction;
}
/**
*
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't
* match the criteria in any of the rules in a web ACL.
*
*
* @param defaultAction
* A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request
* doesn't match the criteria in any of the rules in a web ACL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withDefaultAction(WafAction defaultAction) {
setDefaultAction(defaultAction);
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 (getWebACLId() != null)
sb.append("WebACLId: ").append(getWebACLId()).append(",");
if (getChangeToken() != null)
sb.append("ChangeToken: ").append(getChangeToken()).append(",");
if (getUpdates() != null)
sb.append("Updates: ").append(getUpdates()).append(",");
if (getDefaultAction() != null)
sb.append("DefaultAction: ").append(getDefaultAction());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateWebACLRequest == false)
return false;
UpdateWebACLRequest other = (UpdateWebACLRequest) obj;
if (other.getWebACLId() == null ^ this.getWebACLId() == null)
return false;
if (other.getWebACLId() != null && other.getWebACLId().equals(this.getWebACLId()) == false)
return false;
if (other.getChangeToken() == null ^ this.getChangeToken() == null)
return false;
if (other.getChangeToken() != null && other.getChangeToken().equals(this.getChangeToken()) == false)
return false;
if (other.getUpdates() == null ^ this.getUpdates() == null)
return false;
if (other.getUpdates() != null && other.getUpdates().equals(this.getUpdates()) == false)
return false;
if (other.getDefaultAction() == null ^ this.getDefaultAction() == null)
return false;
if (other.getDefaultAction() != null && other.getDefaultAction().equals(this.getDefaultAction()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getWebACLId() == null) ? 0 : getWebACLId().hashCode());
hashCode = prime * hashCode + ((getChangeToken() == null) ? 0 : getChangeToken().hashCode());
hashCode = prime * hashCode + ((getUpdates() == null) ? 0 : getUpdates().hashCode());
hashCode = prime * hashCode + ((getDefaultAction() == null) ? 0 : getDefaultAction().hashCode());
return hashCode;
}
@Override
public UpdateWebACLRequest clone() {
return (UpdateWebACLRequest) super.clone();
}
}