Package com.atlan.model.admin

Class UserRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.admin.UserRequest

All Implemented Interfaces:

Serializable

public class UserRequest
extends AtlanObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UserRequest.UserRequestBuilder<C extends UserRequest,B extends UserRequest.UserRequestBuilder<C,B>>

Nested classes/interfaces inherited from class com.atlan.model.core.AtlanObject

AtlanObject.AtlanObjectBuilder<C extends AtlanObject,B extends AtlanObject.AtlanObjectBuilder<C,B>>

Field Summary

Fields inherited from class com.atlan.model.core.AtlanObject

rawJsonObject

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserRequest(UserRequest.UserRequestBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static UserRequest.UserRequestBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
List<String>	getColumns()	List of columns to be returned about each user in the response.
boolean	getCount()	Whether to include an overall count of users (true) or not (false).
String	getFilter()	Criteria by which to filter the list of users to retrieve.
int	getLimit()	Maximum number of users to return per page.
int	getMaxLoginEvents()	TBC
int	getOffset()	Starting point for the list of users when paging.
String	getSort()	Property by which to sort the resulting list of users.
int	hashCode()
UserResponse	list(AtlanClient client)	Search for users using the filters specified in this request object.
UserRequest.UserRequestBuilder<?,?>	toBuilder()
String	toString()

Methods inherited from class com.atlan.model.core.AtlanObject

getRawJsonObject, setRawJsonObject, toJson

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

UserRequest

protected UserRequest(UserRequest.UserRequestBuilder<?,?> b)

Method Details

list

public UserResponse list(AtlanClient client)
                  throws AtlanException

Search for users using the filters specified in this request object.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the users

Returns:

the filtered users

Throws:

AtlanException - on any issues interacting with the APIs

builder

public static UserRequest.UserRequestBuilder<?,?> builder()

toBuilder

public UserRequest.UserRequestBuilder<?,?> toBuilder()

getMaxLoginEvents

public int getMaxLoginEvents()

TBC

getFilter

public String getFilter()

Criteria by which to filter the list of users to retrieve.

getSort

public String getSort()

Property by which to sort the resulting list of users.

getCount

public boolean getCount()

Whether to include an overall count of users (true) or not (false).

getOffset

public int getOffset()

Starting point for the list of users when paging.

getLimit

public int getLimit()

Maximum number of users to return per page.

getColumns

public List<String> getColumns()

List of columns to be returned about each user in the response.

equals

public boolean equals(Object o)

Overrides:

equals in class AtlanObject

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class AtlanObject

hashCode

public int hashCode()

Overrides:

hashCode in class AtlanObject

toString

public String toString()

Description copied from class: AtlanObject

Overrides:

toString in class AtlanObject