com.amazonaws.services.networkfirewall.model.Attachment 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.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* The configuration and status for a single subnet that you've specified for use by the Network Firewall firewall. This
* is part of the FirewallStatus.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Attachment implements Serializable, Cloneable, StructuredPojo {
/**
*
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*
*/
private String subnetId;
/**
*
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to
* identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
*
*/
private String endpointId;
/**
*
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the
* endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this
* value is READY, the endpoint is available and configured properly to handle network traffic. When
* the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or
* DELETING.
*
*/
private String status;
/**
*
* If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the
* reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable
* state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take
* as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and
* solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
*
*/
private String statusMessage;
/**
*
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*
*
* @param subnetId
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*/
public void setSubnetId(String subnetId) {
this.subnetId = subnetId;
}
/**
*
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*
*
* @return The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*/
public String getSubnetId() {
return this.subnetId;
}
/**
*
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
*
*
* @param subnetId
* The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Attachment withSubnetId(String subnetId) {
setSubnetId(subnetId);
return this;
}
/**
*
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to
* identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
*
*
* @param endpointId
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this
* to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the
* endpoint.
*/
public void setEndpointId(String endpointId) {
this.endpointId = endpointId;
}
/**
*
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to
* identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
*
*
* @return The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use
* this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through
* the endpoint.
*/
public String getEndpointId() {
return this.endpointId;
}
/**
*
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this to
* identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
*
*
* @param endpointId
* The identifier of the firewall endpoint that Network Firewall has instantiated in the subnet. You use this
* to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the
* endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Attachment withEndpointId(String endpointId) {
setEndpointId(endpointId);
return this;
}
/**
*
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the
* endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this
* value is READY, the endpoint is available and configured properly to handle network traffic. When
* the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or
* DELETING.
*
*
* @param status
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of
* the endpoint in the VPC subnet and the sync states that are reported in the Config settings.
* When this value is READY, the endpoint is available and configured properly to handle network
* traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example
* CREATING or DELETING.
* @see AttachmentStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the
* endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this
* value is READY, the endpoint is available and configured properly to handle network traffic. When
* the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or
* DELETING.
*
*
* @return The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of
* the endpoint in the VPC subnet and the sync states that are reported in the Config settings.
* When this value is READY, the endpoint is available and configured properly to handle
* network traffic. When the endpoint isn't available for traffic, this value will reflect its state, for
* example CREATING or DELETING.
* @see AttachmentStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the
* endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this
* value is READY, the endpoint is available and configured properly to handle network traffic. When
* the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or
* DELETING.
*
*
* @param status
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of
* the endpoint in the VPC subnet and the sync states that are reported in the Config settings.
* When this value is READY, the endpoint is available and configured properly to handle network
* traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example
* CREATING or DELETING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AttachmentStatus
*/
public Attachment withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of the
* endpoint in the VPC subnet and the sync states that are reported in the Config settings. When this
* value is READY, the endpoint is available and configured properly to handle network traffic. When
* the endpoint isn't available for traffic, this value will reflect its state, for example CREATING or
* DELETING.
*
*
* @param status
* The current status of the firewall endpoint in the subnet. This value reflects both the instantiation of
* the endpoint in the VPC subnet and the sync states that are reported in the Config settings.
* When this value is READY, the endpoint is available and configured properly to handle network
* traffic. When the endpoint isn't available for traffic, this value will reflect its state, for example
* CREATING or DELETING.
* @return Returns a reference to this object so that method calls can be chained together.
* @see AttachmentStatus
*/
public Attachment withStatus(AttachmentStatus status) {
this.status = status.toString();
return this;
}
/**
*
* If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the
* reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable
* state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take
* as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and
* solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
*
*
* @param statusMessage
* If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with
* the reason for the error or failure and how to resolve it. A FAILED status indicates a
* non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on
* the error, it can take as many as 15 minutes to populate this field. For more information about the causes
* for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
*/
public void setStatusMessage(String statusMessage) {
this.statusMessage = statusMessage;
}
/**
*
* If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the
* reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable
* state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take
* as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and
* solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
*
*
* @return If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with
* the reason for the error or failure and how to resolve it. A FAILED status indicates a
* non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on
* the error, it can take as many as 15 minutes to populate this field. For more information about the
* causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
*/
public String getStatusMessage() {
return this.statusMessage;
}
/**
*
* If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the
* reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable
* state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take
* as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and
* solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
*
*
* @param statusMessage
* If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with
* the reason for the error or failure and how to resolve it. A FAILED status indicates a
* non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on
* the error, it can take as many as 15 minutes to populate this field. For more information about the causes
* for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Attachment withStatusMessage(String statusMessage) {
setStatusMessage(statusMessage);
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 (getSubnetId() != null)
sb.append("SubnetId: ").append(getSubnetId()).append(",");
if (getEndpointId() != null)
sb.append("EndpointId: ").append(getEndpointId()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusMessage() != null)
sb.append("StatusMessage: ").append(getStatusMessage());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Attachment == false)
return false;
Attachment other = (Attachment) obj;
if (other.getSubnetId() == null ^ this.getSubnetId() == null)
return false;
if (other.getSubnetId() != null && other.getSubnetId().equals(this.getSubnetId()) == false)
return false;
if (other.getEndpointId() == null ^ this.getEndpointId() == null)
return false;
if (other.getEndpointId() != null && other.getEndpointId().equals(this.getEndpointId()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStatusMessage() == null ^ this.getStatusMessage() == null)
return false;
if (other.getStatusMessage() != null && other.getStatusMessage().equals(this.getStatusMessage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getSubnetId() == null) ? 0 : getSubnetId().hashCode());
hashCode = prime * hashCode + ((getEndpointId() == null) ? 0 : getEndpointId().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusMessage() == null) ? 0 : getStatusMessage().hashCode());
return hashCode;
}
@Override
public Attachment clone() {
try {
return (Attachment) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.networkfirewall.model.transform.AttachmentMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}