com.amazonaws.services.wafv2.model.GetWebACLResult 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;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetWebACLResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or
* create a new one.
*
*/
private WebACL webACL;
/**
*
* A token used for optimistic locking. 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. 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;
/**
*
* The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the
* integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet
* and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is
* only populated if you are using a rule group in your web ACL that integrates with your applications in this way.
* For more information, see WAF client
* application integration in the WAF Developer Guide.
*
*/
private String applicationIntegrationURL;
/**
*
* The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or
* create a new one.
*
*
* @param webACL
* The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL
* or create a new one.
*/
public void setWebACL(WebACL webACL) {
this.webACL = webACL;
}
/**
*
* The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or
* create a new one.
*
*
* @return The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL
* or create a new one.
*/
public WebACL getWebACL() {
return this.webACL;
}
/**
*
* The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or
* create a new one.
*
*
* @param webACL
* The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL
* or create a new one.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetWebACLResult withWebACL(WebACL webACL) {
setWebACL(webACL);
return this;
}
/**
*
* A token used for optimistic locking. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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. 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 GetWebACLResult withLockToken(String lockToken) {
setLockToken(lockToken);
return this;
}
/**
*
* The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the
* integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet
* and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is
* only populated if you are using a rule group in your web ACL that integrates with your applications in this way.
* For more information, see WAF client
* application integration in the WAF Developer Guide.
*
*
* @param applicationIntegrationURL
* The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use
* the integration SDKs with the account takeover prevention managed rule group
* AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group
* AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web
* ACL that integrates with your applications in this way. For more information, see WAF client
* application integration in the WAF Developer Guide.
*/
public void setApplicationIntegrationURL(String applicationIntegrationURL) {
this.applicationIntegrationURL = applicationIntegrationURL;
}
/**
*
* The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the
* integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet
* and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is
* only populated if you are using a rule group in your web ACL that integrates with your applications in this way.
* For more information, see WAF client
* application integration in the WAF Developer Guide.
*
*
* @return The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use
* the integration SDKs with the account takeover prevention managed rule group
* AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group
* AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web
* ACL that integrates with your applications in this way. For more information, see WAF client
* application integration in the WAF Developer Guide.
*/
public String getApplicationIntegrationURL() {
return this.applicationIntegrationURL;
}
/**
*
* The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the
* integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet
* and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is
* only populated if you are using a rule group in your web ACL that integrates with your applications in this way.
* For more information, see WAF client
* application integration in the WAF Developer Guide.
*
*
* @param applicationIntegrationURL
* The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use
* the integration SDKs with the account takeover prevention managed rule group
* AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group
* AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web
* ACL that integrates with your applications in this way. For more information, see WAF client
* application integration in the WAF Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetWebACLResult withApplicationIntegrationURL(String applicationIntegrationURL) {
setApplicationIntegrationURL(applicationIntegrationURL);
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 (getWebACL() != null)
sb.append("WebACL: ").append(getWebACL()).append(",");
if (getLockToken() != null)
sb.append("LockToken: ").append(getLockToken()).append(",");
if (getApplicationIntegrationURL() != null)
sb.append("ApplicationIntegrationURL: ").append(getApplicationIntegrationURL());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetWebACLResult == false)
return false;
GetWebACLResult other = (GetWebACLResult) obj;
if (other.getWebACL() == null ^ this.getWebACL() == null)
return false;
if (other.getWebACL() != null && other.getWebACL().equals(this.getWebACL()) == false)
return false;
if (other.getLockToken() == null ^ this.getLockToken() == null)
return false;
if (other.getLockToken() != null && other.getLockToken().equals(this.getLockToken()) == false)
return false;
if (other.getApplicationIntegrationURL() == null ^ this.getApplicationIntegrationURL() == null)
return false;
if (other.getApplicationIntegrationURL() != null && other.getApplicationIntegrationURL().equals(this.getApplicationIntegrationURL()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getWebACL() == null) ? 0 : getWebACL().hashCode());
hashCode = prime * hashCode + ((getLockToken() == null) ? 0 : getLockToken().hashCode());
hashCode = prime * hashCode + ((getApplicationIntegrationURL() == null) ? 0 : getApplicationIntegrationURL().hashCode());
return hashCode;
}
@Override
public GetWebACLResult clone() {
try {
return (GetWebACLResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}