Package com.atlan.model.fields

Class NumericRankField

java.lang.Object
com.atlan.model.fields.AtlanField
com.atlan.model.fields.SearchableField
com.atlan.model.fields.NumericRankField
All Implemented Interfaces:
INumericallySearchable, IRankSearchable, ISearchable
public class NumericRankField extends SearchableField implements INumericallySearchable, IRankSearchable
Represents any field in Atlan that can be searched using only numeric search operations, but also has a rank-orderable index.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    final LineageFilterFieldNumeric
    inLineage
     

    Fields inherited from interface com.atlan.model.fields.ISearchable

    EMBEDDED_SOURCE_VALUE

  • Constructor Summary

    Constructors
    Constructor
    Description
    NumericRankField(String atlan, String numeric, String rank)
    Default constructor.

  • 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.
    <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.
    <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.
    String
    getRankFieldName()
    Returns the name of the numeric rank field index for this attribute in Elastic.
    <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.
    <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.
    <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.
    <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.
    co.elastic.clients.elasticsearch._types.aggregations.Aggregation
    min()
    Return criteria to calculate the minimum value of the 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.

    Methods inherited from class com.atlan.model.fields.SearchableField

    bucketBy, bucketBy, count, distinct, distinct, getElasticFieldName, hasAnyValue, order

    Methods inherited from class com.atlan.model.fields.AtlanField

    getAtlanFieldName

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.atlan.model.fields.ISearchable

    bucketBy, bucketBy

  • Field Details

  • Constructor Details

    • NumericRankField

      public NumericRankField(String atlan, String numeric, String rank)
      Default constructor.
      Parameters:
      atlan - name of the attribute in the metastore
      numeric - name of the numeric field in the search index
      rank - name of the rank orderable field in the search index

  • Method Details

    • getRankFieldName

      public String getRankFieldName()
      Returns the name of the numeric rank field index for this attribute in Elastic.
      Specified by:
      getRankFieldName in interface IRankSearchable
      Returns:
      the field name for the numeric rank index on this attribute

    • getNumericFieldName

      public String getNumericFieldName()
      Returns the name of the numeric field index for this attribute in Elastic.
      Specified by:
      getNumericFieldName in interface INumericallySearchable
      Returns:
      the field name for the numeric index on this attribute

    • eq

      public <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.
      Specified by:
      eq in interface INumericallySearchable
      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

    • gt

      public <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.
      Specified by:
      gt in interface INumericallySearchable
      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

    • gte

      public <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.
      Specified by:
      gte in interface INumericallySearchable
      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

    • lt

      public <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.
      Specified by:
      lt in interface INumericallySearchable
      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

    • lte

      public <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.
      Specified by:
      lte in interface INumericallySearchable
      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

    • between

      public <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.
      Specified by:
      between in interface INumericallySearchable
      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)

    • sum

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

    • avg

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

    • min

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

    • max

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