Package com.atlan.model.search

Class IndexSearchDSL

java.lang.Object
com.atlan.model.core.AtlanObject
com.atlan.model.search.IndexSearchDSL
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
WorkflowSearchRequest
public class IndexSearchDSL extends AtlanObject
See Also:

  • Field Details

  • Constructor Details

  • Method Details

    • of

      public static IndexSearchDSL of(co.elastic.clients.elasticsearch._types.query_dsl.Query query)
      Build a search using the provided query and default options.
      Parameters:
      query - to use for the search
      Returns:
      the search DSL for that query, with default options

    • builder

      public static IndexSearchDSL.IndexSearchDSLBuilder<?,?> builder(co.elastic.clients.elasticsearch._types.query_dsl.Query query)
      Build a search using the provided query and default options.
      Parameters:
      query - to use for the search
      Returns:
      a search DSL builder for that query, with default options

    • _internal

      public static IndexSearchDSL.IndexSearchDSLBuilder<?,?> _internal()

    • toBuilder

      public IndexSearchDSL.IndexSearchDSLBuilder<?,?> toBuilder()

    • getFrom

      public Integer getFrom()
      Starting point for paging. Defaults to 0 (very first result) if not overridden.

    • getSize

      public Integer getSize()
      Number of results to return per page. Defaults to 300 results per page if not overridden.

    • getTrackTotalHits

      public Boolean getTrackTotalHits()
      When true, specify the precise number of results in the response, otherwise estimate and max-out at 10,000. (Defaults to true.)

    • getAggregations

      public Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> getAggregations()
      (Optional) Aggregation to apply to the query.

    • getQuery

      public co.elastic.clients.elasticsearch._types.query_dsl.Query getQuery()
      Query to run.

    • getSort

      public List<co.elastic.clients.elasticsearch._types.SortOptions> getSort()
      (Optional) Properties by which to sort the results.

    • getPageOffsets

      public List<Object> getPageOffsets()
      (Optional) Combination of sort values after which to start the next page.

    • 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