NumericRankField¶

class pyatlan.model.fields.atlan_fields.NumericRankField(atlan_field_name: StrictStr, numeric_field_name: StrictStr, rank_field_name: StrictStr)[source]¶

Represents any field in Atlan that can be searched using only numeric search operations, but also has a rank-orderable index.

avg() → Aggregation¶: Returns criteria to calculate the average value of the provided field across all results.

between(minimum: StrictInt | StrictFloat, maximum: StrictInt | StrictFloat) → Query¶: Returns a query that will match all assets whose field has a value between the minimum and maximum specified values, inclusive.

bucket_by(size: int = 10, include_source_value: bool = False, nested: Dict[Any, Aggregation] | None = None, order: List[Dict[str, SortOrder]] | None = None) → Aggregation¶

Return criteria to bucket results based on the provided field.

Parameters:

size – the number of buckets to include results across, defaults to 10.
include_source_value – whether to include the source value (True) or not (False)
nested – (optional) nested aggregations to include.
order – (optional) the order for the buckets.

Returns:

criteria to bucket results by the provided field,

across a maximum number of buckets defined by the provided size.

eq(value: StrictInt | StrictFloat) → Query¶

Returns a query that will match all assets whose field has a value that exactly matches the provided numeric value.

Param:: 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(value: StrictInt | StrictFloat) → Query¶

Returns a query that will match all assets whose field has a value that is strictly greater than the provided numeric value.

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(value: StrictInt | StrictFloat) → Query¶

Returns a query that will match all assets whose field has a value that is greater than or equal to the provided numeric value.

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

has_any_value() → Query¶

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 for the field

property in_lineage: LineageFilterFieldNumeric¶: Returns a proxy which can be used a lineage filter with the appropriate subset of conditions

lt(value: StrictInt | StrictFloat) → Query¶

Returns a query that will match all assets whose field has a value that is strictly less than the provided numeric value.

Parameters:: value – the numeric value to compare against
Returns:: a value that will only match assets whose value for the field is strictly less than the numeric value provided

lte(value: StrictInt | StrictFloat) → Query¶

Returns a query that will match all assets whose field has a value that is less than or equal to the provided numeric value.

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

max() → Aggregation¶: Returns criteria to calculate the maximum value of the provided field across all results.

min() → Aggregation¶: Returns criteria to calculate the minimum value of the provided field across all results.

property numeric_field_name: str¶

Returns the name of the numeric field index for this attribute in Elastic.

Returns:: the field name for the numeric index on this attribute

order(order: SortOrder = SortOrder.ASCENDING) → SortItem¶

Returns a condition to sort results by the field, in the specified order.

Parameters:: order – in which to sort the results
Returns:: sort condition for the field, in the specified order

sum() → Aggregation¶: Returns criteria to calculate the sum value of the provided field across all results.