com.amazonaws.services.identitymanagement.model.ListGroupsResult 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.identitymanagement.model;
import java.io.Serializable;
/**
 * 
 * Contains the response to a successful ListGroups request.
 * 
 */
public class ListGroupsResult implements Serializable, Cloneable {
    /**
     * 
     * A list of groups.
     * 
     */
    private com.amazonaws.internal.SdkInternalList groups;
    /**
     * 
     * A flag that indicates whether there are more items to return. If your
     * results were truncated, you can make a subsequent pagination request
     * using the Marker request parameter to retrieve more items.
     * Note that IAM might return fewer than the MaxItems number of
     * results even when there are more results available. We recommend that you
     * check IsTruncated after every call to ensure that you
     * receive all of your results.
     * 
     */
    private Boolean isTruncated;
    /**
     * 
     * When IsTruncated is true, this element is
     * present and contains the value to use for the Marker
     * parameter in a subsequent pagination request.
     * 
     */
    private String marker;
    /**
     * 
     * A list of groups.
     * 
     * 
     * @return A list of groups.
     */
    public java.util.List getGroups() {
        if (groups == null) {
            groups = new com.amazonaws.internal.SdkInternalList();
        }
        return groups;
    }
    /**
     * 
     * A list of groups.
     * 
     * 
     * @param groups
     *        A list of groups.
     */
    public void setGroups(java.util.Collection groups) {
        if (groups == null) {
            this.groups = null;
            return;
        }
        this.groups = new com.amazonaws.internal.SdkInternalList(groups);
    }
    /**
     * 
     * A list of groups.
     * 
     * 
     * NOTE: This method appends the values to the existing list (if
     * any). Use {@link #setGroups(java.util.Collection)} or
     * {@link #withGroups(java.util.Collection)} if you want to override the
     * existing values.
     * 
     * 
     * @param groups
     *        A list of groups.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsResult withGroups(Group... groups) {
        if (this.groups == null) {
            setGroups(new com.amazonaws.internal.SdkInternalList(
                    groups.length));
        }
        for (Group ele : groups) {
            this.groups.add(ele);
        }
        return this;
    }
    /**
     * 
     * A list of groups.
     * 
     * 
     * @param groups
     *        A list of groups.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsResult withGroups(java.util.Collection groups) {
        setGroups(groups);
        return this;
    }
    /**
     * 
     * A flag that indicates whether there are more items to return. If your
     * results were truncated, you can make a subsequent pagination request
     * using the Marker request parameter to retrieve more items.
     * Note that IAM might return fewer than the MaxItems number of
     * results even when there are more results available. We recommend that you
     * check IsTruncated after every call to ensure that you
     * receive all of your results.
     * 
     * 
     * @param isTruncated
     *        A flag that indicates whether there are more items to return. If
     *        your results were truncated, you can make a subsequent pagination
     *        request using the Marker request parameter to
     *        retrieve more items. Note that IAM might return fewer than the
     *        MaxItems number of results even when there are more
     *        results available. We recommend that you check
     *        IsTruncated after every call to ensure that you
     *        receive all of your results.
     */
    public void setIsTruncated(Boolean isTruncated) {
        this.isTruncated = isTruncated;
    }
    /**
     * 
     * A flag that indicates whether there are more items to return. If your
     * results were truncated, you can make a subsequent pagination request
     * using the Marker request parameter to retrieve more items.
     * Note that IAM might return fewer than the MaxItems number of
     * results even when there are more results available. We recommend that you
     * check IsTruncated after every call to ensure that you
     * receive all of your results.
     * 
     * 
     * @return A flag that indicates whether there are more items to return. If
     *         your results were truncated, you can make a subsequent pagination
     *         request using the Marker request parameter to
     *         retrieve more items. Note that IAM might return fewer than the
     *         MaxItems number of results even when there are more
     *         results available. We recommend that you check
     *         IsTruncated after every call to ensure that you
     *         receive all of your results.
     */
    public Boolean getIsTruncated() {
        return this.isTruncated;
    }
    /**
     * 
     * A flag that indicates whether there are more items to return. If your
     * results were truncated, you can make a subsequent pagination request
     * using the Marker request parameter to retrieve more items.
     * Note that IAM might return fewer than the MaxItems number of
     * results even when there are more results available. We recommend that you
     * check IsTruncated after every call to ensure that you
     * receive all of your results.
     * 
     * 
     * @param isTruncated
     *        A flag that indicates whether there are more items to return. If
     *        your results were truncated, you can make a subsequent pagination
     *        request using the Marker request parameter to
     *        retrieve more items. Note that IAM might return fewer than the
     *        MaxItems number of results even when there are more
     *        results available. We recommend that you check
     *        IsTruncated after every call to ensure that you
     *        receive all of your results.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsResult withIsTruncated(Boolean isTruncated) {
        setIsTruncated(isTruncated);
        return this;
    }
    /**
     * 
     * A flag that indicates whether there are more items to return. If your
     * results were truncated, you can make a subsequent pagination request
     * using the Marker request parameter to retrieve more items.
     * Note that IAM might return fewer than the MaxItems number of
     * results even when there are more results available. We recommend that you
     * check IsTruncated after every call to ensure that you
     * receive all of your results.
     * 
     * 
     * @return A flag that indicates whether there are more items to return. If
     *         your results were truncated, you can make a subsequent pagination
     *         request using the Marker request parameter to
     *         retrieve more items. Note that IAM might return fewer than the
     *         MaxItems number of results even when there are more
     *         results available. We recommend that you check
     *         IsTruncated after every call to ensure that you
     *         receive all of your results.
     */
    public Boolean isTruncated() {
        return this.isTruncated;
    }
    /**
     * 
     * When IsTruncated is true, this element is
     * present and contains the value to use for the Marker
     * parameter in a subsequent pagination request.
     * 
     * 
     * @param marker
     *        When IsTruncated is true, this element
     *        is present and contains the value to use for the
     *        Marker parameter in a subsequent pagination request.
     */
    public void setMarker(String marker) {
        this.marker = marker;
    }
    /**
     * 
     * When IsTruncated is true, this element is
     * present and contains the value to use for the Marker
     * parameter in a subsequent pagination request.
     * 
     * 
     * @return When IsTruncated is true, this element
     *         is present and contains the value to use for the
     *         Marker parameter in a subsequent pagination request.
     */
    public String getMarker() {
        return this.marker;
    }
    /**
     * 
     * When IsTruncated is true, this element is
     * present and contains the value to use for the Marker
     * parameter in a subsequent pagination request.
     * 
     * 
     * @param marker
     *        When IsTruncated is true, this element
     *        is present and contains the value to use for the
     *        Marker parameter in a subsequent pagination request.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsResult withMarker(String marker) {
        setMarker(marker);
        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 (getGroups() != null)
            sb.append("Groups: " + getGroups() + ",");
        if (getIsTruncated() != null)
            sb.append("IsTruncated: " + getIsTruncated() + ",");
        if (getMarker() != null)
            sb.append("Marker: " + getMarker());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof ListGroupsResult == false)
            return false;
        ListGroupsResult other = (ListGroupsResult) obj;
        if (other.getGroups() == null ^ this.getGroups() == null)
            return false;
        if (other.getGroups() != null
                && other.getGroups().equals(this.getGroups()) == false)
            return false;
        if (other.getIsTruncated() == null ^ this.getIsTruncated() == null)
            return false;
        if (other.getIsTruncated() != null
                && other.getIsTruncated().equals(this.getIsTruncated()) == false)
            return false;
        if (other.getMarker() == null ^ this.getMarker() == null)
            return false;
        if (other.getMarker() != null
                && other.getMarker().equals(this.getMarker()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getGroups() == null) ? 0 : getGroups().hashCode());
        hashCode = prime
                * hashCode
                + ((getIsTruncated() == null) ? 0 : getIsTruncated().hashCode());
        hashCode = prime * hashCode
                + ((getMarker() == null) ? 0 : getMarker().hashCode());
        return hashCode;
    }
    @Override
    public ListGroupsResult clone() {
        try {
            return (ListGroupsResult) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException(
                    "Got a CloneNotSupportedException from Object.clone() "
                            + "even though we're Cloneable!", e);
        }
    }
}