com.amazonaws.services.cognitoidp.model.ListUsersRequest Maven / Gradle / Ivy
/*
* Copyright 2016-2021 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;
/**
*
* Represents the request to list users.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The user pool ID for the user pool on which the search should be performed.
*
*/
private String userPoolId;
/**
*
* An array of strings, where each string is the name of a user attribute to be returned for each user in the search
* results. If the array is null, all attributes are returned.
*
*/
private java.util.List attributesToGet;
/**
*
* Maximum number of users to be returned.
*
*/
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 paginationToken;
/**
*
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
* within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
* ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*
*/
private String filter;
/**
*
* The user pool ID for the user pool on which the search should be performed.
*
*
* @param userPoolId
* The user pool ID for the user pool on which the search should be performed.
*/
public void setUserPoolId(String userPoolId) {
this.userPoolId = userPoolId;
}
/**
*
* The user pool ID for the user pool on which the search should be performed.
*
*
* @return The user pool ID for the user pool on which the search should be performed.
*/
public String getUserPoolId() {
return this.userPoolId;
}
/**
*
* The user pool ID for the user pool on which the search should be performed.
*
*
* @param userPoolId
* The user pool ID for the user pool on which the search should be performed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersRequest withUserPoolId(String userPoolId) {
setUserPoolId(userPoolId);
return this;
}
/**
*
* An array of strings, where each string is the name of a user attribute to be returned for each user in the search
* results. If the array is null, all attributes are returned.
*
*
* @return An array of strings, where each string is the name of a user attribute to be returned for each user in
* the search results. If the array is null, all attributes are returned.
*/
public java.util.List getAttributesToGet() {
return attributesToGet;
}
/**
*
* An array of strings, where each string is the name of a user attribute to be returned for each user in the search
* results. If the array is null, all attributes are returned.
*
*
* @param attributesToGet
* An array of strings, where each string is the name of a user attribute to be returned for each user in the
* search results. If the array is null, all attributes are returned.
*/
public void setAttributesToGet(java.util.Collection attributesToGet) {
if (attributesToGet == null) {
this.attributesToGet = null;
return;
}
this.attributesToGet = new java.util.ArrayList(attributesToGet);
}
/**
*
* An array of strings, where each string is the name of a user attribute to be returned for each user in the search
* results. If the array is null, all attributes are returned.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAttributesToGet(java.util.Collection)} or {@link #withAttributesToGet(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param attributesToGet
* An array of strings, where each string is the name of a user attribute to be returned for each user in the
* search results. If the array is null, all attributes are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersRequest withAttributesToGet(String... attributesToGet) {
if (this.attributesToGet == null) {
setAttributesToGet(new java.util.ArrayList(attributesToGet.length));
}
for (String ele : attributesToGet) {
this.attributesToGet.add(ele);
}
return this;
}
/**
*
* An array of strings, where each string is the name of a user attribute to be returned for each user in the search
* results. If the array is null, all attributes are returned.
*
*
* @param attributesToGet
* An array of strings, where each string is the name of a user attribute to be returned for each user in the
* search results. If the array is null, all attributes are returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersRequest withAttributesToGet(java.util.Collection attributesToGet) {
setAttributesToGet(attributesToGet);
return this;
}
/**
*
* Maximum number of users to be returned.
*
*
* @param limit
* Maximum number of users to be returned.
*/
public void setLimit(Integer limit) {
this.limit = limit;
}
/**
*
* Maximum number of users to be returned.
*
*
* @return Maximum number of users to be returned.
*/
public Integer getLimit() {
return this.limit;
}
/**
*
* Maximum number of users to be returned.
*
*
* @param limit
* Maximum number of users to be returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersRequest 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 paginationToken
* 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 setPaginationToken(String paginationToken) {
this.paginationToken = paginationToken;
}
/**
*
* 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 getPaginationToken() {
return this.paginationToken;
}
/**
*
* 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 paginationToken
* 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 ListUsersRequest withPaginationToken(String paginationToken) {
setPaginationToken(paginationToken);
return this;
}
/**
*
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
* within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
* ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*
*
* @param filter
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation
* marks within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a
* time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a
* prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*/
public void setFilter(String filter) {
this.filter = filter;
}
/**
*
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
* within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
* ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*
*
* @return A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation
* marks within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a
* time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a
* prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*/
public String getFilter() {
return this.filter;
}
/**
*
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation marks
* within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a prefix
* ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
*
*
* @param filter
* A filter string of the form "AttributeName Filter-Type "AttributeValue"". Quotation
* marks within the filter string must be escaped using the backslash (\) character. For example, "
* family_name = \"Reddy\"".
*
* -
*
* AttributeName: The name of the attribute to search for. You can only search for one attribute at a
* time.
*
*
* -
*
* Filter-Type: For an exact match, use =, for example, "given_name = \"Jon\"". For a
* prefix ("starts with") match, use ^=, for example, "given_name ^= \"Jon\"".
*
*
* -
*
* AttributeValue: The attribute value that must be matched for each user.
*
*
*
*
* If the filter string is empty, ListUsers returns all users in the user pool.
*
*
* You can only search for the following standard attributes:
*
*
* -
*
* username (case-sensitive)
*
*
* -
*
* email
*
*
* -
*
* phone_number
*
*
* -
*
* name
*
*
* -
*
* given_name
*
*
* -
*
* family_name
*
*
* -
*
* preferred_username
*
*
* -
*
* cognito:user_status (called Status in the Console) (case-insensitive)
*
*
* -
*
* status (called Enabled in the Console) (case-sensitive)
*
*
* -
*
* sub
*
*
*
*
* Custom attributes are not searchable.
*
*
* For more information, see Searching for Users Using the ListUsers API and Examples of Using the ListUsers API in the Amazon Cognito Developer Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersRequest withFilter(String filter) {
setFilter(filter);
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 (getUserPoolId() != null)
sb.append("UserPoolId: ").append(getUserPoolId()).append(",");
if (getAttributesToGet() != null)
sb.append("AttributesToGet: ").append(getAttributesToGet()).append(",");
if (getLimit() != null)
sb.append("Limit: ").append(getLimit()).append(",");
if (getPaginationToken() != null)
sb.append("PaginationToken: ").append(getPaginationToken()).append(",");
if (getFilter() != null)
sb.append("Filter: ").append(getFilter());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListUsersRequest == false)
return false;
ListUsersRequest other = (ListUsersRequest) obj;
if (other.getUserPoolId() == null ^ this.getUserPoolId() == null)
return false;
if (other.getUserPoolId() != null && other.getUserPoolId().equals(this.getUserPoolId()) == false)
return false;
if (other.getAttributesToGet() == null ^ this.getAttributesToGet() == null)
return false;
if (other.getAttributesToGet() != null && other.getAttributesToGet().equals(this.getAttributesToGet()) == 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.getPaginationToken() == null ^ this.getPaginationToken() == null)
return false;
if (other.getPaginationToken() != null && other.getPaginationToken().equals(this.getPaginationToken()) == false)
return false;
if (other.getFilter() == null ^ this.getFilter() == null)
return false;
if (other.getFilter() != null && other.getFilter().equals(this.getFilter()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUserPoolId() == null) ? 0 : getUserPoolId().hashCode());
hashCode = prime * hashCode + ((getAttributesToGet() == null) ? 0 : getAttributesToGet().hashCode());
hashCode = prime * hashCode + ((getLimit() == null) ? 0 : getLimit().hashCode());
hashCode = prime * hashCode + ((getPaginationToken() == null) ? 0 : getPaginationToken().hashCode());
hashCode = prime * hashCode + ((getFilter() == null) ? 0 : getFilter().hashCode());
return hashCode;
}
@Override
public ListUsersRequest clone() {
return (ListUsersRequest) super.clone();
}
}