Package com.atlan.model.search

Class SearchParameters

java.lang.Object

com.atlan.model.core.AtlanObject

com.atlan.model.search.SearchParameters

All Implemented Interfaces:

Serializable

public class SearchParameters
extends AtlanObject

Set of search parameters that are returned as part of the response of a search against Atlan.

See Also:

• Serialized Form

Nested Class Summary

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

Constructor	Description
SearchParameters()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Boolean	getAllowDeletedRelations()	TBC
List<String>	getAttributes()	List of attributes that were requested in the search.
Boolean	getExcludeAtlanTags()	Whether the Atlan tags of assets are excluded from the results (true) or not (false).
Boolean	getExcludeMeanings()	Whether the term relationships for assets are excluded from the results (true) or not (false).
String	getQuery()	Query that was run to produce these search results.
List<String>	getRelationAttributes()	List of attributes that were requested to be included on each relationship found in the search.
Boolean	getShowSearchScore()	Whether to show the score associated with a result (true) or not (false).
Boolean	getSuppressLogs()	TBC
int	hashCode()
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

SearchParameters

public SearchParameters()

Method Details

getAttributes

public List<String> getAttributes()

List of attributes that were requested in the search.

getRelationAttributes

public List<String> getRelationAttributes()

List of attributes that were requested to be included on each relationship found in the search.

getShowSearchScore

public Boolean getShowSearchScore()

Whether to show the score associated with a result (true) or not (false).

getSuppressLogs

public Boolean getSuppressLogs()

TBC

getExcludeMeanings

public Boolean getExcludeMeanings()

Whether the term relationships for assets are excluded from the results (true) or not (false).

getExcludeAtlanTags

public Boolean getExcludeAtlanTags()

Whether the Atlan tags of assets are excluded from the results (true) or not (false).

getAllowDeletedRelations

public Boolean getAllowDeletedRelations()

TBC

getQuery

public String getQuery()

Query that was run to produce these search results. Note that this is in string form, rather than a JSON object, but is equivalent content to IndexSearchDSL.

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