com.amazonaws.services.ec2.model.DescribeAddressesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2010-2015 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 com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeAddressesRequestMarshaller;
/**
* Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeAddresses(DescribeAddressesRequest) DescribeAddresses operation}.
*
* Describes one or more of your Elastic IP addresses.
*
*
* An Elastic IP address is for use in either the EC2-Classic platform or
* in a VPC. For more information, see
* Elastic IP Addresses
* in the Amazon Elastic Compute Cloud User Guide .
*
*
* @see com.amazonaws.services.ec2.AmazonEC2#describeAddresses(DescribeAddressesRequest)
*/
public class DescribeAddressesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
* [EC2-Classic] One or more Elastic IP addresses. Default: Describes
* all your Elastic IP addresses.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag publicIps;
/**
* One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag filters;
/**
* [EC2-VPC] One or more allocation IDs. Default: Describes all your
* Elastic IP addresses.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag allocationIds;
/**
* [EC2-Classic] One or more Elastic IP addresses. Default: Describes
* all your Elastic IP addresses.
*
* @return [EC2-Classic] One or more Elastic IP addresses.
Default: Describes
* all your Elastic IP addresses.
*/
public java.util.List getPublicIps() {
if (publicIps == null) {
publicIps = new com.amazonaws.internal.ListWithAutoConstructFlag();
publicIps.setAutoConstruct(true);
}
return publicIps;
}
/**
* [EC2-Classic] One or more Elastic IP addresses. Default: Describes
* all your Elastic IP addresses.
*
* @param publicIps [EC2-Classic] One or more Elastic IP addresses.
Default: Describes
* all your Elastic IP addresses.
*/
public void setPublicIps(java.util.Collection publicIps) {
if (publicIps == null) {
this.publicIps = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag publicIpsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(publicIps.size());
publicIpsCopy.addAll(publicIps);
this.publicIps = publicIpsCopy;
}
/**
* [EC2-Classic] One or more Elastic IP addresses. Default: Describes
* all your Elastic IP addresses.
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setPublicIps(java.util.Collection)} or {@link
* #withPublicIps(java.util.Collection)} if you want to override the
* existing values.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param publicIps [EC2-Classic] One or more Elastic IP addresses.
Default: Describes
* all your Elastic IP addresses.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAddressesRequest withPublicIps(String... publicIps) {
if (getPublicIps() == null) setPublicIps(new java.util.ArrayList(publicIps.length));
for (String value : publicIps) {
getPublicIps().add(value);
}
return this;
}
/**
* [EC2-Classic] One or more Elastic IP addresses. Default: Describes
* all your Elastic IP addresses.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param publicIps [EC2-Classic] One or more Elastic IP addresses.
Default: Describes
* all your Elastic IP addresses.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAddressesRequest withPublicIps(java.util.Collection publicIps) {
if (publicIps == null) {
this.publicIps = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag publicIpsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(publicIps.size());
publicIpsCopy.addAll(publicIps);
this.publicIps = publicIpsCopy;
}
return this;
}
/**
* One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*
* @return One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.ListWithAutoConstructFlag();
filters.setAutoConstruct(true);
}
return filters;
}
/**
* One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*
* @param filters One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
/**
* One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setFilters(java.util.Collection)} or {@link
* #withFilters(java.util.Collection)} if you want to override the
* existing values.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAddressesRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayList(filters.length));
for (Filter value : filters) {
getFilters().add(value);
}
return this;
}
/**
* One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters. Filter names and values are case-sensitive.
* -
allocation-id - [EC2-VPC] The allocation ID for
* the address.
-
association-id - [EC2-VPC] The
* association ID for the address.
-
domain -
* Indicates whether the address is for use in EC2-Classic
* (standard) or in a VPC (vpc).
-
*
instance-id - The ID of the instance the address is
* associated with, if any.
-
*
network-interface-id - [EC2-VPC] The ID of the network
* interface that the address is associated with, if any.
-
*
network-interface-owner-id - The AWS account ID of the
* owner.
-
private-ip-address - [EC2-VPC] The
* private IP address associated with the Elastic IP address.
-
*
public-ip - The Elastic IP address.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAddressesRequest withFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag filtersCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(filters.size());
filtersCopy.addAll(filters);
this.filters = filtersCopy;
}
return this;
}
/**
* [EC2-VPC] One or more allocation IDs. Default: Describes all your
* Elastic IP addresses.
*
* @return [EC2-VPC] One or more allocation IDs.
Default: Describes all your
* Elastic IP addresses.
*/
public java.util.List getAllocationIds() {
if (allocationIds == null) {
allocationIds = new com.amazonaws.internal.ListWithAutoConstructFlag();
allocationIds.setAutoConstruct(true);
}
return allocationIds;
}
/**
* [EC2-VPC] One or more allocation IDs. Default: Describes all your
* Elastic IP addresses.
*
* @param allocationIds [EC2-VPC] One or more allocation IDs.
Default: Describes all your
* Elastic IP addresses.
*/
public void setAllocationIds(java.util.Collection allocationIds) {
if (allocationIds == null) {
this.allocationIds = null;
return;
}
com.amazonaws.internal.ListWithAutoConstructFlag allocationIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(allocationIds.size());
allocationIdsCopy.addAll(allocationIds);
this.allocationIds = allocationIdsCopy;
}
/**
* [EC2-VPC] One or more allocation IDs. Default: Describes all your
* Elastic IP addresses.
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setAllocationIds(java.util.Collection)} or {@link
* #withAllocationIds(java.util.Collection)} if you want to override the
* existing values.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param allocationIds [EC2-VPC] One or more allocation IDs.
Default: Describes all your
* Elastic IP addresses.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAddressesRequest withAllocationIds(String... allocationIds) {
if (getAllocationIds() == null) setAllocationIds(new java.util.ArrayList(allocationIds.length));
for (String value : allocationIds) {
getAllocationIds().add(value);
}
return this;
}
/**
* [EC2-VPC] One or more allocation IDs. Default: Describes all your
* Elastic IP addresses.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param allocationIds [EC2-VPC] One or more allocation IDs.
Default: Describes all your
* Elastic IP addresses.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeAddressesRequest withAllocationIds(java.util.Collection allocationIds) {
if (allocationIds == null) {
this.allocationIds = null;
} else {
com.amazonaws.internal.ListWithAutoConstructFlag allocationIdsCopy = new com.amazonaws.internal.ListWithAutoConstructFlag(allocationIds.size());
allocationIdsCopy.addAll(allocationIds);
this.allocationIds = allocationIdsCopy;
}
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 DescribeAddressesRequestMarshaller().marshall(this);
request.addParameter("DryRun", Boolean.toString(true));
return request;
}
/**
* 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 (getPublicIps() != null) sb.append("PublicIps: " + getPublicIps() + ",");
if (getFilters() != null) sb.append("Filters: " + getFilters() + ",");
if (getAllocationIds() != null) sb.append("AllocationIds: " + getAllocationIds() );
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPublicIps() == null) ? 0 : getPublicIps().hashCode());
hashCode = prime * hashCode + ((getFilters() == null) ? 0 : getFilters().hashCode());
hashCode = prime * hashCode + ((getAllocationIds() == null) ? 0 : getAllocationIds().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) return true;
if (obj == null) return false;
if (obj instanceof DescribeAddressesRequest == false) return false;
DescribeAddressesRequest other = (DescribeAddressesRequest)obj;
if (other.getPublicIps() == null ^ this.getPublicIps() == null) return false;
if (other.getPublicIps() != null && other.getPublicIps().equals(this.getPublicIps()) == false) return false;
if (other.getFilters() == null ^ this.getFilters() == null) return false;
if (other.getFilters() != null && other.getFilters().equals(this.getFilters()) == false) return false;
if (other.getAllocationIds() == null ^ this.getAllocationIds() == null) return false;
if (other.getAllocationIds() != null && other.getAllocationIds().equals(this.getAllocationIds()) == false) return false;
return true;
}
@Override
public DescribeAddressesRequest clone() {
return (DescribeAddressesRequest) super.clone();
}
}