com.amazonaws.services.cognitoidp.model.ListUsersResult 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;
/**
*
* The response from the request to list users.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ListUsersResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* A list of the user pool users, and their attributes, that match your query.
*
*
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user
* ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and
* the native user that you linked. You can identify IdP users in the Users object of this API response
* by the IdP prefix that Amazon Cognito appends to Username.
*
*
*/
private java.util.List users;
/**
*
* The identifier that Amazon Cognito returned with the previous request to this operation. When you include a
* pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token,
* you can paginate through the full list of items.
*
*/
private String paginationToken;
/**
*
* A list of the user pool users, and their attributes, that match your query.
*
*
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user
* ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and
* the native user that you linked. You can identify IdP users in the Users object of this API response
* by the IdP prefix that Amazon Cognito appends to Username.
*
*
*
* @return A list of the user pool users, and their attributes, that match your query.
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each
* unique user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP
* user and the native user that you linked. You can identify IdP users in the Users object of
* this API response by the IdP prefix that Amazon Cognito appends to Username.
*
*/
public java.util.List getUsers() {
return users;
}
/**
*
* A list of the user pool users, and their attributes, that match your query.
*
*
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user
* ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and
* the native user that you linked. You can identify IdP users in the Users object of this API response
* by the IdP prefix that Amazon Cognito appends to Username.
*
*
*
* @param users
* A list of the user pool users, and their attributes, that match your query.
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique
* user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP
* user and the native user that you linked. You can identify IdP users in the Users object of
* this API response by the IdP prefix that Amazon Cognito appends to Username.
*
*/
public void setUsers(java.util.Collection users) {
if (users == null) {
this.users = null;
return;
}
this.users = new java.util.ArrayList(users);
}
/**
*
* A list of the user pool users, and their attributes, that match your query.
*
*
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user
* ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and
* the native user that you linked. You can identify IdP users in the Users object of this API response
* by the IdP prefix that Amazon Cognito appends to Username.
*
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setUsers(java.util.Collection)} or {@link #withUsers(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param users
* A list of the user pool users, and their attributes, that match your query.
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique
* user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP
* user and the native user that you linked. You can identify IdP users in the Users object of
* this API response by the IdP prefix that Amazon Cognito appends to Username.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersResult withUsers(UserType... users) {
if (this.users == null) {
setUsers(new java.util.ArrayList(users.length));
}
for (UserType ele : users) {
this.users.add(ele);
}
return this;
}
/**
*
* A list of the user pool users, and their attributes, that match your query.
*
*
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique user
* ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP user and
* the native user that you linked. You can identify IdP users in the Users object of this API response
* by the IdP prefix that Amazon Cognito appends to Username.
*
*
*
* @param users
* A list of the user pool users, and their attributes, that match your query.
*
* Amazon Cognito creates a profile in your user pool for each native user in your user pool, and each unique
* user ID from your third-party identity providers (IdPs). When you link users with the AdminLinkProviderForUser API operation, the output of ListUsers displays both the IdP
* user and the native user that you linked. You can identify IdP users in the Users object of
* this API response by the IdP prefix that Amazon Cognito appends to Username.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersResult withUsers(java.util.Collection users) {
setUsers(users);
return this;
}
/**
*
* The identifier that Amazon Cognito returned with the previous request to this operation. When you include a
* pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token,
* you can paginate through the full list of items.
*
*
* @param paginationToken
* The identifier that Amazon Cognito returned with the previous request to this operation. When you include
* a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of
* this token, you can paginate through the full list of items.
*/
public void setPaginationToken(String paginationToken) {
this.paginationToken = paginationToken;
}
/**
*
* The identifier that Amazon Cognito returned with the previous request to this operation. When you include a
* pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token,
* you can paginate through the full list of items.
*
*
* @return The identifier that Amazon Cognito returned with the previous request to this operation. When you include
* a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of
* this token, you can paginate through the full list of items.
*/
public String getPaginationToken() {
return this.paginationToken;
}
/**
*
* The identifier that Amazon Cognito returned with the previous request to this operation. When you include a
* pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of this token,
* you can paginate through the full list of items.
*
*
* @param paginationToken
* The identifier that Amazon Cognito returned with the previous request to this operation. When you include
* a pagination token in your request, Amazon Cognito returns the next set of items in the list. By use of
* this token, you can paginate through the full list of items.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ListUsersResult withPaginationToken(String paginationToken) {
setPaginationToken(paginationToken);
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 (getUsers() != null)
sb.append("Users: ").append(getUsers()).append(",");
if (getPaginationToken() != null)
sb.append("PaginationToken: ").append(getPaginationToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ListUsersResult == false)
return false;
ListUsersResult other = (ListUsersResult) obj;
if (other.getUsers() == null ^ this.getUsers() == null)
return false;
if (other.getUsers() != null && other.getUsers().equals(this.getUsers()) == false)
return false;
if (other.getPaginationToken() == null ^ this.getPaginationToken() == null)
return false;
if (other.getPaginationToken() != null && other.getPaginationToken().equals(this.getPaginationToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getUsers() == null) ? 0 : getUsers().hashCode());
hashCode = prime * hashCode + ((getPaginationToken() == null) ? 0 : getPaginationToken().hashCode());
return hashCode;
}
@Override
public ListUsersResult clone() {
try {
return (ListUsersResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}