Package com.atlan.model.search

Class FluentSearch.FluentSearchBuilder<C extends FluentSearch,B extends FluentSearch.FluentSearchBuilder<C,B>>

java.lang.Object
com.atlan.model.search.CompoundQuery.CompoundQueryBuilder<C,B>
com.atlan.model.search.FluentSearch.FluentSearchBuilder<C,B>
Enclosing class:
FluentSearch
public abstract static class FluentSearch.FluentSearchBuilder<C extends FluentSearch,B extends FluentSearch.FluentSearchBuilder<C,B>> extends CompoundQuery.CompoundQueryBuilder<C,B>

  • Constructor Details

    • FluentSearchBuilder

      public FluentSearchBuilder()

  • Method Details

    • toRequestBuilder

      public IndexSearchRequest.IndexSearchRequestBuilder<?,?> toRequestBuilder()
      Translate the Atlan fluent search into an Atlan search request builder.
      Returns:
      an Atlan search request builder that encapsulates the fluent search

    • toRequest

      public IndexSearchRequest toRequest()
      Translate the Atlan fluent search into an Atlan search request.
      Returns:
      an Atlan search request that encapsulates the fluent search

    • count

      public long count() throws AtlanException
      Return the total number of assets that will match the supplied criteria, using the most minimal query possible (retrieves minimal data).
      Returns:
      the count of assets that will match the supplied criteria
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • stream

      public Stream<Asset> stream() throws AtlanException
      Run the fluent search to retrieve assets that match the supplied criteria.
      Returns:
      a stream of assets that match the specified criteria, lazily-fetched
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • stream

      public Stream<Asset> stream(boolean parallel) throws AtlanException
      Run the fluent search to retrieve assets that match the supplied criteria.
      Parameters:
      parallel - if true, returns a parallel stream
      Returns:
      a stream of assets that match the specified criteria, lazily-fetched
      Throws:
      AtlanException - on any issues interacting with the Atlan APIs

    • sort

      public B sort(co.elastic.clients.elasticsearch._types.SortOptions sort)

    • sorts

      public B sorts(Collection<? extends co.elastic.clients.elasticsearch._types.SortOptions> sorts)

    • clearSorts

      public B clearSorts()

    • aggregate

      public B aggregate(String aggregateKey, co.elastic.clients.elasticsearch._types.aggregations.Aggregation aggregateValue)

    • aggregations

      public B aggregations(Map<? extends String,? extends co.elastic.clients.elasticsearch._types.aggregations.Aggregation> aggregations)

    • clearAggregations

      public B clearAggregations()

    • pageSize

      public B pageSize(Integer pageSize)
      Number of results to retrieve per underlying API request.
      Returns:
      this.

    • includeOnResults

      public B includeOnResults(AtlanField includeOnResults)

    • includesOnResults

      public B includesOnResults(Collection<? extends AtlanField> includesOnResults)

    • clearIncludesOnResults

      public B clearIncludesOnResults()

    • _includeOnResults

      public B _includeOnResults(String _includeOnResults)

    • _includesOnResults

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

    • clear_includesOnResults

      public B clear_includesOnResults()

    • includeOnRelations

      public B includeOnRelations(AtlanField includeOnRelations)

    • includesOnRelations

      public B includesOnRelations(Collection<? extends AtlanField> includesOnRelations)

    • clearIncludesOnRelations

      public B clearIncludesOnRelations()

    • _includeOnRelations

      public B _includeOnRelations(String _includeOnRelations)

    • _includesOnRelations

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

    • clear_includesOnRelations

      public B clear_includesOnRelations()

    • includeRelationshipAttributes

      public B includeRelationshipAttributes(Boolean includeRelationshipAttributes)
      Whether to include relationship attributes on each relationship in the results.
      Returns:
      this.

    • self

      protected abstract B self()
      Specified by:
      self in class CompoundQuery.CompoundQueryBuilder<C extends FluentSearch,B extends FluentSearch.FluentSearchBuilder<C,B>>

    • build

      public abstract C build()
      Specified by:
      build in class CompoundQuery.CompoundQueryBuilder<C extends FluentSearch,B extends FluentSearch.FluentSearchBuilder<C,B>>

    • toString

      public String toString()
      Overrides:
      toString in class CompoundQuery.CompoundQueryBuilder<C extends FluentSearch,B extends FluentSearch.FluentSearchBuilder<C,B>>