BooleanField#

class pyatlan.model.fields.atlan_fields.BooleanField(atlan_field_name: StrictStr, boolean_field_name: StrictStr)[source]#

Represents any field in Atlan that can be searched only by truthiness.

property boolean_field_name: str#

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

bucket_by(size: int = 10) → Aggregation#

Return criteria to bucket results based on the provided field.

param 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

eq(value: StrictBool) → Query[source]#

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

Parameters:: value – the value (bool) to check the field’s value is exactly equal to
Returns:: a query that will only match assets whose value for the field is exactly equal to the boolean 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: LineageFilterFieldBoolean#: Returns a proxy which can be used a lineage filter with the appropriate subset of conditions

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

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