com.amazonaws.services.ec2.model.Address Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2017-2022 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;
import javax.annotation.Generated;
/**
*
* Describes an Elastic IP address, or a carrier IP address.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Address implements Serializable, Cloneable {
/**
*
* The ID of the instance that the address is associated with (if any).
*
*/
private String instanceId;
/**
*
* The Elastic IP address.
*
*/
private String publicIp;
/**
*
* The ID representing the allocation of the address for use with EC2-VPC.
*
*/
private String allocationId;
/**
*
* The ID representing the association of the address with an instance in a VPC.
*
*/
private String associationId;
/**
*
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
* instances in a VPC (vpc).
*
*/
private String domain;
/**
*
* The ID of the network interface.
*
*/
private String networkInterfaceId;
/**
*
* The ID of the Amazon Web Services account that owns the network interface.
*
*/
private String networkInterfaceOwnerId;
/**
*
* The private IP address associated with the Elastic IP address.
*
*/
private String privateIpAddress;
/**
*
* Any tags assigned to the Elastic IP address.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The ID of an address pool.
*
*/
private String publicIpv4Pool;
/**
*
* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses.
*
*/
private String networkBorderGroup;
/**
*
* The customer-owned IP address.
*
*/
private String customerOwnedIp;
/**
*
* The ID of the customer-owned address pool.
*
*/
private String customerOwnedIpv4Pool;
/**
*
* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet
* in a Wavelength Zone (for example an EC2 instance).
*
*/
private String carrierIp;
/**
*
* The ID of the instance that the address is associated with (if any).
*
*
* @param instanceId
* The ID of the instance that the address is associated with (if any).
*/
public void setInstanceId(String instanceId) {
this.instanceId = instanceId;
}
/**
*
* The ID of the instance that the address is associated with (if any).
*
*
* @return The ID of the instance that the address is associated with (if any).
*/
public String getInstanceId() {
return this.instanceId;
}
/**
*
* The ID of the instance that the address is associated with (if any).
*
*
* @param instanceId
* The ID of the instance that the address is associated with (if any).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withInstanceId(String instanceId) {
setInstanceId(instanceId);
return this;
}
/**
*
* The Elastic IP address.
*
*
* @param publicIp
* The Elastic IP address.
*/
public void setPublicIp(String publicIp) {
this.publicIp = publicIp;
}
/**
*
* The Elastic IP address.
*
*
* @return The Elastic IP address.
*/
public String getPublicIp() {
return this.publicIp;
}
/**
*
* The Elastic IP address.
*
*
* @param publicIp
* The Elastic IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withPublicIp(String publicIp) {
setPublicIp(publicIp);
return this;
}
/**
*
* The ID representing the allocation of the address for use with EC2-VPC.
*
*
* @param allocationId
* The ID representing the allocation of the address for use with EC2-VPC.
*/
public void setAllocationId(String allocationId) {
this.allocationId = allocationId;
}
/**
*
* The ID representing the allocation of the address for use with EC2-VPC.
*
*
* @return The ID representing the allocation of the address for use with EC2-VPC.
*/
public String getAllocationId() {
return this.allocationId;
}
/**
*
* The ID representing the allocation of the address for use with EC2-VPC.
*
*
* @param allocationId
* The ID representing the allocation of the address for use with EC2-VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withAllocationId(String allocationId) {
setAllocationId(allocationId);
return this;
}
/**
*
* The ID representing the association of the address with an instance in a VPC.
*
*
* @param associationId
* The ID representing the association of the address with an instance in a VPC.
*/
public void setAssociationId(String associationId) {
this.associationId = associationId;
}
/**
*
* The ID representing the association of the address with an instance in a VPC.
*
*
* @return The ID representing the association of the address with an instance in a VPC.
*/
public String getAssociationId() {
return this.associationId;
}
/**
*
* The ID representing the association of the address with an instance in a VPC.
*
*
* @param associationId
* The ID representing the association of the address with an instance in a VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withAssociationId(String associationId) {
setAssociationId(associationId);
return this;
}
/**
*
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
* instances in a VPC (vpc).
*
*
* @param domain
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard)
* or instances in a VPC (vpc).
* @see DomainType
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
* instances in a VPC (vpc).
*
*
* @return Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard
* ) or instances in a VPC (vpc).
* @see DomainType
*/
public String getDomain() {
return this.domain;
}
/**
*
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
* instances in a VPC (vpc).
*
*
* @param domain
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard)
* or instances in a VPC (vpc).
* @return Returns a reference to this object so that method calls can be chained together.
* @see DomainType
*/
public Address withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
* instances in a VPC (vpc).
*
*
* @param domain
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard)
* or instances in a VPC (vpc).
* @see DomainType
*/
public void setDomain(DomainType domain) {
withDomain(domain);
}
/**
*
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard) or
* instances in a VPC (vpc).
*
*
* @param domain
* Indicates whether this Elastic IP address is for use with instances in EC2-Classic (standard)
* or instances in a VPC (vpc).
* @return Returns a reference to this object so that method calls can be chained together.
* @see DomainType
*/
public Address withDomain(DomainType domain) {
this.domain = domain.toString();
return this;
}
/**
*
* 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 Address withNetworkInterfaceId(String networkInterfaceId) {
setNetworkInterfaceId(networkInterfaceId);
return this;
}
/**
*
* The ID of the Amazon Web Services account that owns the network interface.
*
*
* @param networkInterfaceOwnerId
* The ID of the Amazon Web Services account that owns the network interface.
*/
public void setNetworkInterfaceOwnerId(String networkInterfaceOwnerId) {
this.networkInterfaceOwnerId = networkInterfaceOwnerId;
}
/**
*
* The ID of the Amazon Web Services account that owns the network interface.
*
*
* @return The ID of the Amazon Web Services account that owns the network interface.
*/
public String getNetworkInterfaceOwnerId() {
return this.networkInterfaceOwnerId;
}
/**
*
* The ID of the Amazon Web Services account that owns the network interface.
*
*
* @param networkInterfaceOwnerId
* The ID of the Amazon Web Services account that owns the network interface.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withNetworkInterfaceOwnerId(String networkInterfaceOwnerId) {
setNetworkInterfaceOwnerId(networkInterfaceOwnerId);
return this;
}
/**
*
* The private IP address associated with the Elastic IP address.
*
*
* @param privateIpAddress
* The private IP address associated with the Elastic IP address.
*/
public void setPrivateIpAddress(String privateIpAddress) {
this.privateIpAddress = privateIpAddress;
}
/**
*
* The private IP address associated with the Elastic IP address.
*
*
* @return The private IP address associated with the Elastic IP address.
*/
public String getPrivateIpAddress() {
return this.privateIpAddress;
}
/**
*
* The private IP address associated with the Elastic IP address.
*
*
* @param privateIpAddress
* The private IP address associated with the Elastic IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withPrivateIpAddress(String privateIpAddress) {
setPrivateIpAddress(privateIpAddress);
return this;
}
/**
*
* Any tags assigned to the Elastic IP address.
*
*
* @return Any tags assigned to the Elastic IP address.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Any tags assigned to the Elastic IP address.
*
*
* @param tags
* Any tags assigned to the Elastic IP address.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* Any tags assigned to the Elastic IP address.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Any tags assigned to the Elastic IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Any tags assigned to the Elastic IP address.
*
*
* @param tags
* Any tags assigned to the Elastic IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The ID of an address pool.
*
*
* @param publicIpv4Pool
* The ID of an address pool.
*/
public void setPublicIpv4Pool(String publicIpv4Pool) {
this.publicIpv4Pool = publicIpv4Pool;
}
/**
*
* The ID of an address pool.
*
*
* @return The ID of an address pool.
*/
public String getPublicIpv4Pool() {
return this.publicIpv4Pool;
}
/**
*
* The ID of an address pool.
*
*
* @param publicIpv4Pool
* The ID of an address pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withPublicIpv4Pool(String publicIpv4Pool) {
setPublicIpv4Pool(publicIpv4Pool);
return this;
}
/**
*
* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses.
*
*
* @param networkBorderGroup
* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web
* Services advertises IP addresses.
*/
public void setNetworkBorderGroup(String networkBorderGroup) {
this.networkBorderGroup = networkBorderGroup;
}
/**
*
* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses.
*
*
* @return The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web
* Services advertises IP addresses.
*/
public String getNetworkBorderGroup() {
return this.networkBorderGroup;
}
/**
*
* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses.
*
*
* @param networkBorderGroup
* The name of the unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web
* Services advertises IP addresses.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withNetworkBorderGroup(String networkBorderGroup) {
setNetworkBorderGroup(networkBorderGroup);
return this;
}
/**
*
* The customer-owned IP address.
*
*
* @param customerOwnedIp
* The customer-owned IP address.
*/
public void setCustomerOwnedIp(String customerOwnedIp) {
this.customerOwnedIp = customerOwnedIp;
}
/**
*
* The customer-owned IP address.
*
*
* @return The customer-owned IP address.
*/
public String getCustomerOwnedIp() {
return this.customerOwnedIp;
}
/**
*
* The customer-owned IP address.
*
*
* @param customerOwnedIp
* The customer-owned IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withCustomerOwnedIp(String customerOwnedIp) {
setCustomerOwnedIp(customerOwnedIp);
return this;
}
/**
*
* The ID of the customer-owned address pool.
*
*
* @param customerOwnedIpv4Pool
* The ID of the customer-owned address pool.
*/
public void setCustomerOwnedIpv4Pool(String customerOwnedIpv4Pool) {
this.customerOwnedIpv4Pool = customerOwnedIpv4Pool;
}
/**
*
* The ID of the customer-owned address pool.
*
*
* @return The ID of the customer-owned address pool.
*/
public String getCustomerOwnedIpv4Pool() {
return this.customerOwnedIpv4Pool;
}
/**
*
* The ID of the customer-owned address pool.
*
*
* @param customerOwnedIpv4Pool
* The ID of the customer-owned address pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withCustomerOwnedIpv4Pool(String customerOwnedIpv4Pool) {
setCustomerOwnedIpv4Pool(customerOwnedIpv4Pool);
return this;
}
/**
*
* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet
* in a Wavelength Zone (for example an EC2 instance).
*
*
* @param carrierIp
* The carrier IP address associated. This option is only available for network interfaces which reside in a
* subnet in a Wavelength Zone (for example an EC2 instance).
*/
public void setCarrierIp(String carrierIp) {
this.carrierIp = carrierIp;
}
/**
*
* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet
* in a Wavelength Zone (for example an EC2 instance).
*
*
* @return The carrier IP address associated. This option is only available for network interfaces which reside in a
* subnet in a Wavelength Zone (for example an EC2 instance).
*/
public String getCarrierIp() {
return this.carrierIp;
}
/**
*
* The carrier IP address associated. This option is only available for network interfaces which reside in a subnet
* in a Wavelength Zone (for example an EC2 instance).
*
*
* @param carrierIp
* The carrier IP address associated. This option is only available for network interfaces which reside in a
* subnet in a Wavelength Zone (for example an EC2 instance).
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Address withCarrierIp(String carrierIp) {
setCarrierIp(carrierIp);
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 (getInstanceId() != null)
sb.append("InstanceId: ").append(getInstanceId()).append(",");
if (getPublicIp() != null)
sb.append("PublicIp: ").append(getPublicIp()).append(",");
if (getAllocationId() != null)
sb.append("AllocationId: ").append(getAllocationId()).append(",");
if (getAssociationId() != null)
sb.append("AssociationId: ").append(getAssociationId()).append(",");
if (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getNetworkInterfaceId() != null)
sb.append("NetworkInterfaceId: ").append(getNetworkInterfaceId()).append(",");
if (getNetworkInterfaceOwnerId() != null)
sb.append("NetworkInterfaceOwnerId: ").append(getNetworkInterfaceOwnerId()).append(",");
if (getPrivateIpAddress() != null)
sb.append("PrivateIpAddress: ").append(getPrivateIpAddress()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getPublicIpv4Pool() != null)
sb.append("PublicIpv4Pool: ").append(getPublicIpv4Pool()).append(",");
if (getNetworkBorderGroup() != null)
sb.append("NetworkBorderGroup: ").append(getNetworkBorderGroup()).append(",");
if (getCustomerOwnedIp() != null)
sb.append("CustomerOwnedIp: ").append(getCustomerOwnedIp()).append(",");
if (getCustomerOwnedIpv4Pool() != null)
sb.append("CustomerOwnedIpv4Pool: ").append(getCustomerOwnedIpv4Pool()).append(",");
if (getCarrierIp() != null)
sb.append("CarrierIp: ").append(getCarrierIp());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Address == false)
return false;
Address other = (Address) obj;
if (other.getInstanceId() == null ^ this.getInstanceId() == null)
return false;
if (other.getInstanceId() != null && other.getInstanceId().equals(this.getInstanceId()) == false)
return false;
if (other.getPublicIp() == null ^ this.getPublicIp() == null)
return false;
if (other.getPublicIp() != null && other.getPublicIp().equals(this.getPublicIp()) == false)
return false;
if (other.getAllocationId() == null ^ this.getAllocationId() == null)
return false;
if (other.getAllocationId() != null && other.getAllocationId().equals(this.getAllocationId()) == false)
return false;
if (other.getAssociationId() == null ^ this.getAssociationId() == null)
return false;
if (other.getAssociationId() != null && other.getAssociationId().equals(this.getAssociationId()) == false)
return false;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getNetworkInterfaceId() == null ^ this.getNetworkInterfaceId() == null)
return false;
if (other.getNetworkInterfaceId() != null && other.getNetworkInterfaceId().equals(this.getNetworkInterfaceId()) == false)
return false;
if (other.getNetworkInterfaceOwnerId() == null ^ this.getNetworkInterfaceOwnerId() == null)
return false;
if (other.getNetworkInterfaceOwnerId() != null && other.getNetworkInterfaceOwnerId().equals(this.getNetworkInterfaceOwnerId()) == 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.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getPublicIpv4Pool() == null ^ this.getPublicIpv4Pool() == null)
return false;
if (other.getPublicIpv4Pool() != null && other.getPublicIpv4Pool().equals(this.getPublicIpv4Pool()) == false)
return false;
if (other.getNetworkBorderGroup() == null ^ this.getNetworkBorderGroup() == null)
return false;
if (other.getNetworkBorderGroup() != null && other.getNetworkBorderGroup().equals(this.getNetworkBorderGroup()) == false)
return false;
if (other.getCustomerOwnedIp() == null ^ this.getCustomerOwnedIp() == null)
return false;
if (other.getCustomerOwnedIp() != null && other.getCustomerOwnedIp().equals(this.getCustomerOwnedIp()) == false)
return false;
if (other.getCustomerOwnedIpv4Pool() == null ^ this.getCustomerOwnedIpv4Pool() == null)
return false;
if (other.getCustomerOwnedIpv4Pool() != null && other.getCustomerOwnedIpv4Pool().equals(this.getCustomerOwnedIpv4Pool()) == false)
return false;
if (other.getCarrierIp() == null ^ this.getCarrierIp() == null)
return false;
if (other.getCarrierIp() != null && other.getCarrierIp().equals(this.getCarrierIp()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceId() == null) ? 0 : getInstanceId().hashCode());
hashCode = prime * hashCode + ((getPublicIp() == null) ? 0 : getPublicIp().hashCode());
hashCode = prime * hashCode + ((getAllocationId() == null) ? 0 : getAllocationId().hashCode());
hashCode = prime * hashCode + ((getAssociationId() == null) ? 0 : getAssociationId().hashCode());
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getNetworkInterfaceId() == null) ? 0 : getNetworkInterfaceId().hashCode());
hashCode = prime * hashCode + ((getNetworkInterfaceOwnerId() == null) ? 0 : getNetworkInterfaceOwnerId().hashCode());
hashCode = prime * hashCode + ((getPrivateIpAddress() == null) ? 0 : getPrivateIpAddress().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getPublicIpv4Pool() == null) ? 0 : getPublicIpv4Pool().hashCode());
hashCode = prime * hashCode + ((getNetworkBorderGroup() == null) ? 0 : getNetworkBorderGroup().hashCode());
hashCode = prime * hashCode + ((getCustomerOwnedIp() == null) ? 0 : getCustomerOwnedIp().hashCode());
hashCode = prime * hashCode + ((getCustomerOwnedIpv4Pool() == null) ? 0 : getCustomerOwnedIpv4Pool().hashCode());
hashCode = prime * hashCode + ((getCarrierIp() == null) ? 0 : getCarrierIp().hashCode());
return hashCode;
}
@Override
public Address clone() {
try {
return (Address) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}