Package com.atlan.model.search

Class IndexSearchRequest

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.search.IndexSearchRequest
All Implemented Interfaces:
Serializable
public class IndexSearchRequest extends AtlanObject
Class from which to configure and run a search against Atlan.
See Also:

  • Constructor Details

  • Method Details

    • builder

      public static IndexSearchRequest.IndexSearchRequestBuilder<?,?> 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 IndexSearchRequest.IndexSearchRequestBuilder<?,?> 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 IndexSearchResponse 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

    • _internal

      public static IndexSearchRequest.IndexSearchRequestBuilder<?,?> _internal()

    • toBuilder

      public IndexSearchRequest.IndexSearchRequestBuilder<?,?> toBuilder()

    • getDsl

      public IndexSearchDSL getDsl()
      Parameters for the search itself.

    • getAttributes

      public List<String> getAttributes()
      Attributes to include on each result document.

    • getRelationAttributes

      public List<String> getRelationAttributes()
      Attributes to include on each related entity of each result document.

    • getSuppressLogs

      public Boolean getSuppressLogs()
      TBC

    • getShowSearchScore

      public Boolean getShowSearchScore()
      When true, include the score of each result. By default, this is false and scores are excluded.

    • getExcludeMeanings

      public Boolean getExcludeMeanings()
      Whether to include term relationships for assets (false) or not (true). By default, this is false and term relationships are therefore included.

    • getExcludeAtlanTags

      public Boolean getExcludeAtlanTags()
      Whether to include Atlan tags for assets (false) or not (true). By default, this is false and Atlan tags are therefore included.

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

    • getRequestMetadata

      public IndexSearchRequest.Metadata getRequestMetadata()
      Controls how the search is logged (if at all).

    • 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

    • getPersona

      public String getPersona()
      Qualified name of a persona through which to restrict the results of the search.

    • getPurpose

      public String getPurpose()
      Qualified name of a purpose through which to restrict the results of the search.

    • 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