Package com.atlan.model.admin

Class AdminEventRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.admin.AdminEventRequest

All Implemented Interfaces:

Serializable

public class AdminEventRequest
extends AtlanObject

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AdminEventRequest.AdminEventRequestBuilder<?,?>	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getClientId()	Unique identifier (GUID) of the client that carried out the operation.
String	getDateFrom()	Earliest date from which to include events (format: yyyy-MM-dd).
String	getDateTo()	Latest date up to which to include events (format: yyyy-MM-dd).
String	getIpAddress()	IP address from which the operation was carried out.
int	getOffset()	Starting point for the events (for paging).
List<AdminOperationType>	getOperationTypes()	Include events only with the supplied types of operations.
String	getRealmId()	Unique name of the realm from which the operation was carried out.
String	getResourcePath()	Include events only against the supplied resource.
List<AdminResourceType>	getResourceTypes()	Include events only against the supplied types of resources.
int	getSize()	Maximum number of events to retrieve (per page).
String	getUserId()	Unique identifier (GUID) of the user who carried out the operation.
int	hashCode()
AdminEventResponse	search(AtlanClient client)	Search for admin events using the filters specified in this request object.
AdminEventRequest.AdminEventRequestBuilder<?,?>	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

AdminEventRequest

protected AdminEventRequest(AdminEventRequest.AdminEventRequestBuilder<?,?> b)

Method Details

search

public AdminEventResponse search(AtlanClient client)
                          throws AtlanException

Search for admin events using the filters specified in this request object.

Parameters:

client - connectivity to the Atlan tenant from which to retrieve the admin events

Returns:

the filtered admin events

Throws:

AtlanException - on any issues interacting with the APIs

builder

public static AdminEventRequest.AdminEventRequestBuilder<?,?> builder()

toBuilder

public AdminEventRequest.AdminEventRequestBuilder<?,?> toBuilder()

getClientId

public String getClientId()

Unique identifier (GUID) of the client that carried out the operation.

getIpAddress

public String getIpAddress()

IP address from which the operation was carried out.

getRealmId

public String getRealmId()

Unique name of the realm from which the operation was carried out.

getUserId

public String getUserId()

Unique identifier (GUID) of the user who carried out the operation.

getDateFrom

public String getDateFrom()

Earliest date from which to include events (format: yyyy-MM-dd).

getDateTo

public String getDateTo()

Latest date up to which to include events (format: yyyy-MM-dd).

getOffset

public int getOffset()

Starting point for the events (for paging).

getSize

public int getSize()

Maximum number of events to retrieve (per page).

getOperationTypes

public List<AdminOperationType> getOperationTypes()

Include events only with the supplied types of operations.

getResourcePath

public String getResourcePath()

Include events only against the supplied resource.

getResourceTypes

public List<AdminResourceType> getResourceTypes()

Include events only against the supplied types of resources.

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