com.amazonaws.services.ec2.model.InstanceNetworkInterface Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
 * Copyright 2011-2016 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.ec2.model;
import java.io.Serializable;
/**
 * 
 * Describes a network interface.
 * 
 */
public class InstanceNetworkInterface implements Serializable, Cloneable {
    /**
     * 
     * The ID of the network interface.
     * 
     */
    private String networkInterfaceId;
    /**
     * 
     * The ID of the subnet.
     * 
     */
    private String subnetId;
    /**
     * 
     * The ID of the VPC.
     * 
     */
    private String vpcId;
    /**
     * 
     * The description.
     * 
     */
    private String description;
    /**
     * 
     * The ID of the AWS account that created the network interface.
     * 
     */
    private String ownerId;
    /**
     * 
     * The status of the network interface.
     * 
     */
    private String status;
    /**
     * 
     * The MAC address.
     * 
     */
    private String macAddress;
    /**
     * 
     * The IP address of the network interface within the subnet.
     * 
     */
    private String privateIpAddress;
    /**
     * 
     * The private DNS name.
     * 
     */
    private String privateDnsName;
    /**
     * 
     * Indicates whether to validate network traffic to or from this network
     * interface.
     * 
     */
    private Boolean sourceDestCheck;
    /**
     * 
     * One or more security groups.
     * 
     */
    private com.amazonaws.internal.SdkInternalList groups;
    /**
     * 
     * The network interface attachment.
     * 
     */
    private InstanceNetworkInterfaceAttachment attachment;
    /**
     * 
     * The association information for an Elastic IP associated with the network
     * interface.
     * 
     */
    private InstanceNetworkInterfaceAssociation association;
    /**
     * 
     * The private IP addresses associated with the network interface.
     * 
     */
    private com.amazonaws.internal.SdkInternalList privateIpAddresses;
    /**
     * 
     * The ID of the network interface.
     * 
     * 
     * @param networkInterfaceId
     *        The ID of the network interface.
     */
    public void setNetworkInterfaceId(String networkInterfaceId) {
        this.networkInterfaceId = networkInterfaceId;
    }
    /**
     * 
     * The ID of the network interface.
     * 
     * 
     * @return The ID of the network interface.
     */
    public String getNetworkInterfaceId() {
        return this.networkInterfaceId;
    }
    /**
     * 
     * The ID of the network interface.
     * 
     * 
     * @param networkInterfaceId
     *        The ID of the network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withNetworkInterfaceId(
            String networkInterfaceId) {
        setNetworkInterfaceId(networkInterfaceId);
        return this;
    }
    /**
     * 
     * The ID of the subnet.
     * 
     * 
     * @param subnetId
     *        The ID of the subnet.
     */
    public void setSubnetId(String subnetId) {
        this.subnetId = subnetId;
    }
    /**
     * 
     * The ID of the subnet.
     * 
     * 
     * @return The ID of the subnet.
     */
    public String getSubnetId() {
        return this.subnetId;
    }
    /**
     * 
     * The ID of the subnet.
     * 
     * 
     * @param subnetId
     *        The ID of the subnet.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withSubnetId(String subnetId) {
        setSubnetId(subnetId);
        return this;
    }
    /**
     * 
     * The ID of the VPC.
     * 
     * 
     * @param vpcId
     *        The ID of the VPC.
     */
    public void setVpcId(String vpcId) {
        this.vpcId = vpcId;
    }
    /**
     * 
     * The ID of the VPC.
     * 
     * 
     * @return The ID of the VPC.
     */
    public String getVpcId() {
        return this.vpcId;
    }
    /**
     * 
     * The ID of the VPC.
     * 
     * 
     * @param vpcId
     *        The ID of the VPC.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withVpcId(String vpcId) {
        setVpcId(vpcId);
        return this;
    }
    /**
     * 
     * The description.
     * 
     * 
     * @param description
     *        The description.
     */
    public void setDescription(String description) {
        this.description = description;
    }
    /**
     * 
     * The description.
     * 
     * 
     * @return The description.
     */
    public String getDescription() {
        return this.description;
    }
    /**
     * 
     * The description.
     * 
     * 
     * @param description
     *        The description.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withDescription(String description) {
        setDescription(description);
        return this;
    }
    /**
     * 
     * The ID of the AWS account that created the network interface.
     * 
     * 
     * @param ownerId
     *        The ID of the AWS account that created the network interface.
     */
    public void setOwnerId(String ownerId) {
        this.ownerId = ownerId;
    }
    /**
     * 
     * The ID of the AWS account that created the network interface.
     * 
     * 
     * @return The ID of the AWS account that created the network interface.
     */
    public String getOwnerId() {
        return this.ownerId;
    }
    /**
     * 
     * The ID of the AWS account that created the network interface.
     * 
     * 
     * @param ownerId
     *        The ID of the AWS account that created the network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withOwnerId(String ownerId) {
        setOwnerId(ownerId);
        return this;
    }
    /**
     * 
     * The status of the network interface.
     * 
     * 
     * @param status
     *        The status of the network interface.
     * @see NetworkInterfaceStatus
     */
    public void setStatus(String status) {
        this.status = status;
    }
    /**
     * 
     * The status of the network interface.
     * 
     * 
     * @return The status of the network interface.
     * @see NetworkInterfaceStatus
     */
    public String getStatus() {
        return this.status;
    }
    /**
     * 
     * The status of the network interface.
     * 
     * 
     * @param status
     *        The status of the network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see NetworkInterfaceStatus
     */
    public InstanceNetworkInterface withStatus(String status) {
        setStatus(status);
        return this;
    }
    /**
     * 
     * The status of the network interface.
     * 
     * 
     * @param status
     *        The status of the network interface.
     * @see NetworkInterfaceStatus
     */
    public void setStatus(NetworkInterfaceStatus status) {
        this.status = status.toString();
    }
    /**
     * 
     * The status of the network interface.
     * 
     * 
     * @param status
     *        The status of the network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     * @see NetworkInterfaceStatus
     */
    public InstanceNetworkInterface withStatus(NetworkInterfaceStatus status) {
        setStatus(status);
        return this;
    }
    /**
     * 
     * The MAC address.
     * 
     * 
     * @param macAddress
     *        The MAC address.
     */
    public void setMacAddress(String macAddress) {
        this.macAddress = macAddress;
    }
    /**
     * 
     * The MAC address.
     * 
     * 
     * @return The MAC address.
     */
    public String getMacAddress() {
        return this.macAddress;
    }
    /**
     * 
     * The MAC address.
     * 
     * 
     * @param macAddress
     *        The MAC address.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withMacAddress(String macAddress) {
        setMacAddress(macAddress);
        return this;
    }
    /**
     * 
     * The IP address of the network interface within the subnet.
     * 
     * 
     * @param privateIpAddress
     *        The IP address of the network interface within the subnet.
     */
    public void setPrivateIpAddress(String privateIpAddress) {
        this.privateIpAddress = privateIpAddress;
    }
    /**
     * 
     * The IP address of the network interface within the subnet.
     * 
     * 
     * @return The IP address of the network interface within the subnet.
     */
    public String getPrivateIpAddress() {
        return this.privateIpAddress;
    }
    /**
     * 
     * The IP address of the network interface within the subnet.
     * 
     * 
     * @param privateIpAddress
     *        The IP address of the network interface within the subnet.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withPrivateIpAddress(String privateIpAddress) {
        setPrivateIpAddress(privateIpAddress);
        return this;
    }
    /**
     * 
     * The private DNS name.
     * 
     * 
     * @param privateDnsName
     *        The private DNS name.
     */
    public void setPrivateDnsName(String privateDnsName) {
        this.privateDnsName = privateDnsName;
    }
    /**
     * 
     * The private DNS name.
     * 
     * 
     * @return The private DNS name.
     */
    public String getPrivateDnsName() {
        return this.privateDnsName;
    }
    /**
     * 
     * The private DNS name.
     * 
     * 
     * @param privateDnsName
     *        The private DNS name.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withPrivateDnsName(String privateDnsName) {
        setPrivateDnsName(privateDnsName);
        return this;
    }
    /**
     * 
     * Indicates whether to validate network traffic to or from this network
     * interface.
     * 
     * 
     * @param sourceDestCheck
     *        Indicates whether to validate network traffic to or from this
     *        network interface.
     */
    public void setSourceDestCheck(Boolean sourceDestCheck) {
        this.sourceDestCheck = sourceDestCheck;
    }
    /**
     * 
     * Indicates whether to validate network traffic to or from this network
     * interface.
     * 
     * 
     * @return Indicates whether to validate network traffic to or from this
     *         network interface.
     */
    public Boolean getSourceDestCheck() {
        return this.sourceDestCheck;
    }
    /**
     * 
     * Indicates whether to validate network traffic to or from this network
     * interface.
     * 
     * 
     * @param sourceDestCheck
     *        Indicates whether to validate network traffic to or from this
     *        network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withSourceDestCheck(Boolean sourceDestCheck) {
        setSourceDestCheck(sourceDestCheck);
        return this;
    }
    /**
     * 
     * Indicates whether to validate network traffic to or from this network
     * interface.
     * 
     * 
     * @return Indicates whether to validate network traffic to or from this
     *         network interface.
     */
    public Boolean isSourceDestCheck() {
        return this.sourceDestCheck;
    }
    /**
     * 
     * One or more security groups.
     * 
     * 
     * @return One or more security groups.
     */
    public java.util.List getGroups() {
        if (groups == null) {
            groups = new com.amazonaws.internal.SdkInternalList();
        }
        return groups;
    }
    /**
     * 
     * One or more security groups.
     * 
     * 
     * @param groups
     *        One or more security groups.
     */
    public void setGroups(java.util.Collection groups) {
        if (groups == null) {
            this.groups = null;
            return;
        }
        this.groups = new com.amazonaws.internal.SdkInternalList(
                groups);
    }
    /**
     * 
     * One or more security groups.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setGroups(java.util.Collection)} or
     * {@link #withGroups(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param groups
     *        One or more security groups.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withGroups(GroupIdentifier... groups) {
        if (this.groups == null) {
            setGroups(new com.amazonaws.internal.SdkInternalList(
                    groups.length));
        }
        for (GroupIdentifier ele : groups) {
            this.groups.add(ele);
        }
        return this;
    }
    /**
     * 
     * One or more security groups.
     * 
     * 
     * @param groups
     *        One or more security groups.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withGroups(
            java.util.Collection groups) {
        setGroups(groups);
        return this;
    }
    /**
     * 
     * The network interface attachment.
     * 
     * 
     * @param attachment
     *        The network interface attachment.
     */
    public void setAttachment(InstanceNetworkInterfaceAttachment attachment) {
        this.attachment = attachment;
    }
    /**
     * 
     * The network interface attachment.
     * 
     * 
     * @return The network interface attachment.
     */
    public InstanceNetworkInterfaceAttachment getAttachment() {
        return this.attachment;
    }
    /**
     * 
     * The network interface attachment.
     * 
     * 
     * @param attachment
     *        The network interface attachment.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withAttachment(
            InstanceNetworkInterfaceAttachment attachment) {
        setAttachment(attachment);
        return this;
    }
    /**
     * 
     * The association information for an Elastic IP associated with the network
     * interface.
     * 
     * 
     * @param association
     *        The association information for an Elastic IP associated with the
     *        network interface.
     */
    public void setAssociation(InstanceNetworkInterfaceAssociation association) {
        this.association = association;
    }
    /**
     * 
     * The association information for an Elastic IP associated with the network
     * interface.
     * 
     * 
     * @return The association information for an Elastic IP associated with the
     *         network interface.
     */
    public InstanceNetworkInterfaceAssociation getAssociation() {
        return this.association;
    }
    /**
     * 
     * The association information for an Elastic IP associated with the network
     * interface.
     * 
     * 
     * @param association
     *        The association information for an Elastic IP associated with the
     *        network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withAssociation(
            InstanceNetworkInterfaceAssociation association) {
        setAssociation(association);
        return this;
    }
    /**
     * 
     * The private IP addresses associated with the network interface.
     * 
     * 
     * @return The private IP addresses associated with the network interface.
     */
    public java.util.List getPrivateIpAddresses() {
        if (privateIpAddresses == null) {
            privateIpAddresses = new com.amazonaws.internal.SdkInternalList();
        }
        return privateIpAddresses;
    }
    /**
     * 
     * The private IP addresses associated with the network interface.
     * 
     * 
     * @param privateIpAddresses
     *        The private IP addresses associated with the network interface.
     */
    public void setPrivateIpAddresses(
            java.util.Collection privateIpAddresses) {
        if (privateIpAddresses == null) {
            this.privateIpAddresses = null;
            return;
        }
        this.privateIpAddresses = new com.amazonaws.internal.SdkInternalList(
                privateIpAddresses);
    }
    /**
     * 
     * The private IP addresses associated with the network interface.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setPrivateIpAddresses(java.util.Collection)} or
     * {@link #withPrivateIpAddresses(java.util.Collection)} if you want to
     * override the existing values.
     * 
     * 
     * @param privateIpAddresses
     *        The private IP addresses associated with the network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withPrivateIpAddresses(
            InstancePrivateIpAddress... privateIpAddresses) {
        if (this.privateIpAddresses == null) {
            setPrivateIpAddresses(new com.amazonaws.internal.SdkInternalList(
                    privateIpAddresses.length));
        }
        for (InstancePrivateIpAddress ele : privateIpAddresses) {
            this.privateIpAddresses.add(ele);
        }
        return this;
    }
    /**
     * 
     * The private IP addresses associated with the network interface.
     * 
     * 
     * @param privateIpAddresses
     *        The private IP addresses associated with the network interface.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public InstanceNetworkInterface withPrivateIpAddresses(
            java.util.Collection privateIpAddresses) {
        setPrivateIpAddresses(privateIpAddresses);
        return this;
    }
    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getNetworkInterfaceId() != null)
            sb.append("NetworkInterfaceId: " + getNetworkInterfaceId() + ",");
        if (getSubnetId() != null)
            sb.append("SubnetId: " + getSubnetId() + ",");
        if (getVpcId() != null)
            sb.append("VpcId: " + getVpcId() + ",");
        if (getDescription() != null)
            sb.append("Description: " + getDescription() + ",");
        if (getOwnerId() != null)
            sb.append("OwnerId: " + getOwnerId() + ",");
        if (getStatus() != null)
            sb.append("Status: " + getStatus() + ",");
        if (getMacAddress() != null)
            sb.append("MacAddress: " + getMacAddress() + ",");
        if (getPrivateIpAddress() != null)
            sb.append("PrivateIpAddress: " + getPrivateIpAddress() + ",");
        if (getPrivateDnsName() != null)
            sb.append("PrivateDnsName: " + getPrivateDnsName() + ",");
        if (getSourceDestCheck() != null)
            sb.append("SourceDestCheck: " + getSourceDestCheck() + ",");
        if (getGroups() != null)
            sb.append("Groups: " + getGroups() + ",");
        if (getAttachment() != null)
            sb.append("Attachment: " + getAttachment() + ",");
        if (getAssociation() != null)
            sb.append("Association: " + getAssociation() + ",");
        if (getPrivateIpAddresses() != null)
            sb.append("PrivateIpAddresses: " + getPrivateIpAddresses());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof InstanceNetworkInterface == false)
            return false;
        InstanceNetworkInterface other = (InstanceNetworkInterface) obj;
        if (other.getNetworkInterfaceId() == null
                ^ this.getNetworkInterfaceId() == null)
            return false;
        if (other.getNetworkInterfaceId() != null
                && other.getNetworkInterfaceId().equals(
                        this.getNetworkInterfaceId()) == false)
            return false;
        if (other.getSubnetId() == null ^ this.getSubnetId() == null)
            return false;
        if (other.getSubnetId() != null
                && other.getSubnetId().equals(this.getSubnetId()) == false)
            return false;
        if (other.getVpcId() == null ^ this.getVpcId() == null)
            return false;
        if (other.getVpcId() != null
                && other.getVpcId().equals(this.getVpcId()) == 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.getOwnerId() == null ^ this.getOwnerId() == null)
            return false;
        if (other.getOwnerId() != null
                && other.getOwnerId().equals(this.getOwnerId()) == 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.getMacAddress() == null ^ this.getMacAddress() == null)
            return false;
        if (other.getMacAddress() != null
                && other.getMacAddress().equals(this.getMacAddress()) == false)
            return false;
        if (other.getPrivateIpAddress() == null
                ^ this.getPrivateIpAddress() == null)
            return false;
        if (other.getPrivateIpAddress() != null
                && other.getPrivateIpAddress().equals(
                        this.getPrivateIpAddress()) == false)
            return false;
        if (other.getPrivateDnsName() == null
                ^ this.getPrivateDnsName() == null)
            return false;
        if (other.getPrivateDnsName() != null
                && other.getPrivateDnsName().equals(this.getPrivateDnsName()) == false)
            return false;
        if (other.getSourceDestCheck() == null
                ^ this.getSourceDestCheck() == null)
            return false;
        if (other.getSourceDestCheck() != null
                && other.getSourceDestCheck().equals(this.getSourceDestCheck()) == false)
            return false;
        if (other.getGroups() == null ^ this.getGroups() == null)
            return false;
        if (other.getGroups() != null
                && other.getGroups().equals(this.getGroups()) == false)
            return false;
        if (other.getAttachment() == null ^ this.getAttachment() == null)
            return false;
        if (other.getAttachment() != null
                && other.getAttachment().equals(this.getAttachment()) == false)
            return false;
        if (other.getAssociation() == null ^ this.getAssociation() == null)
            return false;
        if (other.getAssociation() != null
                && other.getAssociation().equals(this.getAssociation()) == false)
            return false;
        if (other.getPrivateIpAddresses() == null
                ^ this.getPrivateIpAddresses() == null)
            return false;
        if (other.getPrivateIpAddresses() != null
                && other.getPrivateIpAddresses().equals(
                        this.getPrivateIpAddresses()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getNetworkInterfaceId() == null) ? 0
                        : getNetworkInterfaceId().hashCode());
        hashCode = prime * hashCode
                + ((getSubnetId() == null) ? 0 : getSubnetId().hashCode());
        hashCode = prime * hashCode
                + ((getVpcId() == null) ? 0 : getVpcId().hashCode());
        hashCode = prime
                * hashCode
                + ((getDescription() == null) ? 0 : getDescription().hashCode());
        hashCode = prime * hashCode
                + ((getOwnerId() == null) ? 0 : getOwnerId().hashCode());
        hashCode = prime * hashCode
                + ((getStatus() == null) ? 0 : getStatus().hashCode());
        hashCode = prime * hashCode
                + ((getMacAddress() == null) ? 0 : getMacAddress().hashCode());
        hashCode = prime
                * hashCode
                + ((getPrivateIpAddress() == null) ? 0 : getPrivateIpAddress()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getPrivateDnsName() == null) ? 0 : getPrivateDnsName()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getSourceDestCheck() == null) ? 0 : getSourceDestCheck()
                        .hashCode());
        hashCode = prime * hashCode
                + ((getGroups() == null) ? 0 : getGroups().hashCode());
        hashCode = prime * hashCode
                + ((getAttachment() == null) ? 0 : getAttachment().hashCode());
        hashCode = prime
                * hashCode
                + ((getAssociation() == null) ? 0 : getAssociation().hashCode());
        hashCode = prime
                * hashCode
                + ((getPrivateIpAddresses() == null) ? 0
                        : getPrivateIpAddresses().hashCode());
        return hashCode;
    }
    @Override
    public InstanceNetworkInterface clone() {
        try {
            return (InstanceNetworkInterface) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}