com.amazonaws.services.wafv2.model.UpdateWebACLRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2014-2019 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateWebACLRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
*
*/
private String name;
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*/
private String scope;
/**
*
* The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You
* provide it to operations like update and delete.
*
*/
private String id;
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*/
private DefaultAction defaultAction;
/**
*
* A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
*
*/
private String description;
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*/
private java.util.List rules;
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*/
private VisibilityConfig visibilityConfig;
/**
*
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of
* the entity at the time of the request. To make changes to the entity associated with the token, you provide the
* token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to
* the entity since you last retrieved it. If a change has been made, the update fails with a
* WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by
* that operation.
*
*/
private String lockToken;
/**
*
* A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
*
*
* @param name
* A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
*
*
* @return A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
*/
public String getName() {
return this.name;
}
/**
*
* A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
*
*
* @param name
* A friendly name of the Web ACL. You cannot change the name of a Web ACL after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withName(String name) {
setName(name);
return this;
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* @param scope
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @see Scope
*/
public void setScope(String scope) {
this.scope = scope;
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* @return Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @see Scope
*/
public String getScope() {
return this.scope;
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* @param scope
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
public UpdateWebACLRequest withScope(String scope) {
setScope(scope);
return this;
}
/**
*
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
*
*
* @param scope
* Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional
* application can be an Application Load Balancer (ALB) or an API Gateway stage.
*
* To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
*
*
* -
*
* CLI - Specify the region when you use the CloudFront scope:
* --scope=CLOUDFRONT --region=us-east-1.
*
*
* -
*
* API and SDKs - For all calls, use the Region endpoint us-east-1.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see Scope
*/
public UpdateWebACLRequest withScope(Scope scope) {
this.scope = scope.toString();
return this;
}
/**
*
* The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You
* provide it to operations like update and delete.
*
*
* @param id
* The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands.
* You provide it to operations like update and delete.
*/
public void setId(String id) {
this.id = id;
}
/**
*
* The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You
* provide it to operations like update and delete.
*
*
* @return The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands.
* You provide it to operations like update and delete.
*/
public String getId() {
return this.id;
}
/**
*
* The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You
* provide it to operations like update and delete.
*
*
* @param id
* The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands.
* You provide it to operations like update and delete.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withId(String id) {
setId(id);
return this;
}
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*
* @param defaultAction
* The action to perform if none of the Rules contained in the WebACL match.
*/
public void setDefaultAction(DefaultAction defaultAction) {
this.defaultAction = defaultAction;
}
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*
* @return The action to perform if none of the Rules contained in the WebACL match.
*/
public DefaultAction getDefaultAction() {
return this.defaultAction;
}
/**
*
* The action to perform if none of the Rules contained in the WebACL match.
*
*
* @param defaultAction
* The action to perform if none of the Rules contained in the WebACL match.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withDefaultAction(DefaultAction defaultAction) {
setDefaultAction(defaultAction);
return this;
}
/**
*
* A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
*
*
* @param description
* A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
*
*
* @return A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create
* it.
*/
public String getDescription() {
return this.description;
}
/**
*
* A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
*
*
* @param description
* A friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* @return The Rule statements used to identify the web requests that you want to allow, block, or count.
* Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and
* parameters that govern how AWS WAF handles them.
*/
public java.util.List getRules() {
return rules;
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each
* rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters
* that govern how AWS WAF handles them.
*/
public void setRules(java.util.Collection rules) {
if (rules == null) {
this.rules = null;
return;
}
this.rules = new java.util.ArrayList(rules);
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRules(java.util.Collection)} or {@link #withRules(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each
* rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters
* that govern how AWS WAF handles them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withRules(Rule... rules) {
if (this.rules == null) {
setRules(new java.util.ArrayList(rules.length));
}
for (Rule ele : rules) {
this.rules.add(ele);
}
return this;
}
/**
*
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule
* includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern
* how AWS WAF handles them.
*
*
* @param rules
* The Rule statements used to identify the web requests that you want to allow, block, or count. Each
* rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters
* that govern how AWS WAF handles them.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withRules(java.util.Collection rules) {
setRules(rules);
return this;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public void setVisibilityConfig(VisibilityConfig visibilityConfig) {
this.visibilityConfig = visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @return Defines and enables Amazon CloudWatch metrics and web request sample collection.
*/
public VisibilityConfig getVisibilityConfig() {
return this.visibilityConfig;
}
/**
*
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
*
*
* @param visibilityConfig
* Defines and enables Amazon CloudWatch metrics and web request sample collection.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withVisibilityConfig(VisibilityConfig visibilityConfig) {
setVisibilityConfig(visibilityConfig);
return this;
}
/**
*
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of
* the entity at the time of the request. To make changes to the entity associated with the token, you provide the
* token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to
* the entity since you last retrieved it. If a change has been made, the update fails with a
* WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by
* that operation.
*
*
* @param lockToken
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the
* state of the entity at the time of the request. To make changes to the entity associated with the token,
* you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change has been made, the update
* fails with a WAFOptimisticLockException. If this happens, perform another get, and use the
* new token returned by that operation.
*/
public void setLockToken(String lockToken) {
this.lockToken = lockToken;
}
/**
*
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of
* the entity at the time of the request. To make changes to the entity associated with the token, you provide the
* token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to
* the entity since you last retrieved it. If a change has been made, the update fails with a
* WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by
* that operation.
*
*
* @return A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the
* state of the entity at the time of the request. To make changes to the entity associated with the token,
* you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change has been made, the update
* fails with a WAFOptimisticLockException. If this happens, perform another get, and use the
* new token returned by that operation.
*/
public String getLockToken() {
return this.lockToken;
}
/**
*
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of
* the entity at the time of the request. To make changes to the entity associated with the token, you provide the
* token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to
* the entity since you last retrieved it. If a change has been made, the update fails with a
* WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by
* that operation.
*
*
* @param lockToken
* A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the
* state of the entity at the time of the request. To make changes to the entity associated with the token,
* you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no
* changes have been made to the entity since you last retrieved it. If a change has been made, the update
* fails with a WAFOptimisticLockException. If this happens, perform another get, and use the
* new token returned by that operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateWebACLRequest withLockToken(String lockToken) {
setLockToken(lockToken);
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getScope() != null)
sb.append("Scope: ").append(getScope()).append(",");
if (getId() != null)
sb.append("Id: ").append(getId()).append(",");
if (getDefaultAction() != null)
sb.append("DefaultAction: ").append(getDefaultAction()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getRules() != null)
sb.append("Rules: ").append(getRules()).append(",");
if (getVisibilityConfig() != null)
sb.append("VisibilityConfig: ").append(getVisibilityConfig()).append(",");
if (getLockToken() != null)
sb.append("LockToken: ").append(getLockToken());
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.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getScope() == null ^ this.getScope() == null)
return false;
if (other.getScope() != null && other.getScope().equals(this.getScope()) == false)
return false;
if (other.getId() == null ^ this.getId() == null)
return false;
if (other.getId() != null && other.getId().equals(this.getId()) == false)
return false;
if (other.getDefaultAction() == null ^ this.getDefaultAction() == null)
return false;
if (other.getDefaultAction() != null && other.getDefaultAction().equals(this.getDefaultAction()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getRules() == null ^ this.getRules() == null)
return false;
if (other.getRules() != null && other.getRules().equals(this.getRules()) == false)
return false;
if (other.getVisibilityConfig() == null ^ this.getVisibilityConfig() == null)
return false;
if (other.getVisibilityConfig() != null && other.getVisibilityConfig().equals(this.getVisibilityConfig()) == false)
return false;
if (other.getLockToken() == null ^ this.getLockToken() == null)
return false;
if (other.getLockToken() != null && other.getLockToken().equals(this.getLockToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getScope() == null) ? 0 : getScope().hashCode());
hashCode = prime * hashCode + ((getId() == null) ? 0 : getId().hashCode());
hashCode = prime * hashCode + ((getDefaultAction() == null) ? 0 : getDefaultAction().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getRules() == null) ? 0 : getRules().hashCode());
hashCode = prime * hashCode + ((getVisibilityConfig() == null) ? 0 : getVisibilityConfig().hashCode());
hashCode = prime * hashCode + ((getLockToken() == null) ? 0 : getLockToken().hashCode());
return hashCode;
}
@Override
public UpdateWebACLRequest clone() {
return (UpdateWebACLRequest) super.clone();
}
}