Package com.atlan.model.fields

Interface INumericallySearchable

All Known Implementing Classes:
InternalNumericField, NumericField, NumericRankField
public interface INumericallySearchable

  • Method Summary

    Modifier and Type
    Method
    Description
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    avg()
    Return criteria to calculate the average value of the field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    avg(String field)
    Return criteria to calculate the average value of the provided field across all results.
    static <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    between(String field, T min, T max)
    Returns a query that will match all assets whose provided field has a value between the minimum and maximum specified values, inclusive.
    <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    between(T min, T max)
    Returns a query that will match all assets whose provided field has a value between the minimum and maximum specified values, inclusive.
    static <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(String field, T value)
    Returns a query that will match all assets whose provided field has a value that exactly matches the provided numeric value.
    <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    eq(T value)
    Returns a query that will match all assets whose provided field has a value that exactly matches the provided numeric value.
    String
    getNumericFieldName()
    Returns the name of the numeric field index for this attribute in Elastic.
    static <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    gt(String field, T value)
    Returns a query that will match all assets whose provided field has a value that is strictly greater than the provided numeric value.
    <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    gt(T value)
    Returns a query that will match all assets whose provided field has a value that is strictly greater than the provided numeric value.
    static <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    gte(String field, T value)
    Returns a query that will match all assets whose provided field has a value that is greater than or equal to the provided numeric value.
    <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    gte(T value)
    Returns a query that will match all assets whose provided field has a value that is greater than or equal to the provided numeric value.
    static <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    lt(String field, T value)
    Returns a query that will match all assets whose provided field has a value that is strictly less than the provided numeric value.
    <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    lt(T value)
    Returns a query that will match all assets whose provided field has a value that is strictly less than the provided numeric value.
    static <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    lte(String field, T value)
    Returns a query that will match all assets whose provided field has a value that is less than or equal to the provided numeric value.
    <T extends Number>
    co.elastic.clients.elasticsearch._types.query_dsl.Query
    lte(T value)
    Returns a query that will match all assets whose provided field has a value that is less than or equal to the provided numeric value.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    max()
    Return criteria to calculate the maximum value of the field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    max(String field)
    Return criteria to calculate the maximum value of the provided field across all results.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    min()
    Return criteria to calculate the minimum value of the field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    min(String field)
    Return criteria to calculate the minimum value of the provided field across all results.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    sum()
    Return criteria to calculate a sum of the values of the field across all results.
    static co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    sum(String field)
    Return criteria to calculate a sum of the values of the provided field across all results.

  • Method Details

    • getNumericFieldName

      String getNumericFieldName()
      Returns the name of the numeric field index for this attribute in Elastic.
      Returns:
      the field name for the numeric index on this attribute

    • eq

      <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query eq(T value)
      Returns a query that will match all assets whose provided field has a value that exactly matches the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      value - the numeric value to exactly match
      Returns:
      a query that will only match assets whose value for the field is exactly the numeric value provided

    • eq

      static <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query eq(String field, T value)
      Returns a query that will match all assets whose provided field has a value that exactly matches the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      field - name of the field to search
      value - the numeric value to exactly match
      Returns:
      a query that will only match assets whose value for the field is exactly the numeric value provided

    • gt

      <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query gt(T value)
      Returns a query that will match all assets whose provided field has a value that is strictly greater than the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is strictly greater than the numeric value provided

    • gt

      static <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query gt(String field, T value)
      Returns a query that will match all assets whose provided field has a value that is strictly greater than the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      field - name of the field to search
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is strictly greater than the numeric value provided

    • gte

      <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query gte(T value)
      Returns a query that will match all assets whose provided field has a value that is greater than or equal to the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is greater than or equal to the numeric value provided

    • gte

      static <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query gte(String field, T value)
      Returns a query that will match all assets whose provided field has a value that is greater than or equal to the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      field - name of the field to search
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is greater than or equal to the numeric value provided

    • lt

      <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query lt(T value)
      Returns a query that will match all assets whose provided field has a value that is strictly less than the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is strictly less than the numeric value provided

    • lt

      static <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query lt(String field, T value)
      Returns a query that will match all assets whose provided field has a value that is strictly less than the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      field - name of the field to search
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is strictly less than the numeric value provided

    • lte

      <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query lte(T value)
      Returns a query that will match all assets whose provided field has a value that is less than or equal to the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is less than or equal to the numeric value provided

    • lte

      static <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query lte(String field, T value)
      Returns a query that will match all assets whose provided field has a value that is less than or equal to the provided numeric value.
      Type Parameters:
      T - numeric values
      Parameters:
      field - name of the field to search
      value - the numeric value to compare against
      Returns:
      a query that will only match assets whose value for the field is less than or equal to the numeric value provided

    • between

      <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query between(T min, T max)
      Returns a query that will match all assets whose provided field has a value between the minimum and maximum specified values, inclusive.
      Type Parameters:
      T - numeric values
      Parameters:
      min - minimum value of the field that will match (inclusive)
      max - maximum value of the field that will match (inclusive)
      Returns:
      a query that will only match assets whose value for the field is between the min and max (both inclusive)

    • between

      static <T extends Number> co.elastic.clients.elasticsearch._types.query_dsl.Query between(String field, T min, T max)
      Returns a query that will match all assets whose provided field has a value between the minimum and maximum specified values, inclusive.
      Type Parameters:
      T - numeric values
      Parameters:
      field - name of the field to search
      min - minimum value of the field that will match (inclusive)
      max - maximum value of the field that will match (inclusive)
      Returns:
      a query that will only match assets whose value for the field is between the min and max (both inclusive)

    • sum

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation sum()
      Return criteria to calculate a sum of the values of the field across all results.
      Returns:
      criteria to calculate the sum of the values of the provided field across the results

    • sum

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation sum(String field)
      Return criteria to calculate a sum of the values of the provided field across all results.
      Parameters:
      field - for which to find the sum of values
      Returns:
      criteria to calculate the sum of the values of the provided field across the results

    • avg

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation avg()
      Return criteria to calculate the average value of the field across all results.
      Returns:
      criteria to calculate the average value of the provided field across the results

    • avg

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation avg(String field)
      Return criteria to calculate the average value of the provided field across all results.
      Parameters:
      field - for which to find the average value
      Returns:
      criteria to calculate the average value of the provided field across the results

    • min

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation min()
      Return criteria to calculate the minimum value of the field across all results.
      Returns:
      criteria to calculate the minimum value of the provided field across the results

    • min

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation min(String field)
      Return criteria to calculate the minimum value of the provided field across all results.
      Parameters:
      field - for which to find the minimum value
      Returns:
      criteria to calculate the minimum value of the provided field across the results

    • max

      co.elastic.clients.elasticsearch._types.aggregations.Aggregation max()
      Return criteria to calculate the maximum value of the field across all results.
      Returns:
      criteria to calculate the maximum value of the provided field across the results

    • max

      static co.elastic.clients.elasticsearch._types.aggregations.Aggregation max(String field)
      Return criteria to calculate the maximum value of the provided field across all results.
      Parameters:
      field - for which to find the maximum value
      Returns:
      criteria to calculate the maximum value of the provided field across the results