com.amazonaws.services.ec2.model.DescribeRegionsRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
import com.amazonaws.Request;
import com.amazonaws.services.ec2.model.transform.DescribeRegionsRequestMarshaller;
/**
*
* Contains the parameters for DescribeRegions.
*
*/
public class DescribeRegionsRequest extends AmazonWebServiceRequest implements
Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The names of one or more regions.
*
*/
private com.amazonaws.internal.SdkInternalList regionNames;
/**
*
* One or more filters.
*
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*
*/
private com.amazonaws.internal.SdkInternalList filters;
/**
*
* The names of one or more regions.
*
*
* @return The names of one or more regions.
*/
public java.util.List getRegionNames() {
if (regionNames == null) {
regionNames = new com.amazonaws.internal.SdkInternalList();
}
return regionNames;
}
/**
*
* The names of one or more regions.
*
*
* @param regionNames
* The names of one or more regions.
*/
public void setRegionNames(java.util.Collection regionNames) {
if (regionNames == null) {
this.regionNames = null;
return;
}
this.regionNames = new com.amazonaws.internal.SdkInternalList(
regionNames);
}
/**
*
* The names of one or more regions.
*
*
* NOTE: This method appends the values to the existing list (if
* any). Use {@link #setRegionNames(java.util.Collection)} or
* {@link #withRegionNames(java.util.Collection)} if you want to override
* the existing values.
*
*
* @param regionNames
* The names of one or more regions.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeRegionsRequest withRegionNames(String... regionNames) {
if (this.regionNames == null) {
setRegionNames(new com.amazonaws.internal.SdkInternalList(
regionNames.length));
}
for (String ele : regionNames) {
this.regionNames.add(ele);
}
return this;
}
/**
*
* The names of one or more regions.
*
*
* @param regionNames
* The names of one or more regions.
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeRegionsRequest withRegionNames(
java.util.Collection regionNames) {
setRegionNames(regionNames);
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*
*
* @return One or more filters.
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*/
public java.util.List getFilters() {
if (filters == null) {
filters = new com.amazonaws.internal.SdkInternalList();
}
return filters;
}
/**
*
* One or more filters.
*
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*/
public void setFilters(java.util.Collection filters) {
if (filters == null) {
this.filters = null;
return;
}
this.filters = new com.amazonaws.internal.SdkInternalList(
filters);
}
/**
*
* One or more filters.
*
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*
*
* 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.
*
*
* @param filters
* One or more filters.
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeRegionsRequest withFilters(Filter... filters) {
if (this.filters == null) {
setFilters(new com.amazonaws.internal.SdkInternalList(
filters.length));
}
for (Filter ele : filters) {
this.filters.add(ele);
}
return this;
}
/**
*
* One or more filters.
*
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
*
*
* @param filters
* One or more filters.
*
* -
*
* endpoint - The endpoint of the region (for example,
* ec2.us-east-1.amazonaws.com).
*
*
* -
*
* region-name - The name of the region (for example,
* us-east-1).
*
*
* @return Returns a reference to this object so that method calls can be
* chained together.
*/
public DescribeRegionsRequest withFilters(
java.util.Collection filters) {
setFilters(filters);
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 DescribeRegionsRequestMarshaller()
.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 (getRegionNames() != null)
sb.append("RegionNames: " + getRegionNames() + ",");
if (getFilters() != null)
sb.append("Filters: " + getFilters());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DescribeRegionsRequest == false)
return false;
DescribeRegionsRequest other = (DescribeRegionsRequest) obj;
if (other.getRegionNames() == null ^ this.getRegionNames() == null)
return false;
if (other.getRegionNames() != null
&& other.getRegionNames().equals(this.getRegionNames()) == false)
return false;
if (other.getFilters() == null ^ this.getFilters() == null)
return false;
if (other.getFilters() != null
&& other.getFilters().equals(this.getFilters()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime
* hashCode
+ ((getRegionNames() == null) ? 0 : getRegionNames().hashCode());
hashCode = prime * hashCode
+ ((getFilters() == null) ? 0 : getFilters().hashCode());
return hashCode;
}
@Override
public DescribeRegionsRequest clone() {
return (DescribeRegionsRequest) super.clone();
}
}