com.amazonaws.services.directory.model.DescribeSnapshotsRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-osgi Show documentation
/*
 * Copyright 2010-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.directory.model;
import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 * Contains the inputs for the DescribeSnapshots operation.
 * 
 */
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The identifier of the directory for which to retrieve snapshot
     * information.
     * 
     */
    private String directoryId;
    /**
     * 
     * A list of identifiers of the snapshots to obtain the information for. If
     * this member is null or empty, all snapshots are returned using the
     * Limit and NextToken members.
     * 
     */
    private com.amazonaws.internal.SdkInternalList snapshotIds;
    /**
     * 
     * The DescribeSnapshotsResult.NextToken value from a previous call
     * to DescribeSnapshots. Pass null if this is the first call.
     * 
     */
    private String nextToken;
    /**
     * 
     * The maximum number of objects to return.
     * 
     */
    private Integer limit;
    /**
     * 
     * The identifier of the directory for which to retrieve snapshot
     * information.
     * 
     * 
     * @param directoryId
     *        The identifier of the directory for which to retrieve snapshot
     *        information.
     */
    public void setDirectoryId(String directoryId) {
        this.directoryId = directoryId;
    }
    /**
     * 
     * The identifier of the directory for which to retrieve snapshot
     * information.
     * 
     * 
     * @return The identifier of the directory for which to retrieve snapshot
     *         information.
     */
    public String getDirectoryId() {
        return this.directoryId;
    }
    /**
     * 
     * The identifier of the directory for which to retrieve snapshot
     * information.
     * 
     * 
     * @param directoryId
     *        The identifier of the directory for which to retrieve snapshot
     *        information.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsRequest withDirectoryId(String directoryId) {
        setDirectoryId(directoryId);
        return this;
    }
    /**
     * 
     * A list of identifiers of the snapshots to obtain the information for. If
     * this member is null or empty, all snapshots are returned using the
     * Limit and NextToken members.
     * 
     * 
     * @return A list of identifiers of the snapshots to obtain the information
     *         for. If this member is null or empty, all snapshots are returned
     *         using the Limit and NextToken members.
     */
    public java.util.List getSnapshotIds() {
        if (snapshotIds == null) {
            snapshotIds = new com.amazonaws.internal.SdkInternalList();
        }
        return snapshotIds;
    }
    /**
     * 
     * A list of identifiers of the snapshots to obtain the information for. If
     * this member is null or empty, all snapshots are returned using the
     * Limit and NextToken members.
     * 
     * 
     * @param snapshotIds
     *        A list of identifiers of the snapshots to obtain the information
     *        for. If this member is null or empty, all snapshots are returned
     *        using the Limit and NextToken members.
     */
    public void setSnapshotIds(java.util.Collection snapshotIds) {
        if (snapshotIds == null) {
            this.snapshotIds = null;
            return;
        }
        this.snapshotIds = new com.amazonaws.internal.SdkInternalList(
                snapshotIds);
    }
    /**
     * 
     * A list of identifiers of the snapshots to obtain the information for. If
     * this member is null or empty, all snapshots are returned using the
     * Limit and NextToken members.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setSnapshotIds(java.util.Collection)} or
     * {@link #withSnapshotIds(java.util.Collection)} if you want to override
     * the existing values.
     * 
     * 
     * @param snapshotIds
     *        A list of identifiers of the snapshots to obtain the information
     *        for. If this member is null or empty, all snapshots are returned
     *        using the Limit and NextToken members.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds) {
        if (this.snapshotIds == null) {
            setSnapshotIds(new com.amazonaws.internal.SdkInternalList(
                    snapshotIds.length));
        }
        for (String ele : snapshotIds) {
            this.snapshotIds.add(ele);
        }
        return this;
    }
    /**
     * 
     * A list of identifiers of the snapshots to obtain the information for. If
     * this member is null or empty, all snapshots are returned using the
     * Limit and NextToken members.
     * 
     * 
     * @param snapshotIds
     *        A list of identifiers of the snapshots to obtain the information
     *        for. If this member is null or empty, all snapshots are returned
     *        using the Limit and NextToken members.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsRequest withSnapshotIds(
            java.util.Collection snapshotIds) {
        setSnapshotIds(snapshotIds);
        return this;
    }
    /**
     * 
     * The DescribeSnapshotsResult.NextToken value from a previous call
     * to DescribeSnapshots. Pass null if this is the first call.
     * 
     * 
     * @param nextToken
     *        The DescribeSnapshotsResult.NextToken value from a previous
     *        call to DescribeSnapshots. Pass null if this is the first
     *        call.
     */
    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }
    /**
     * 
     * The DescribeSnapshotsResult.NextToken value from a previous call
     * to DescribeSnapshots. Pass null if this is the first call.
     * 
     * 
     * @return The DescribeSnapshotsResult.NextToken value from a
     *         previous call to DescribeSnapshots. Pass null if this is
     *         the first call.
     */
    public String getNextToken() {
        return this.nextToken;
    }
    /**
     * 
     * The DescribeSnapshotsResult.NextToken value from a previous call
     * to DescribeSnapshots. Pass null if this is the first call.
     * 
     * 
     * @param nextToken
     *        The DescribeSnapshotsResult.NextToken value from a previous
     *        call to DescribeSnapshots. Pass null if this is the first
     *        call.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsRequest withNextToken(String nextToken) {
        setNextToken(nextToken);
        return this;
    }
    /**
     * 
     * The maximum number of objects to return.
     * 
     * 
     * @param limit
     *        The maximum number of objects to return.
     */
    public void setLimit(Integer limit) {
        this.limit = limit;
    }
    /**
     * 
     * The maximum number of objects to return.
     * 
     * 
     * @return The maximum number of objects to return.
     */
    public Integer getLimit() {
        return this.limit;
    }
    /**
     * 
     * The maximum number of objects to return.
     * 
     * 
     * @param limit
     *        The maximum number of objects to return.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsRequest withLimit(Integer limit) {
        setLimit(limit);
        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 (getDirectoryId() != null)
            sb.append("DirectoryId: " + getDirectoryId() + ",");
        if (getSnapshotIds() != null)
            sb.append("SnapshotIds: " + getSnapshotIds() + ",");
        if (getNextToken() != null)
            sb.append("NextToken: " + getNextToken() + ",");
        if (getLimit() != null)
            sb.append("Limit: " + getLimit());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof DescribeSnapshotsRequest == false)
            return false;
        DescribeSnapshotsRequest other = (DescribeSnapshotsRequest) obj;
        if (other.getDirectoryId() == null ^ this.getDirectoryId() == null)
            return false;
        if (other.getDirectoryId() != null
                && other.getDirectoryId().equals(this.getDirectoryId()) == false)
            return false;
        if (other.getSnapshotIds() == null ^ this.getSnapshotIds() == null)
            return false;
        if (other.getSnapshotIds() != null
                && other.getSnapshotIds().equals(this.getSnapshotIds()) == false)
            return false;
        if (other.getNextToken() == null ^ this.getNextToken() == null)
            return false;
        if (other.getNextToken() != null
                && other.getNextToken().equals(this.getNextToken()) == false)
            return false;
        if (other.getLimit() == null ^ this.getLimit() == null)
            return false;
        if (other.getLimit() != null
                && other.getLimit().equals(this.getLimit()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime
                * hashCode
                + ((getDirectoryId() == null) ? 0 : getDirectoryId().hashCode());
        hashCode = prime
                * hashCode
                + ((getSnapshotIds() == null) ? 0 : getSnapshotIds().hashCode());
        hashCode = prime * hashCode
                + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
        hashCode = prime * hashCode
                + ((getLimit() == null) ? 0 : getLimit().hashCode());
        return hashCode;
    }
    @Override
    public DescribeSnapshotsRequest clone() {
        return (DescribeSnapshotsRequest) super.clone();
    }
}