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

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

    • 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

      public B requestRelationshipAttrsForSearch(Boolean requestRelationshipAttrsForSearch)
      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.

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