Package com.atlan.model.tasks

Class FluentTasks

java.lang.Object
com.atlan.model.tasks.FluentTasks
public class FluentTasks extends Object
Search abstraction mechanism, to simplify the most common searches against Atlan task queue (removing the need to understand the guts of Elastic).

  • Method Details

    • builder

      public static FluentTasks.FluentTasksBuilder builder(AtlanClient client)
      Build a fluent search against the provided Atlan tenant.
      Parameters:
      client - connectivity to an Atlan tenant
      Returns:
      the start of a fluent search against the tenant

    • toQuery

      public co.elastic.clients.elasticsearch._types.query_dsl.Query toQuery()
      Translate the Atlan compound query into an Elastic Query object.
      Returns:
      an Elastic Query object that represents the compound query

    • toRequest

      public TaskSearchRequest 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<AtlanTask> 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<AtlanTask> 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

    • _dsl

      protected IndexSearchDSL.IndexSearchDSLBuilder<?,?> _dsl()
      Translate the Atlan fluent search into an Atlan search DSL builder.
      Returns:
      an Atlan search DSL builder that encapsulates the fluent search

    • _requestBuilder

      protected TaskSearchRequest.TaskSearchRequestBuilder<?,?> _requestBuilder()
      Translate the Atlan fluent search into an Atlan search request builder.
      Returns:
      an Atlan search request builder that encapsulates the fluent search

    • _internal

      public static FluentTasks.FluentTasksBuilder _internal()