SearchableField

class pyatlan.model.fields.atlan_fields.SearchableField(atlan_field_name: StrictStr, elastic_field_name: StrictStr)

Base class for any field in Atlan that can be searched.

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.

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

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