Package com.atlan.model.admin

Class GroupResponse

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.net.ApiResource

com.atlan.model.admin.GroupResponse

All Implemented Interfaces:

AtlanResponseInterface, Serializable, Iterable<AtlanGroup>

public class GroupResponse
extends ApiResource
implements Iterable<AtlanGroup>

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.atlan.net.ApiResource

ApiResource.RequestMethod

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.net.ApiResource

CHARSET

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

rawJsonObject

Constructor Summary

Constructors

Constructor	Description
GroupResponse()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
AtlanClient	getClient()	Connectivity to the Atlan tenant where the search was run.
Integer	getFilterRecord()	Filtered number of groups.
GroupResponse	getNextPage()	Retrieve the next page of results from this response.
List<AtlanGroup>	getRecords()	Details about each group in this page of the response.
GroupRequest	getRequest()	Request that produced this response.
Integer	getTotalRecord()	Total number of groups.
int	hashCode()
Iterator<AtlanGroup>	iterator()
void	setClient(AtlanClient client)	Connectivity to the Atlan tenant where the search was run.
void	setRequest(GroupRequest request)	Request that produced this response.
Stream<AtlanGroup>	stream()	Stream the results (lazily) for processing without needing to manually manage paging.
String	toString()

Methods inherited from class com.atlan.net.ApiResource

checkNullTypedParams, createQueryString, createQueryString, getLastResponse, getRawJsonObject, injectTraceId, request, request, request, request, request, request, request, requestPlainText, requestPlainText, setLastResponse, urlEncode, urlEncodeId

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

setRawJsonObject, toJson

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Details

GroupResponse

public GroupResponse()

Method Details

getNextPage

public GroupResponse getNextPage()
                          throws AtlanException

Retrieve the next page of results from this response.

Returns:

next page of results from this response

Throws:

AtlanException - on any API interaction problem

iterator

public Iterator<AtlanGroup> iterator()

Specified by:

iterator in interface Iterable<AtlanGroup>

stream

public Stream<AtlanGroup> stream()

Stream the results (lazily) for processing without needing to manually manage paging.

Returns:

a lazily-loaded stream of results from the search

getClient

public AtlanClient getClient()

Connectivity to the Atlan tenant where the search was run.

getRequest

public GroupRequest getRequest()

Request that produced this response.

getTotalRecord

public Integer getTotalRecord()

Total number of groups.

getFilterRecord

public Integer getFilterRecord()

Filtered number of groups.

getRecords

public List<AtlanGroup> getRecords()

Details about each group in this page of 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 ApiResource

setClient

public void setClient(AtlanClient client)

Connectivity to the Atlan tenant where the search was run.

setRequest

public void setRequest(GroupRequest request)

Request that produced this response.