com.amazonaws.services.cognitoidp.model.AdminListGroupsForUserRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cognitoidp Show documentation
/*
* Copyright 2019-2024 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.cognitoidp.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class AdminListGroupsForUserRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*/
private String username;
/**
*
* The user pool ID for the user pool.
*
*/
private String userPoolId;
/**
*
* The limit of the request to list groups.
*
*/
private Integer limit;
/**
*
* An identifier that was returned from the previous call to this operation, which can be used to return the next
* set of items in the list.
*
*/
private String nextToken;
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*
* @param username
* The username of the user that you want to query or modify. The value of this parameter is typically your
* user's username, but it can be any of their alias attributes. If username isn't an alias
* attribute in your user pool, this value must be the sub of a local user or the username of a
* user from a third-party IdP.
*/
public void setUsername(String username) {
this.username = username;
}
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*
* @return The username of the user that you want to query or modify. The value of this parameter is typically your
* user's username, but it can be any of their alias attributes. If username isn't an alias
* attribute in your user pool, this value must be the sub of a local user or the username of a
* user from a third-party IdP.
*/
public String getUsername() {
return this.username;
}
/**
*
* The username of the user that you want to query or modify. The value of this parameter is typically your user's
* username, but it can be any of their alias attributes. If username isn't an alias attribute in your
* user pool, this value must be the sub of a local user or the username of a user from a third-party
* IdP.
*
*
* @param username
* The username of the user that you want to query or modify. The value of this parameter is typically your
* user's username, but it can be any of their alias attributes. If username isn't an alias
* attribute in your user pool, this value must be the sub of a local user or the username of a
* user from a third-party IdP.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminListGroupsForUserRequest withUsername(String username) {
setUsername(username);
return this;
}
/**
*
* The user pool ID for the user pool.
*
*
* @param userPoolId
* The user pool ID for the user pool.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID for the user pool.
*
*
* @return The user pool ID for the user pool.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID for the user pool.
*
*
* @param userPoolId
* The user pool ID for the user pool.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminListGroupsForUserRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* The limit of the request to list groups.
*
*
* @param limit
* The limit of the request to list groups.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* The limit of the request to list groups.
*
*
* @return The limit of the request to list groups.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* The limit of the request to list groups.
*
*
* @param limit
* The limit of the request to list groups.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminListGroupsForUserRequest withLimit(Integer limit) {
setLimit(limit);
return this;
}
/**
*
* An identifier that was returned from the previous call to this operation, which can be used to return the next
* set of items in the list.
*
*
* @param nextToken
* An identifier that was returned from the previous call to this operation, which can be used to return the
* next set of items in the list.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* An identifier that was returned from the previous call to this operation, which can be used to return the next
* set of items in the list.
*
*
* @return An identifier that was returned from the previous call to this operation, which can be used to return the
* next set of items in the list.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* An identifier that was returned from the previous call to this operation, which can be used to return the next
* set of items in the list.
*
*
* @param nextToken
* An identifier that was returned from the previous call to this operation, which can be used to return the
* next set of items in the list.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public AdminListGroupsForUserRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @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: ").append("***Sensitive Data Redacted***").append(",");
if (getUserPoolId() != null)
sb.append("UserPoolId: ").append(getUserPoolId()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(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 AdminListGroupsForUserRequest == false)
return false;
AdminListGroupsForUserRequest other = (AdminListGroupsForUserRequest) obj;
if (other.getUsername() == null ^ this.getUsername() == null)
return false;
if (other.getUsername() != null && other.getUsername().equals(this.getUsername()) == false)
return false;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getLimit() == null ^ this.getLimit() == null)
return false;
if (other.getLimit() != null && other.getLimit().equals(this.getLimit()) == 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 + ((getUsername() == null) ? 0 : getUsername().hashCode());
hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public AdminListGroupsForUserRequest clone() {
return (AdminListGroupsForUserRequest) super.clone();
}
}