com.amazonaws.services.ec2.model.DescribeAvailabilityZonesRequest 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.DescribeAvailabilityZonesRequestMarshaller;
/**
 * 
 * Contains the parameters for DescribeAvailabilityZones.
 * 
 */
public class DescribeAvailabilityZonesRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable,
        DryRunSupportedRequest {
    /**
     * 
     * The names of one or more Availability Zones.
     * 
     */
    private com.amazonaws.internal.SdkInternalList zoneNames;
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * message - Information about the Availability Zone.
     * 
     *  
     * - 
     * 
     * region-name - The name of the region for the Availability
     * Zone (for example, us-east-1).
     * 
     *  
     * - 
     * 
     * state - The state of the Availability Zone (
     * available | information | impaired
     * | unavailable).
     * 
     *  
     * - 
     * 
     * zone-name - The name of the Availability Zone (for example,
     * us-east-1a).
     * 
     *  
     * 
     */
    private com.amazonaws.internal.SdkInternalList filters;
    /**
     * 
     * The names of one or more Availability Zones.
     * 
     * 
     * @return The names of one or more Availability Zones.
     */
    public java.util.List getZoneNames() {
        if (zoneNames == null) {
            zoneNames = new com.amazonaws.internal.SdkInternalList();
        }
        return zoneNames;
    }
    /**
     * 
     * The names of one or more Availability Zones.
     * 
     * 
     * @param zoneNames
     *        The names of one or more Availability Zones.
     */
    public void setZoneNames(java.util.Collection zoneNames) {
        if (zoneNames == null) {
            this.zoneNames = null;
            return;
        }
        this.zoneNames = new com.amazonaws.internal.SdkInternalList(
                zoneNames);
    }
    /**
     * 
     * The names of one or more Availability Zones.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setZoneNames(java.util.Collection)} or
     * {@link #withZoneNames(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param zoneNames
     *        The names of one or more Availability Zones.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeAvailabilityZonesRequest withZoneNames(String... zoneNames) {
        if (this.zoneNames == null) {
            setZoneNames(new com.amazonaws.internal.SdkInternalList(
                    zoneNames.length));
        }
        for (String ele : zoneNames) {
            this.zoneNames.add(ele);
        }
        return this;
    }
    /**
     * 
     * The names of one or more Availability Zones.
     * 
     * 
     * @param zoneNames
     *        The names of one or more Availability Zones.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeAvailabilityZonesRequest withZoneNames(
            java.util.Collection zoneNames) {
        setZoneNames(zoneNames);
        return this;
    }
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * message - Information about the Availability Zone.
     * 
     *  
     * - 
     * 
     * region-name - The name of the region for the Availability
     * Zone (for example, us-east-1).
     * 
     *  
     * - 
     * 
     * state - The state of the Availability Zone (
     * available | information | impaired
     * | unavailable).
     * 
     *  
     * - 
     * 
     * zone-name - The name of the Availability Zone (for example,
     * us-east-1a).
     * 
     *  
     * 
     * 
     * @return One or more filters.
     *         
     *         - 
     *         
     *         message - Information about the Availability Zone.
     *         
     *          
     *         - 
     *         
     *         region-name - The name of the region for the
     *         Availability Zone (for example, us-east-1).
     *         
     *          
     *         - 
     *         
     *         state - The state of the Availability Zone (
     *         available | information |
     *         impaired | unavailable).
     *         
     *          
     *         - 
     *         
     *         zone-name - The name of the Availability Zone (for
     *         example, us-east-1a).
     *         
     *          
     */
    public java.util.List getFilters() {
        if (filters == null) {
            filters = new com.amazonaws.internal.SdkInternalList();
        }
        return filters;
    }
    /**
     * 
     * One or more filters.
     * 
     * 
     * - 
     * 
     * message - Information about the Availability Zone.
     * 
     *  
     * - 
     * 
     * region-name - The name of the region for the Availability
     * Zone (for example, us-east-1).
     * 
     *  
     * - 
     * 
     * state - The state of the Availability Zone (
     * available | information | impaired
     * | unavailable).
     * 
     *  
     * - 
     * 
     * zone-name - The name of the Availability Zone (for example,
     * us-east-1a).
     * 
     *  
     * 
     * 
     * @param filters
     *        One or more filters.
     *        
     *        - 
     *        
     *        message - Information about the Availability Zone.
     *        
     *         
     *        - 
     *        
     *        region-name - The name of the region for the
     *        Availability Zone (for example, us-east-1).
     *        
     *         
     *        - 
     *        
     *        state - The state of the Availability Zone (
     *        available | information |
     *        impaired | unavailable).
     *        
     *         
     *        - 
     *        
     *        zone-name - The name of the Availability Zone (for
     *        example, us-east-1a).
     *        
     *         
     */
    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.
     * 
     * 
     * - 
     * 
     * message - Information about the Availability Zone.
     * 
     *  
     * - 
     * 
     * region-name - The name of the region for the Availability
     * Zone (for example, us-east-1).
     * 
     *  
     * - 
     * 
     * state - The state of the Availability Zone (
     * available | information | impaired
     * | unavailable).
     * 
     *  
     * - 
     * 
     * zone-name - The name of the Availability Zone (for example,
     * us-east-1a).
     * 
     *  
     * 
     * 
     * 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.
     *        
     *        - 
     *        
     *        message - Information about the Availability Zone.
     *        
     *         
     *        - 
     *        
     *        region-name - The name of the region for the
     *        Availability Zone (for example, us-east-1).
     *        
     *         
     *        - 
     *        
     *        state - The state of the Availability Zone (
     *        available | information |
     *        impaired | unavailable).
     *        
     *         
     *        - 
     *        
     *        zone-name - The name of the Availability Zone (for
     *        example, us-east-1a).
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeAvailabilityZonesRequest 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.
     * 
     * 
     * - 
     * 
     * message - Information about the Availability Zone.
     * 
     *  
     * - 
     * 
     * region-name - The name of the region for the Availability
     * Zone (for example, us-east-1).
     * 
     *  
     * - 
     * 
     * state - The state of the Availability Zone (
     * available | information | impaired
     * | unavailable).
     * 
     *  
     * - 
     * 
     * zone-name - The name of the Availability Zone (for example,
     * us-east-1a).
     * 
     *  
     * 
     * 
     * @param filters
     *        One or more filters.
     *        
     *        - 
     *        
     *        message - Information about the Availability Zone.
     *        
     *         
     *        - 
     *        
     *        region-name - The name of the region for the
     *        Availability Zone (for example, us-east-1).
     *        
     *         
     *        - 
     *        
     *        state - The state of the Availability Zone (
     *        available | information |
     *        impaired | unavailable).
     *        
     *         
     *        - 
     *        
     *        zone-name - The name of the Availability Zone (for
     *        example, us-east-1a).
     *        
     *         
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeAvailabilityZonesRequest 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 DescribeAvailabilityZonesRequestMarshaller()
                .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 (getZoneNames() != null)
            sb.append("ZoneNames: " + getZoneNames() + ",");
        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 DescribeAvailabilityZonesRequest == false)
            return false;
        DescribeAvailabilityZonesRequest other = (DescribeAvailabilityZonesRequest) obj;
        if (other.getZoneNames() == null ^ this.getZoneNames() == null)
            return false;
        if (other.getZoneNames() != null
                && other.getZoneNames().equals(this.getZoneNames()) == 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
                + ((getZoneNames() == null) ? 0 : getZoneNames().hashCode());
        hashCode = prime * hashCode
                + ((getFilters() == null) ? 0 : getFilters().hashCode());
        return hashCode;
    }
    @Override
    public DescribeAvailabilityZonesRequest clone() {
        return (DescribeAvailabilityZonesRequest) super.clone();
    }
}