Package com.atlan.model.search

Class SearchLogRequest

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.search.SearchLogRequest

All Implemented Interfaces:

Serializable

public class SearchLogRequest
extends AtlanObject

Class from which to configure and run a search against Atlan's log of past searches. For a list of the attributes that can be searched, aggregated, sorted, etc see the static constants in SearchLogEntry.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SearchLogRequest.SearchLogRequestBuilder<?,?>	_internal()
static SearchLogRequest.SearchLogRequestBuilder<?,?>	builder(co.elastic.clients.elasticsearch._types.query_dsl.Query query)	Build a search using the provided query and default options.
static SearchLogRequest.SearchLogRequestBuilder<?,?>	builder(IndexSearchDSL dsl)	Build a search using the provided DSL and default options.
protected boolean	canEqual(Object other)
boolean	equals(Object o)
IndexSearchDSL	getDsl()	Parameters for the search itself.
String	getQueryString()	TBC
int	hashCode()
SearchLogResponse	search(AtlanClient client)	Run the search.
SearchLogRequest.SearchLogRequestBuilder<?,?>	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

SearchLogRequest

protected SearchLogRequest(SearchLogRequest.SearchLogRequestBuilder<?,?> b)

Method Details

builder

public static SearchLogRequest.SearchLogRequestBuilder<?,?> builder(co.elastic.clients.elasticsearch._types.query_dsl.Query query)

Build a search using the provided query and default options.

Parameters:

query - the query to use for the search

Returns:

the search request, with default options

builder

public static SearchLogRequest.SearchLogRequestBuilder<?,?> builder(IndexSearchDSL dsl)

Build a search using the provided DSL and default options.

Parameters:

dsl - the query details to use for the search

Returns:

the search request, with default options

search

public SearchLogResponse search(AtlanClient client)
                         throws AtlanException

Run the search.

Parameters:

client - connectivity to the Atlan tenant on which to run the search

Returns:

the matching assets

Throws:

AtlanException - on any issues interacting with the Atlan APIs

_internal

public static SearchLogRequest.SearchLogRequestBuilder<?,?> _internal()

toBuilder

public SearchLogRequest.SearchLogRequestBuilder<?,?> toBuilder()

getDsl

public IndexSearchDSL getDsl()

Parameters for the search itself.

getQueryString

public String getQueryString()

TBC

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