Package com.atlan.model.search

Class IndexSearchRequest.IndexSearchRequestBuilder<C extends IndexSearchRequest,B extends IndexSearchRequest.IndexSearchRequestBuilder<C,B>>

java.lang.Object
com.atlan.model.core.AtlanObject.AtlanObjectBuilder<C,B>
com.atlan.model.search.IndexSearchRequest.IndexSearchRequestBuilder<C,B>
Enclosing class:
IndexSearchRequest
public abstract static class IndexSearchRequest.IndexSearchRequestBuilder<C extends IndexSearchRequest,B extends IndexSearchRequest.IndexSearchRequestBuilder<C,B>> extends AtlanObject.AtlanObjectBuilder<C,B>

  • Constructor Details

    • IndexSearchRequestBuilder

      public IndexSearchRequestBuilder()

  • Method Details

    • applySearchParameters

      public B applySearchParameters(SearchParameters searchParameters)
      Apply the provided search parameters to this index search request.
      Parameters:
      searchParameters - to apply
      Returns:
      this index search request with the provided search parameters applied

    • $fillValuesFrom

      protected B $fillValuesFrom(C instance)
      Overrides:
      $fillValuesFrom in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchRequest,B extends IndexSearchRequest.IndexSearchRequestBuilder<C,B>>

    • dsl

      public B dsl(IndexSearchDSL dsl)
      Parameters for the search itself.
      Returns:
      this.

    • attribute

      public B attribute(String attribute)

    • attributes

      public B attributes(Collection<? extends String> attributes)

    • clearAttributes

      public B clearAttributes()

    • relationAttribute

      public B relationAttribute(String relationAttribute)

    • relationAttributes

      public B relationAttributes(Collection<? extends String> relationAttributes)

    • clearRelationAttributes

      public B clearRelationAttributes()

    • suppressLogs

      public B suppressLogs(Boolean suppressLogs)
      TBC
      Returns:
      this.

    • showSearchScore

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

    • excludeMeanings

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

    • excludeAtlanTags

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

    • includeAtlanTagNames

      public B includeAtlanTagNames(Boolean includeAtlanTagNames)
      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.
      Returns:
      this.

    • enableFullRestriction

      public B enableFullRestriction(Boolean enableFullRestriction)
      Whether to fully restrict results of the search based on the policies of the requestor.
      Returns:
      this.

    • accessControlExclusive

      public B accessControlExclusive(Boolean accessControlExclusive)
      TBC
      Returns:
      this.

    • allowDeletedRelations

      public B allowDeletedRelations(Boolean allowDeletedRelations)
      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.
      Returns:
      this.

    • requestRelationshipAttrsForSearch

      @Deprecated public B requestRelationshipAttrsForSearch(Boolean requestRelationshipAttrsForSearch)
      Deprecated.
      see includeRelationshipAttributes(java.lang.Boolean) 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.
      Returns:
      this.

    • includeRelationshipAttributes

      public B includeRelationshipAttributes(Boolean includeRelationshipAttributes)
      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.
      Returns:
      this.

    • requestMetadata

      public B requestMetadata(IndexSearchRequest.Metadata requestMetadata)
      Controls how the search is logged (if at all).
      Returns:
      this.

    • showSearchMetadata

      public B showSearchMetadata(Boolean showSearchMetadata)
      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).
      Returns:
      this.

    • showHighlights

      public B showHighlights(Boolean showHighlights)
      TBC
      Returns:
      this.

    • persona

      public B persona(String persona)
      Qualified name of a persona through which to restrict the results of the search.
      Returns:
      this.

    • purpose

      public B purpose(String purpose)
      Qualified name of a purpose through which to restrict the results of the search.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchRequest,B extends IndexSearchRequest.IndexSearchRequestBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchRequest,B extends IndexSearchRequest.IndexSearchRequestBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class AtlanObject.AtlanObjectBuilder<C extends IndexSearchRequest,B extends IndexSearchRequest.IndexSearchRequestBuilder<C,B>>