com.amazonaws.services.networkfirewall.model.UpdateFirewallDescriptionRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-networkfirewall 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.networkfirewall.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 UpdateFirewallDescriptionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that
* access the firewall. The token marks the state of the firewall resource at the time of the request.
*
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved
* it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the
* token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current
* copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*
*/
private String updateToken;
/**
*
* The Amazon Resource Name (ARN) of the firewall.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*/
private String firewallArn;
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*/
private String firewallName;
/**
*
* The new description for the firewall. If you omit this setting, Network Firewall removes the description for the
* firewall.
*
*/
private String description;
/**
*
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that
* access the firewall. The token marks the state of the firewall resource at the time of the request.
*
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved
* it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the
* token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current
* copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @param updateToken
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your
* requests that access the firewall. The token marks the state of the firewall resource at the time of the
* request.
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last
* retrieved it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall
* uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed,
* the operation fails with an InvalidTokenException. If this happens, retrieve the firewall
* again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation
* again using the new token.
*/
public void setUpdateToken(String updateToken) {
this.updateToken = updateToken;
}
/**
*
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that
* access the firewall. The token marks the state of the firewall resource at the time of the request.
*
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved
* it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the
* token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current
* copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @return An optional token that you can use for optimistic locking. Network Firewall returns a token to your
* requests that access the firewall. The token marks the state of the firewall resource at the time of the
* request.
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the
* token, Network Firewall performs your updates regardless of whether the firewall has changed since you
* last retrieved it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall
* uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed,
* the operation fails with an InvalidTokenException. If this happens, retrieve the firewall
* again to get a current copy of it with a new token. Reapply your changes as needed, then try the
* operation again using the new token.
*/
public String getUpdateToken() {
return this.updateToken;
}
/**
*
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that
* access the firewall. The token marks the state of the firewall resource at the time of the request.
*
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved
* it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the
* token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation
* fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current
* copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
*
*
* @param updateToken
* An optional token that you can use for optimistic locking. Network Firewall returns a token to your
* requests that access the firewall. The token marks the state of the firewall resource at the time of the
* request.
*
* To make an unconditional change to the firewall, omit the token in your update request. Without the token,
* Network Firewall performs your updates regardless of whether the firewall has changed since you last
* retrieved it.
*
*
* To make a conditional change to the firewall, provide the token in your update request. Network Firewall
* uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed,
* the operation fails with an InvalidTokenException. If this happens, retrieve the firewall
* again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation
* again using the new token.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFirewallDescriptionRequest withUpdateToken(String updateToken) {
setUpdateToken(updateToken);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the firewall.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param firewallArn
* The Amazon Resource Name (ARN) of the firewall.
*
* You must specify the ARN or the name, and you can specify both.
*/
public void setFirewallArn(String firewallArn) {
this.firewallArn = firewallArn;
}
/**
*
* The Amazon Resource Name (ARN) of the firewall.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @return The Amazon Resource Name (ARN) of the firewall.
*
* You must specify the ARN or the name, and you can specify both.
*/
public String getFirewallArn() {
return this.firewallArn;
}
/**
*
* The Amazon Resource Name (ARN) of the firewall.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param firewallArn
* The Amazon Resource Name (ARN) of the firewall.
*
* You must specify the ARN or the name, and you can specify both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFirewallDescriptionRequest withFirewallArn(String firewallArn) {
setFirewallArn(firewallArn);
return this;
}
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param firewallName
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
* You must specify the ARN or the name, and you can specify both.
*/
public void setFirewallName(String firewallName) {
this.firewallName = firewallName;
}
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @return The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
* You must specify the ARN or the name, and you can specify both.
*/
public String getFirewallName() {
return this.firewallName;
}
/**
*
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
*
* You must specify the ARN or the name, and you can specify both.
*
*
* @param firewallName
* The descriptive name of the firewall. You can't change the name of a firewall after you create it.
*
* You must specify the ARN or the name, and you can specify both.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFirewallDescriptionRequest withFirewallName(String firewallName) {
setFirewallName(firewallName);
return this;
}
/**
*
* The new description for the firewall. If you omit this setting, Network Firewall removes the description for the
* firewall.
*
*
* @param description
* The new description for the firewall. If you omit this setting, Network Firewall removes the description
* for the firewall.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* The new description for the firewall. If you omit this setting, Network Firewall removes the description for the
* firewall.
*
*
* @return The new description for the firewall. If you omit this setting, Network Firewall removes the description
* for the firewall.
*/
public String getDescription() {
return this.description;
}
/**
*
* The new description for the firewall. If you omit this setting, Network Firewall removes the description for the
* firewall.
*
*
* @param description
* The new description for the firewall. If you omit this setting, Network Firewall removes the description
* for the firewall.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateFirewallDescriptionRequest withDescription(String description) {
setDescription(description);
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 (getUpdateToken() != null)
sb.append("UpdateToken: ").append(getUpdateToken()).append(",");
if (getFirewallArn() != null)
sb.append("FirewallArn: ").append(getFirewallArn()).append(",");
if (getFirewallName() != null)
sb.append("FirewallName: ").append(getFirewallName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateFirewallDescriptionRequest == false)
return false;
UpdateFirewallDescriptionRequest other = (UpdateFirewallDescriptionRequest) obj;
if (other.getUpdateToken() == null ^ this.getUpdateToken() == null)
return false;
if (other.getUpdateToken() != null && other.getUpdateToken().equals(this.getUpdateToken()) == false)
return false;
if (other.getFirewallArn() == null ^ this.getFirewallArn() == null)
return false;
if (other.getFirewallArn() != null && other.getFirewallArn().equals(this.getFirewallArn()) == false)
return false;
if (other.getFirewallName() == null ^ this.getFirewallName() == null)
return false;
if (other.getFirewallName() != null && other.getFirewallName().equals(this.getFirewallName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUpdateToken() == null) ? 0 : getUpdateToken().hashCode());
hashCode = prime * hashCode + ((getFirewallArn() == null) ? 0 : getFirewallArn().hashCode());
hashCode = prime * hashCode + ((getFirewallName() == null) ? 0 : getFirewallName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
return hashCode;
}
@Override
public UpdateFirewallDescriptionRequest clone() {
return (UpdateFirewallDescriptionRequest) super.clone();
}
}