Package com.atlan.model.fields

Class BooleanField

java.lang.Object

com.atlan.model.fields.AtlanField

com.atlan.model.fields.SearchableField

com.atlan.model.fields.BooleanField

All Implemented Interfaces:

IBooleanSearchable, ISearchable

public class BooleanField
extends SearchableField
implements IBooleanSearchable

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

Field Summary

Fields

Modifier and Type	Field	Description
final LineageFilterFieldBoolean	inLineage

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

EMBEDDED_SOURCE_VALUE

Constructor Summary

Constructors

Constructor	Description
BooleanField(String atlan, String bool)	Default constructor.

Method Summary

Modifier and Type	Method	Description
co.elastic.clients.elasticsearch._types.query_dsl.Query	eq(boolean value)	Returns a query that will match all assets whose provided field has a value that exactly equals the provided boolean value.
String	getBooleanFieldName()	Returns the name of the boolean field index for this attribute in Elastic.

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

inLineage

public final LineageFilterFieldBoolean inLineage

Constructor Details

BooleanField

public BooleanField(String atlan,
 String bool)

Default constructor.

Parameters:

atlan - name of the attribute in the metastore

bool - name of the boolean field in the search index

Method Details

getBooleanFieldName

public String getBooleanFieldName()

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

Specified by:

getBooleanFieldName in interface IBooleanSearchable

Returns:

the field name for the boolean index on this attribute

eq

public co.elastic.clients.elasticsearch._types.query_dsl.Query eq(boolean value)

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

Specified by:

eq in interface IBooleanSearchable

Parameters:

value - the value (boolean) 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