Package com.atlan.model.admin

Class GroupRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.admin.GroupRequest

All Implemented Interfaces:

Serializable

public class GroupRequest
extends AtlanObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GroupRequest.GroupRequestBuilder<C extends GroupRequest,B extends GroupRequest.GroupRequestBuilder<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	GroupRequest(GroupRequest.GroupRequestBuilder<?,?> b)

Method Summary

Modifier and Type	Method	Description
static GroupRequest.GroupRequestBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
boolean	getCount()	Whether to include an overall count of groups (true) or not (false).
String	getFilter()	Criteria by which to filter the list of groups to retrieve.
int	getLimit()	Maximum number of groups to return per page.
int	getOffset()	Starting point for the list of groups when paging.
String	getSort()	Property by which to sort the resulting list of groups.
int	hashCode()
GroupResponse	list(AtlanClient client)	Search for groups using the filters specified in this request object.
GroupRequest.GroupRequestBuilder<?,?>	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

GroupRequest

protected GroupRequest(GroupRequest.GroupRequestBuilder<?,?> b)

Method Details

list

public GroupResponse list(AtlanClient client)
                   throws AtlanException

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

Parameters:

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

Returns:

the filtered groups

Throws:

AtlanException - on any issues interacting with the APIs

builder

public static GroupRequest.GroupRequestBuilder<?,?> builder()

toBuilder

public GroupRequest.GroupRequestBuilder<?,?> toBuilder()

getFilter

public String getFilter()

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

getSort

public String getSort()

Property by which to sort the resulting list of groups.

getCount

public boolean getCount()

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

getOffset

public int getOffset()

Starting point for the list of groups when paging.

getLimit

public int getLimit()

Maximum number of groups to return per page.

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