com.amazonaws.services.directory.model.DescribeSnapshotsResult 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;
/**
 * 
 * Contains the results of the DescribeSnapshots operation.
 * 
 */
public class DescribeSnapshotsResult implements Serializable, Cloneable {
    /**
     * 
     * The list of Snapshot objects that were retrieved.
     * 
     * 
     * It is possible that this list contains less than the number of items
     * specified in the Limit member of the request. This occurs if there
     * are less than the requested number of items left to retrieve, or if the
     * limitations of the operation have been exceeded.
     * 
     */
    private com.amazonaws.internal.SdkInternalList snapshots;
    /**
     * 
     * If not null, more results are available. Pass this value in the
     * NextToken member of a subsequent call to DescribeSnapshots.
     * 
     */
    private String nextToken;
    /**
     * 
     * The list of Snapshot objects that were retrieved.
     * 
     * 
     * It is possible that this list contains less than the number of items
     * specified in the Limit member of the request. This occurs if there
     * are less than the requested number of items left to retrieve, or if the
     * limitations of the operation have been exceeded.
     * 
     * 
     * @return The list of Snapshot objects that were retrieved.
     *         
     *         It is possible that this list contains less than the number of
     *         items specified in the Limit member of the request. This
     *         occurs if there are less than the requested number of items left
     *         to retrieve, or if the limitations of the operation have been
     *         exceeded.
     */
    public java.util.List getSnapshots() {
        if (snapshots == null) {
            snapshots = new com.amazonaws.internal.SdkInternalList();
        }
        return snapshots;
    }
    /**
     * 
     * The list of Snapshot objects that were retrieved.
     * 
     * 
     * It is possible that this list contains less than the number of items
     * specified in the Limit member of the request. This occurs if there
     * are less than the requested number of items left to retrieve, or if the
     * limitations of the operation have been exceeded.
     * 
     * 
     * @param snapshots
     *        The list of Snapshot objects that were retrieved.  
     *        
     *        It is possible that this list contains less than the number of
     *        items specified in the Limit member of the request. This
     *        occurs if there are less than the requested number of items left
     *        to retrieve, or if the limitations of the operation have been
     *        exceeded.
     */
    public void setSnapshots(java.util.Collection snapshots) {
        if (snapshots == null) {
            this.snapshots = null;
            return;
        }
        this.snapshots = new com.amazonaws.internal.SdkInternalList(
                snapshots);
    }
    /**
     * 
     * The list of Snapshot objects that were retrieved.
     * 
     * 
     * It is possible that this list contains less than the number of items
     * specified in the Limit member of the request. This occurs if there
     * are less than the requested number of items left to retrieve, or if the
     * limitations of the operation have been exceeded.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setSnapshots(java.util.Collection)} or
     * {@link #withSnapshots(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param snapshots
     *        The list of Snapshot objects that were retrieved.  
     *        
     *        It is possible that this list contains less than the number of
     *        items specified in the Limit member of the request. This
     *        occurs if there are less than the requested number of items left
     *        to retrieve, or if the limitations of the operation have been
     *        exceeded.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsResult withSnapshots(Snapshot... snapshots) {
        if (this.snapshots == null) {
            setSnapshots(new com.amazonaws.internal.SdkInternalList(
                    snapshots.length));
        }
        for (Snapshot ele : snapshots) {
            this.snapshots.add(ele);
        }
        return this;
    }
    /**
     * 
     * The list of Snapshot objects that were retrieved.
     * 
     * 
     * It is possible that this list contains less than the number of items
     * specified in the Limit member of the request. This occurs if there
     * are less than the requested number of items left to retrieve, or if the
     * limitations of the operation have been exceeded.
     * 
     * 
     * @param snapshots
     *        The list of Snapshot objects that were retrieved. 
     *        
     *        It is possible that this list contains less than the number of
     *        items specified in the Limit member of the request. This
     *        occurs if there are less than the requested number of items left
     *        to retrieve, or if the limitations of the operation have been
     *        exceeded.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsResult withSnapshots(
            java.util.Collection snapshots) {
        setSnapshots(snapshots);
        return this;
    }
    /**
     * 
     * If not null, more results are available. Pass this value in the
     * NextToken member of a subsequent call to DescribeSnapshots.
     * 
     * 
     * @param nextToken
     *        If not null, more results are available. Pass this value in the
     *        NextToken member of a subsequent call to
     *        DescribeSnapshots.
     */
    public void setNextToken(String nextToken) {
        this.nextToken = nextToken;
    }
    /**
     * 
     * If not null, more results are available. Pass this value in the
     * NextToken member of a subsequent call to DescribeSnapshots.
     * 
     * 
     * @return If not null, more results are available. Pass this value in the
     *         NextToken member of a subsequent call to
     *         DescribeSnapshots.
     */
    public String getNextToken() {
        return this.nextToken;
    }
    /**
     * 
     * If not null, more results are available. Pass this value in the
     * NextToken member of a subsequent call to DescribeSnapshots.
     * 
     * 
     * @param nextToken
     *        If not null, more results are available. Pass this value in the
     *        NextToken member of a subsequent call to
     *        DescribeSnapshots.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public DescribeSnapshotsResult withNextToken(String nextToken) {
        setNextToken(nextToken);
        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 (getSnapshots() != null)
            sb.append("Snapshots: " + getSnapshots() + ",");
        if (getNextToken() != null)
            sb.append("NextToken: " + getNextToken());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof DescribeSnapshotsResult == false)
            return false;
        DescribeSnapshotsResult other = (DescribeSnapshotsResult) obj;
        if (other.getSnapshots() == null ^ this.getSnapshots() == null)
            return false;
        if (other.getSnapshots() != null
                && other.getSnapshots().equals(this.getSnapshots()) == false)
            return false;
        if (other.getNextToken() == null ^ this.getNextToken() == null)
            return false;
        if (other.getNextToken() != null
                && other.getNextToken().equals(this.getNextToken()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getSnapshots() == null) ? 0 : getSnapshots().hashCode());
        hashCode = prime * hashCode
                + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
        return hashCode;
    }
    @Override
    public DescribeSnapshotsResult clone() {
        try {
            return (DescribeSnapshotsResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}