com.amazonaws.services.networkfirewall.model.DescribeFirewallResult 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;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribeFirewallResult extends com.amazonaws.AmazonWebServiceResult 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 configuration settings for the firewall. These settings include the firewall policy and the subnets in your
* VPC to use for the firewall endpoints.
*
*/
private Firewall firewall;
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
*/
private FirewallStatus firewallStatus;
/**
*
* 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 DescribeFirewallResult withUpdateToken(String updateToken) {
setUpdateToken(updateToken);
return this;
}
/**
*
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in your
* VPC to use for the firewall endpoints.
*
*
* @param firewall
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in
* your VPC to use for the firewall endpoints.
*/
public void setFirewall(Firewall firewall) {
this.firewall = firewall;
}
/**
*
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in your
* VPC to use for the firewall endpoints.
*
*
* @return The configuration settings for the firewall. These settings include the firewall policy and the subnets
* in your VPC to use for the firewall endpoints.
*/
public Firewall getFirewall() {
return this.firewall;
}
/**
*
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in your
* VPC to use for the firewall endpoints.
*
*
* @param firewall
* The configuration settings for the firewall. These settings include the firewall policy and the subnets in
* your VPC to use for the firewall endpoints.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFirewallResult withFirewall(Firewall firewall) {
setFirewall(firewall);
return this;
}
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
*
* @param firewallStatus
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall
* by calling DescribeFirewall and providing the firewall name and ARN.
*/
public void setFirewallStatus(FirewallStatus firewallStatus) {
this.firewallStatus = firewallStatus;
}
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
*
* @return Detailed information about the current status of a Firewall. You can retrieve this for a firewall
* by calling DescribeFirewall and providing the firewall name and ARN.
*/
public FirewallStatus getFirewallStatus() {
return this.firewallStatus;
}
/**
*
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall by
* calling DescribeFirewall and providing the firewall name and ARN.
*
*
* @param firewallStatus
* Detailed information about the current status of a Firewall. You can retrieve this for a firewall
* by calling DescribeFirewall and providing the firewall name and ARN.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribeFirewallResult withFirewallStatus(FirewallStatus firewallStatus) {
setFirewallStatus(firewallStatus);
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 (getFirewall() != null)
sb.append("Firewall: ").append(getFirewall()).append(",");
if (getFirewallStatus() != null)
sb.append("FirewallStatus: ").append(getFirewallStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeFirewallResult == false)
return false;
DescribeFirewallResult other = (DescribeFirewallResult) obj;
if (other.getUpdateToken() == null ^ this.getUpdateToken() == null)
return false;
if (other.getUpdateToken() != null && other.getUpdateToken().equals(this.getUpdateToken()) == false)
return false;
if (other.getFirewall() == null ^ this.getFirewall() == null)
return false;
if (other.getFirewall() != null && other.getFirewall().equals(this.getFirewall()) == false)
return false;
if (other.getFirewallStatus() == null ^ this.getFirewallStatus() == null)
return false;
if (other.getFirewallStatus() != null && other.getFirewallStatus().equals(this.getFirewallStatus()) == 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 + ((getFirewall() == null) ? 0 : getFirewall().hashCode());
hashCode = prime * hashCode + ((getFirewallStatus() == null) ? 0 : getFirewallStatus().hashCode());
return hashCode;
}
@Override
public DescribeFirewallResult clone() {
try {
return (DescribeFirewallResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}