com.amazonaws.services.identitymanagement.model.ListGroupsForUserRequest 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
 * 
 */
public class ListGroupsForUserRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {
    /**
     * 
     * The name of the user to list groups for.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     */
    private String userName;
    /**
     * 
     * Use this parameter only when paginating results and only after you
     * receive a response indicating that the results are truncated. Set it to
     * the value of the Marker element in the response that you
     * received to indicate where the next call should start.
     * 
     */
    private String marker;
    /**
     * 
     * Use this only when paginating results to indicate the maximum number of
     * items you want in the response. If additional items exist beyond the
     * maximum you specify, the IsTruncated response element is
     * true.
     * 
     * 
     * This parameter is optional. If you do not include it, it defaults to 100.
     * Note that IAM might return fewer results, even when there are more
     * results available. In that case, the IsTruncated response
     * element returns true and Marker contains a
     * value to include in the subsequent call that tells the service where to
     * continue from.
     * 
     */
    private Integer maxItems;
    /**
     * Default constructor for ListGroupsForUserRequest object. Callers should
     * use the setter or fluent setter (with...) methods to initialize the
     * object after creating it.
     */
    public ListGroupsForUserRequest() {
    }
    /**
     * Constructs a new ListGroupsForUserRequest object. Callers should use the
     * setter or fluent setter (with...) methods to initialize any additional
     * object members.
     * 
     * @param userName
     *        The name of the user to list groups for.
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of upper
     *        and lowercase alphanumeric characters with no spaces. You can also
     *        include any of the following characters: =,.@-
     */
    public ListGroupsForUserRequest(String userName) {
        setUserName(userName);
    }
    /**
     * 
     * The name of the user to list groups for.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     * 
     * @param userName
     *        The name of the user to list groups for.
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of upper
     *        and lowercase alphanumeric characters with no spaces. You can also
     *        include any of the following characters: =,.@-
     */
    public void setUserName(String userName) {
        this.userName = userName;
    }
    /**
     * 
     * The name of the user to list groups for.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     * 
     * @return The name of the user to list groups for.
     *         
     *         The regex pattern
     *         for this parameter is a string of characters consisting of upper
     *         and lowercase alphanumeric characters with no spaces. You can
     *         also include any of the following characters: =,.@-
     */
    public String getUserName() {
        return this.userName;
    }
    /**
     * 
     * The name of the user to list groups for.
     * 
     * 
     * The regex pattern for this
     * parameter is a string of characters consisting of upper and lowercase
     * alphanumeric characters with no spaces. You can also include any of the
     * following characters: =,.@-
     * 
     * 
     * @param userName
     *        The name of the user to list groups for.
     *        
     *        The regex pattern
     *        for this parameter is a string of characters consisting of upper
     *        and lowercase alphanumeric characters with no spaces. You can also
     *        include any of the following characters: =,.@-
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsForUserRequest withUserName(String userName) {
        setUserName(userName);
        return this;
    }
    /**
     * 
     * Use this parameter only when paginating results and only after you
     * receive a response indicating that the results are truncated. Set it to
     * the value of the Marker element in the response that you
     * received to indicate where the next call should start.
     * 
     * 
     * @param marker
     *        Use this parameter only when paginating results and only after you
     *        receive a response indicating that the results are truncated. Set
     *        it to the value of the Marker element in the response
     *        that you received to indicate where the next call should start.
     */
    public void setMarker(String marker) {
        this.marker = marker;
    }
    /**
     * 
     * Use this parameter only when paginating results and only after you
     * receive a response indicating that the results are truncated. Set it to
     * the value of the Marker element in the response that you
     * received to indicate where the next call should start.
     * 
     * 
     * @return Use this parameter only when paginating results and only after
     *         you receive a response indicating that the results are truncated.
     *         Set it to the value of the Marker element in the
     *         response that you received to indicate where the next call should
     *         start.
     */
    public String getMarker() {
        return this.marker;
    }
    /**
     * 
     * Use this parameter only when paginating results and only after you
     * receive a response indicating that the results are truncated. Set it to
     * the value of the Marker element in the response that you
     * received to indicate where the next call should start.
     * 
     * 
     * @param marker
     *        Use this parameter only when paginating results and only after you
     *        receive a response indicating that the results are truncated. Set
     *        it to the value of the Marker element in the response
     *        that you received to indicate where the next call should start.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsForUserRequest withMarker(String marker) {
        setMarker(marker);
        return this;
    }
    /**
     * 
     * Use this only when paginating results to indicate the maximum number of
     * items you want in the response. If additional items exist beyond the
     * maximum you specify, the IsTruncated response element is
     * true.
     * 
     * 
     * This parameter is optional. If you do not include it, it defaults to 100.
     * Note that IAM might return fewer results, even when there are more
     * results available. In that case, the IsTruncated response
     * element returns true and Marker contains a
     * value to include in the subsequent call that tells the service where to
     * continue from.
     * 
     * 
     * @param maxItems
     *        Use this only when paginating results to indicate the maximum
     *        number of items you want in the response. If additional items
     *        exist beyond the maximum you specify, the IsTruncated
     *        response element is true.
     *        
     *        This parameter is optional. If you do not include it, it defaults
     *        to 100. Note that IAM might return fewer results, even when there
     *        are more results available. In that case, the
     *        IsTruncated response element returns
     *        true and Marker contains a value to
     *        include in the subsequent call that tells the service where to
     *        continue from.
     */
    public void setMaxItems(Integer maxItems) {
        this.maxItems = maxItems;
    }
    /**
     * 
     * Use this only when paginating results to indicate the maximum number of
     * items you want in the response. If additional items exist beyond the
     * maximum you specify, the IsTruncated response element is
     * true.
     * 
     * 
     * This parameter is optional. If you do not include it, it defaults to 100.
     * Note that IAM might return fewer results, even when there are more
     * results available. In that case, the IsTruncated response
     * element returns true and Marker contains a
     * value to include in the subsequent call that tells the service where to
     * continue from.
     * 
     * 
     * @return Use this only when paginating results to indicate the maximum
     *         number of items you want in the response. If additional items
     *         exist beyond the maximum you specify, the
     *         IsTruncated response element is true
     *         .
     *         
     *         This parameter is optional. If you do not include it, it defaults
     *         to 100. Note that IAM might return fewer results, even when there
     *         are more results available. In that case, the
     *         IsTruncated response element returns
     *         true and Marker contains a value to
     *         include in the subsequent call that tells the service where to
     *         continue from.
     */
    public Integer getMaxItems() {
        return this.maxItems;
    }
    /**
     * 
     * Use this only when paginating results to indicate the maximum number of
     * items you want in the response. If additional items exist beyond the
     * maximum you specify, the IsTruncated response element is
     * true.
     * 
     * 
     * This parameter is optional. If you do not include it, it defaults to 100.
     * Note that IAM might return fewer results, even when there are more
     * results available. In that case, the IsTruncated response
     * element returns true and Marker contains a
     * value to include in the subsequent call that tells the service where to
     * continue from.
     * 
     * 
     * @param maxItems
     *        Use this only when paginating results to indicate the maximum
     *        number of items you want in the response. If additional items
     *        exist beyond the maximum you specify, the IsTruncated
     *        response element is true.
     *        
     *        This parameter is optional. If you do not include it, it defaults
     *        to 100. Note that IAM might return fewer results, even when there
     *        are more results available. In that case, the
     *        IsTruncated response element returns
     *        true and Marker contains a value to
     *        include in the subsequent call that tells the service where to
     *        continue from.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public ListGroupsForUserRequest withMaxItems(Integer maxItems) {
        setMaxItems(maxItems);
        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 (getUserName() != null)
            sb.append("UserName: " + getUserName() + ",");
        if (getMarker() != null)
            sb.append("Marker: " + getMarker() + ",");
        if (getMaxItems() != null)
            sb.append("MaxItems: " + getMaxItems());
        sb.append("}");
        return sb.toString();
    }
    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;
        if (obj instanceof ListGroupsForUserRequest == false)
            return false;
        ListGroupsForUserRequest other = (ListGroupsForUserRequest) obj;
        if (other.getUserName() == null ^ this.getUserName() == null)
            return false;
        if (other.getUserName() != null
                && other.getUserName().equals(this.getUserName()) == false)
            return false;
        if (other.getMarker() == null ^ this.getMarker() == null)
            return false;
        if (other.getMarker() != null
                && other.getMarker().equals(this.getMarker()) == false)
            return false;
        if (other.getMaxItems() == null ^ this.getMaxItems() == null)
            return false;
        if (other.getMaxItems() != null
                && other.getMaxItems().equals(this.getMaxItems()) == false)
            return false;
        return true;
    }
    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;
        hashCode = prime * hashCode
                + ((getUserName() == null) ? 0 : getUserName().hashCode());
        hashCode = prime * hashCode
                + ((getMarker() == null) ? 0 : getMarker().hashCode());
        hashCode = prime * hashCode
                + ((getMaxItems() == null) ? 0 : getMaxItems().hashCode());
        return hashCode;
    }
    @Override
    public ListGroupsForUserRequest clone() {
        return (ListGroupsForUserRequest) super.clone();
    }
}