com.amazonaws.services.ec2.model.AllocateAddressRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 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;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.AllocateAddressRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AllocateAddressRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The network (vpc).
*
*/
private String domain;
/**
*
* The Elastic IP address to recover or an IPv4 address from an address pool.
*
*/
private String address;
/**
*
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
* pool. To specify a specific address from the address pool, use the Address parameter instead.
*
*/
private String publicIpv4Pool;
/**
*
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP
* addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network
* border groups.
*
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive
* an InvalidParameterCombination error.
*
*/
private String networkBorderGroup;
/**
*
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address
* pool. Alternatively, specify a specific address from the address pool.
*
*/
private String customerOwnedIpv4Pool;
/**
*
* The tags to assign to the Elastic IP address.
*
*/
private com.amazonaws.internal.SdkInternalList tagSpecifications;
/**
*
* The network (vpc).
*
*
* @param domain
* The network (vpc).
* @see DomainType
*/
public void setDomain(String domain) {
this.domain = domain;
}
/**
*
* The network (vpc).
*
*
* @return The network (vpc).
* @see DomainType
*/
public String getDomain() {
return this.domain;
}
/**
*
* The network (vpc).
*
*
* @param domain
* The network (vpc).
* @return Returns a reference to this object so that method calls can be chained together.
* @see DomainType
*/
public AllocateAddressRequest withDomain(String domain) {
setDomain(domain);
return this;
}
/**
*
* The network (vpc).
*
*
* @param domain
* The network (vpc).
* @see DomainType
*/
public void setDomain(DomainType domain) {
withDomain(domain);
}
/**
*
* The network (vpc).
*
*
* @param domain
* The network (vpc).
* @return Returns a reference to this object so that method calls can be chained together.
* @see DomainType
*/
public AllocateAddressRequest withDomain(DomainType domain) {
this.domain = domain.toString();
return this;
}
/**
*
* The Elastic IP address to recover or an IPv4 address from an address pool.
*
*
* @param address
* The Elastic IP address to recover or an IPv4 address from an address pool.
*/
public void setAddress(String address) {
this.address = address;
}
/**
*
* The Elastic IP address to recover or an IPv4 address from an address pool.
*
*
* @return The Elastic IP address to recover or an IPv4 address from an address pool.
*/
public String getAddress() {
return this.address;
}
/**
*
* The Elastic IP address to recover or an IPv4 address from an address pool.
*
*
* @param address
* The Elastic IP address to recover or an IPv4 address from an address pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AllocateAddressRequest withAddress(String address) {
setAddress(address);
return this;
}
/**
*
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
* pool. To specify a specific address from the address pool, use the Address parameter instead.
*
*
* @param publicIpv4Pool
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the
* address pool. To specify a specific address from the address pool, use the Address parameter
* instead.
*/
public void setPublicIpv4Pool(String publicIpv4Pool) {
this.publicIpv4Pool = publicIpv4Pool;
}
/**
*
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
* pool. To specify a specific address from the address pool, use the Address parameter instead.
*
*
* @return The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the
* address pool. To specify a specific address from the address pool, use the Address parameter
* instead.
*/
public String getPublicIpv4Pool() {
return this.publicIpv4Pool;
}
/**
*
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the address
* pool. To specify a specific address from the address pool, use the Address parameter instead.
*
*
* @param publicIpv4Pool
* The ID of an address pool that you own. Use this parameter to let Amazon EC2 select an address from the
* address pool. To specify a specific address from the address pool, use the Address parameter
* instead.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AllocateAddressRequest withPublicIpv4Pool(String publicIpv4Pool) {
setPublicIpv4Pool(publicIpv4Pool);
return this;
}
/**
*
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP
* addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network
* border groups.
*
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive
* an InvalidParameterCombination error.
*
*
* @param networkBorderGroup
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot
* move between network border groups.
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you
* receive an InvalidParameterCombination error.
*/
public void setNetworkBorderGroup(String networkBorderGroup) {
this.networkBorderGroup = networkBorderGroup;
}
/**
*
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP
* addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network
* border groups.
*
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive
* an InvalidParameterCombination error.
*
*
* @return A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot
* move between network border groups.
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you
* receive an InvalidParameterCombination error.
*/
public String getNetworkBorderGroup() {
return this.networkBorderGroup;
}
/**
*
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services advertises IP
* addresses. Use this parameter to limit the IP address to this location. IP addresses cannot move between network
* border groups.
*
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you receive
* an InvalidParameterCombination error.
*
*
* @param networkBorderGroup
* A unique set of Availability Zones, Local Zones, or Wavelength Zones from which Amazon Web Services
* advertises IP addresses. Use this parameter to limit the IP address to this location. IP addresses cannot
* move between network border groups.
*
* Use
* DescribeAvailabilityZones to view the network border groups.
*
*
* You cannot use a network border group with EC2 Classic. If you attempt this operation on EC2 Classic, you
* receive an InvalidParameterCombination error.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AllocateAddressRequest withNetworkBorderGroup(String networkBorderGroup) {
setNetworkBorderGroup(networkBorderGroup);
return this;
}
/**
*
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address
* pool. Alternatively, specify a specific address from the address pool.
*
*
* @param customerOwnedIpv4Pool
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the
* address pool. Alternatively, specify a specific address from the address pool.
*/
public void setCustomerOwnedIpv4Pool(String customerOwnedIpv4Pool) {
this.customerOwnedIpv4Pool = customerOwnedIpv4Pool;
}
/**
*
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address
* pool. Alternatively, specify a specific address from the address pool.
*
*
* @return The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the
* address pool. Alternatively, specify a specific address from the address pool.
*/
public String getCustomerOwnedIpv4Pool() {
return this.customerOwnedIpv4Pool;
}
/**
*
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the address
* pool. Alternatively, specify a specific address from the address pool.
*
*
* @param customerOwnedIpv4Pool
* The ID of a customer-owned address pool. Use this parameter to let Amazon EC2 select an address from the
* address pool. Alternatively, specify a specific address from the address pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AllocateAddressRequest withCustomerOwnedIpv4Pool(String customerOwnedIpv4Pool) {
setCustomerOwnedIpv4Pool(customerOwnedIpv4Pool);
return this;
}
/**
*
* The tags to assign to the Elastic IP address.
*
*
* @return The tags to assign to the Elastic IP address.
*/
public java.util.List getTagSpecifications() {
if (tagSpecifications == null) {
tagSpecifications = new com.amazonaws.internal.SdkInternalList();
}
return tagSpecifications;
}
/**
*
* The tags to assign to the Elastic IP address.
*
*
* @param tagSpecifications
* The tags to assign to the Elastic IP address.
*/
public void setTagSpecifications(java.util.Collection tagSpecifications) {
if (tagSpecifications == null) {
this.tagSpecifications = null;
return;
}
this.tagSpecifications = new com.amazonaws.internal.SdkInternalList(tagSpecifications);
}
/**
*
* The tags to assign to the Elastic IP address.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTagSpecifications(java.util.Collection)} or {@link #withTagSpecifications(java.util.Collection)} if
* you want to override the existing values.
*
*
* @param tagSpecifications
* The tags to assign to the Elastic IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AllocateAddressRequest withTagSpecifications(TagSpecification... tagSpecifications) {
if (this.tagSpecifications == null) {
setTagSpecifications(new com.amazonaws.internal.SdkInternalList(tagSpecifications.length));
}
for (TagSpecification ele : tagSpecifications) {
this.tagSpecifications.add(ele);
}
return this;
}
/**
*
* The tags to assign to the Elastic IP address.
*
*
* @param tagSpecifications
* The tags to assign to the Elastic IP address.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AllocateAddressRequest withTagSpecifications(java.util.Collection tagSpecifications) {
setTagSpecifications(tagSpecifications);
return this;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new AllocateAddressRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getDomain() != null)
sb.append("Domain: ").append(getDomain()).append(",");
if (getAddress() != null)
sb.append("Address: ").append(getAddress()).append(",");
if (getPublicIpv4Pool() != null)
sb.append("PublicIpv4Pool: ").append(getPublicIpv4Pool()).append(",");
if (getNetworkBorderGroup() != null)
sb.append("NetworkBorderGroup: ").append(getNetworkBorderGroup()).append(",");
if (getCustomerOwnedIpv4Pool() != null)
sb.append("CustomerOwnedIpv4Pool: ").append(getCustomerOwnedIpv4Pool()).append(",");
if (getTagSpecifications() != null)
sb.append("TagSpecifications: ").append(getTagSpecifications());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof AllocateAddressRequest == false)
return false;
AllocateAddressRequest other = (AllocateAddressRequest) obj;
if (other.getDomain() == null ^ this.getDomain() == null)
return false;
if (other.getDomain() != null && other.getDomain().equals(this.getDomain()) == false)
return false;
if (other.getAddress() == null ^ this.getAddress() == null)
return false;
if (other.getAddress() != null && other.getAddress().equals(this.getAddress()) == 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.getCustomerOwnedIpv4Pool() == null ^ this.getCustomerOwnedIpv4Pool() == null)
return false;
if (other.getCustomerOwnedIpv4Pool() != null && other.getCustomerOwnedIpv4Pool().equals(this.getCustomerOwnedIpv4Pool()) == false)
return false;
if (other.getTagSpecifications() == null ^ this.getTagSpecifications() == null)
return false;
if (other.getTagSpecifications() != null && other.getTagSpecifications().equals(this.getTagSpecifications()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDomain() == null) ? 0 : getDomain().hashCode());
hashCode = prime * hashCode + ((getAddress() == null) ? 0 : getAddress().hashCode());
hashCode = prime * hashCode + ((getPublicIpv4Pool() == null) ? 0 : getPublicIpv4Pool().hashCode());
hashCode = prime * hashCode + ((getNetworkBorderGroup() == null) ? 0 : getNetworkBorderGroup().hashCode());
hashCode = prime * hashCode + ((getCustomerOwnedIpv4Pool() == null) ? 0 : getCustomerOwnedIpv4Pool().hashCode());
hashCode = prime * hashCode + ((getTagSpecifications() == null) ? 0 : getTagSpecifications().hashCode());
return hashCode;
}
@Override
public AllocateAddressRequest clone() {
return (AllocateAddressRequest) super.clone();
}
}