com.amazonaws.services.cloudsearchv2.model.DescribeDomainsRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cloudsearch Show documentation
The AWS Java SDK for Amazon CloudSearch module holds the client classes that are used for communicating with Amazon CloudSearch Service
There is a newer version: 1.12.780
Show newest version
/*
 * 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.cloudsearchv2.model;

import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * Container for the parameters to the DescribeDomains
 * operation. By default shows the status of all domains. To restrict the
 * response to particular domains, specify the names of the domains you want to
 * describe.
 * 
 */
public class DescribeDomainsRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {

    /**
     * 
     * The names of the domains you want to include in the response.
     * 
     */
    private com.amazonaws.internal.SdkInternalList domainNames;

    /**
     * 
     * The names of the domains you want to include in the response.
     * 
     * 
     * @return The names of the domains you want to include in the response.
     */

    public java.util.List getDomainNames() {
        if (domainNames == null) {
            domainNames = new com.amazonaws.internal.SdkInternalList();
        }
        return domainNames;
    }

    /**
     * 
     * The names of the domains you want to include in the response.
     * 
     * 
     * @param domainNames
     *        The names of the domains you want to include in the response.
     */

    public void setDomainNames(java.util.Collection domainNames) {
        if (domainNames == null) {
            this.domainNames = null;
            return;
        }

        this.domainNames = new com.amazonaws.internal.SdkInternalList(
                domainNames);
    }

    /**
     * 
     * The names of the domains you want to include in the response.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setDomainNames(java.util.Collection)} or
     * {@link #withDomainNames(java.util.Collection)} if you want to override
     * the existing values.
     * 
     * 
     * @param domainNames
     *        The names of the domains you want to include in the response.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public DescribeDomainsRequest withDomainNames(String... domainNames) {
        if (this.domainNames == null) {
            setDomainNames(new com.amazonaws.internal.SdkInternalList(
                    domainNames.length));
        }
        for (String ele : domainNames) {
            this.domainNames.add(ele);
        }
        return this;
    }

    /**
     * 
     * The names of the domains you want to include in the response.
     * 
     * 
     * @param domainNames
     *        The names of the domains you want to include in the response.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */

    public DescribeDomainsRequest withDomainNames(
            java.util.Collection domainNames) {
        setDomainNames(domainNames);
        return this;
    }

    /**
     * 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 (getDomainNames() != null)
            sb.append("DomainNames: " + getDomainNames());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof DescribeDomainsRequest == false)
            return false;
        DescribeDomainsRequest other = (DescribeDomainsRequest) obj;
        if (other.getDomainNames() == null ^ this.getDomainNames() == null)
            return false;
        if (other.getDomainNames() != null
                && other.getDomainNames().equals(this.getDomainNames()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime
                * hashCode
                + ((getDomainNames() == null) ? 0 : getDomainNames().hashCode());
        return hashCode;
    }

    @Override
    public DescribeDomainsRequest clone() {
        return (DescribeDomainsRequest) super.clone();
    }
}