Package com.atlan.model.fields

Interface ISearchable

All Known Implementing Classes:
BooleanField, CustomMetadataField, InternalKeywordField, InternalKeywordTextField, InternalNumericField, KeywordField, KeywordTextField, KeywordTextStemmedField, NumericField, NumericRankField, SearchableField, TextField
public interface ISearchable

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    EMBEDDED_SOURCE_VALUE
     

  • Method Summary

    Modifier and Type
    Method
    Description
    default co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy()
    Return criteria to bucket results based on the field.
    default co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(int size)
    Return criteria to bucket results based on the field.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(int size, boolean includeSourceValue)
    Return criteria to bucket results based on the provided field.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(int size, Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> nested, List<co.elastic.clients.util.NamedValue<co.elastic.clients.elasticsearch._types.SortOrder>> order)
    Return criteria to bucket results based on the provided field.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(String field)
    Return criteria to bucket results based on the provided field.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(String field, int size)
    Return criteria to bucket results based on the provided field.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(String field, int size, String sourceAttribute)
    Return criteria to bucket results based on the provided field.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    bucketBy(String field, int size, Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> nested, List<co.elastic.clients.util.NamedValue<co.elastic.clients.elasticsearch._types.SortOrder>> order)
    Return criteria to bucket results based on the provided field, including nested aggregations and (optionally) sorting the top-level buckets by one of the nested aggregation's results.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    count()
    Return criteria to calculate the number of values in the field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    count(String field)
    Return criteria to calculate the number of values in a field across all results.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    distinct()
    Returns criteria to calculate the approximate number of distinct values in the field across all results.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    distinct(int precision)
    Returns criteria to calculate the approximate number of distinct values in the field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    distinct(String field)
    Returns criteria to calculate the approximate number of distinct values in a field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    distinct(String field, int precision)
    Returns criteria to calculate the approximate number of distinct values in a field across all results.
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    hasAnyValue()
    Returns a query that will only match assets that have some non-null, non-empty value (no matter what actual value) for the field.
    static co.elastic.clients.elasticsearch._types.query_dsl.Query
    hasAnyValue(String field)
    Returns a query that will only match assets that have some non-null, non-empty value (no matter what actual value) for the field.
    co.elastic.clients.elasticsearch._types.SortOptions
    order(co.elastic.clients.elasticsearch._types.SortOrder order)
    Return a condition to sort results by the field, in the order specified.
    static co.elastic.clients.elasticsearch._types.SortOptions
    order(String field, co.elastic.clients.elasticsearch._types.SortOrder order)
    Return a condition to sort results by the provided field, in the specified order.

  • Field Details

  • Method Details

    • hasAnyValue

      co.elastic.clients.elasticsearch._types.query_dsl.Query hasAnyValue()
      Returns a query that will only match assets that have some non-null, non-empty value (no matter what actual value) for the field.
      Returns:
      a query that will only match assets that have some non-null, non-empty value (no matter what actual value) for the field

    • hasAnyValue

      static co.elastic.clients.elasticsearch._types.query_dsl.Query hasAnyValue(String field)
      Returns a query that will only match assets that have some non-null, non-empty value (no matter what actual value) for the field.
      Parameters:
      field - name of the field to search
      Returns:
      a query that will only match assets that have some non-null, non-empty value (no matter what actual value) for the field

    • distinct

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation distinct()
      Returns criteria to calculate the approximate number of distinct values in the field across all results. Note that this de-duplicates values, but is an approximation.
      Returns:
      criteria to calculate the approximate number of distinct values in a field across the results

    • distinct

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation distinct(String field)
      Returns criteria to calculate the approximate number of distinct values in a field across all results. Note that this de-duplicates values, but is an approximation.
      Parameters:
      field - for which to count distinct values
      Returns:
      criteria to calculate the approximate number of distinct values in a field across the results

    • distinct

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation distinct(int precision)
      Returns criteria to calculate the approximate number of distinct values in the field across all results. Note that this de-duplicates values, but is an approximation.
      Parameters:
      precision - threshold for precision of the count
      Returns:
      criteria to calculate the approximate number of distinct values in a field across the results

    • distinct

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation distinct(String field, int precision)
      Returns criteria to calculate the approximate number of distinct values in a field across all results. Note that this de-duplicates values, but is an approximation.
      Parameters:
      field - for which to count distinct values
      precision - threshold for precision of the count
      Returns:
      criteria to calculate the approximate number of distinct values in a field across the results

    • count

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation count()
      Return criteria to calculate the number of values in the field across all results. Note that this does not de-duplicate.
      Returns:
      criteria to calculate the number of values in the provided field across the results

    • count

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation count(String field)
      Return criteria to calculate the number of values in a field across all results. Note that this does not de-duplicate.
      Parameters:
      field - for which to count values
      Returns:
      criteria to calculate the number of values in the provided field across the results

    • bucketBy

      default co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy()
      Return criteria to bucket results based on the field. Note: this will only return details for the top 10 buckets with the most results in them.
      Returns:
      criteria to bucket results by the provided field

    • bucketBy

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(String field)
      Return criteria to bucket results based on the provided field. Note: this will only return details for the top 10 buckets with the most results in them.
      Parameters:
      field - by which to bucket the results
      Returns:
      criteria to bucket results by the provided field

    • bucketBy

      default co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(int size)
      Return criteria to bucket results based on the field.
      Parameters:
      size - the number of buckets to include results across.
      Returns:
      criteria to bucket results by the provided field, across a maximum number of buckets defined by the provided size

    • bucketBy

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(String field, int size)
      Return criteria to bucket results based on the provided field.
      Parameters:
      field - by which to bucket the results
      size - the number of buckets to include results across.
      Returns:
      criteria to bucket results by the provided field, across a maximum number of buckets defined by the provided size

    • bucketBy

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(int size, boolean includeSourceValue)
      Return criteria to bucket results based on the provided field.
      Parameters:
      size - the number of buckets to include results across.
      includeSourceValue - if true, include the actual source value of this attribute for each bucket will be included in the result
      Returns:
      criteria to bucket results by the provided field, across a maximum number of buckets defined by the provided size

    • bucketBy

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(String field, int size, String sourceAttribute)
      Return criteria to bucket results based on the provided field.
      Parameters:
      field - by which to bucket the results
      size - the number of buckets to include results across
      sourceAttribute - if non-null, the actual source value of this attribute for the bucket will be included in the result
      Returns:
      criteria to bucket results by the provided field, across a maximum number of buckets defined by the provided size

    • bucketBy

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(int size, Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> nested, List<co.elastic.clients.util.NamedValue<co.elastic.clients.elasticsearch._types.SortOrder>> order)
      Return criteria to bucket results based on the provided field.
      Parameters:
      size - the number of buckets to include results across.
      nested - a map of nested aggregations, from arbitrary string key to aggregation
      order - (optional) named value from aggregation key (string) to sort order
      Returns:
      criteria to bucket results by the provided field, across a maximum number of buckets, with nested (sub)aggregations

    • bucketBy

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation bucketBy(String field, int size, Map<String,co.elastic.clients.elasticsearch._types.aggregations.Aggregation> nested, List<co.elastic.clients.util.NamedValue<co.elastic.clients.elasticsearch._types.SortOrder>> order)
      Return criteria to bucket results based on the provided field, including nested aggregations and (optionally) sorting the top-level buckets by one of the nested aggregation's results.
      Parameters:
      field - by which to bucket the results
      size - the number of buckets to include results across
      nested - a map of nested aggregations, from arbitrary string key to aggregation
      order - (optional) named value from aggregation key (string) to sort order
      Returns:
      criteria to bucket results by the provided field, across a maximum number of buckets, with nested (sub)aggregations

    • order

      co.elastic.clients.elasticsearch._types.SortOptions order(co.elastic.clients.elasticsearch._types.SortOrder order)
      Return a condition to sort results by the field, in the order specified.
      Parameters:
      order - the order in which to sort the results based on the values of the field
      Returns:
      sort condition for the provided field, in the order specified

    • order

      static co.elastic.clients.elasticsearch._types.SortOptions order(String field, co.elastic.clients.elasticsearch._types.SortOrder order)
      Return a condition to sort results by the provided field, in the specified order.
      Parameters:
      field - by which to sort the results
      order - in which to sort the results
      Returns:
      sort condition for the provided field, in the specified order