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:

  • 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).

    • getIncludeAtlanTagNames

      public Boolean getIncludeAtlanTagNames()
      Whether to include Atlan tag names for assets (true) or not (false). By default, this is true and Atlan tag names are therefore included. Note that this can be set to true even when excludeAtlanTags is set to false.

    • getEnableFullRestriction

      public Boolean getEnableFullRestriction()
      Whether to fully restrict results of the search based on the policies of the requestor.

    • getAccessControlExclusive

      public Boolean getAccessControlExclusive()
      TBC

    • getAllowDeletedRelations

      public Boolean getAllowDeletedRelations()
      Whether to include deleted relationships to this asset (true) or not (false). By default, this is false and therefore only active (not deleted) relationships will be included.

    • getRequestRelationshipAttrsForSearch

      @Deprecated public Boolean getRequestRelationshipAttrsForSearch()
      Deprecated.
      see includeRelationshipAttributes instead
      Whether to include relationship-level attributes for any relationships to each asset (true) or not (false). By default, this is false and therefore relationship-level attributes are not included.

    • getIncludeRelationshipAttributes

      public Boolean getIncludeRelationshipAttributes()
      Whether to include relationship-level attributes for any relationships to each asset (true) or not (false). By default, this is false and therefore relationship-level attributes are not included.

    • getShowSearchMetadata

      public Boolean getShowSearchMetadata()
      Whether to include lower-level search metadata in results (true) or not (false). This must be true in order to use extensive paging (beyond built-in thresholds).

    • getShowHighlights

      public Boolean getShowHighlights()
      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