129 lines (99 loc) · 4.44 KB

KeyFilter

tb_ce_client.models.KeyFilter

Properties

Name	Type	Description	Notes
key	EntityKey		[optional]
value_type	EntityKeyValueType		[optional]
predicate	KeyFilterPredicate		[optional]

Referenced Types

EntityKey

Name	Type	Description	Notes
type	EntityKeyType		[optional]
key	str		[optional]

EntityKeyValueType (enum)

STRING | NUMERIC | BOOLEAN | DATE_TIME

KeyFilterPredicate

Name	Type	Description	Notes
type	str

BooleanFilterPredicate (extends KeyFilterPredicate, type=`BOOLEAN`)

Name	Type	Description	Notes
operation	BooleanOperation		[optional]
value	FilterPredicateValueBoolean	The value associated with the filter predicate	[optional]

ComplexFilterPredicate (extends KeyFilterPredicate, type=`COMPLEX`)

Name	Type	Description	Notes
operation	ComplexOperation		[optional]
predicates	List[KeyFilterPredicate]		[optional]

NumericFilterPredicate (extends KeyFilterPredicate, type=`NUMERIC`)

Name	Type	Description	Notes
operation	NumericOperation		[optional]
value	FilterPredicateValueDouble	The value associated with the filter predicate	[optional]

StringFilterPredicate (extends KeyFilterPredicate, type=`STRING`)

Name	Type	Description	Notes
operation	StringOperation		[optional]
value	FilterPredicateValueString	The value associated with the filter predicate	[optional]
ignore_case	bool		[optional]

EntityKeyType (enum)

ATTRIBUTE | CLIENT_ATTRIBUTE | SHARED_ATTRIBUTE | SERVER_ATTRIBUTE | TIME_SERIES | ENTITY_FIELD | ALARM_FIELD

StringOperation (enum)

EQUAL | NOT_EQUAL | STARTS_WITH | ENDS_WITH | CONTAINS | NOT_CONTAINS | IN | NOT_IN

FilterPredicateValueString

Name	Type	Description	Notes
default_value	str		[optional]
user_value	str		[optional]
dynamic_value	DynamicValueString		[optional]

NumericOperation (enum)

EQUAL | NOT_EQUAL | GREATER | LESS | GREATER_OR_EQUAL | LESS_OR_EQUAL

FilterPredicateValueDouble

Name	Type	Description	Notes
default_value	float		[optional]
user_value	float		[optional]
dynamic_value	DynamicValueDouble		[optional]

BooleanOperation (enum)

EQUAL | NOT_EQUAL

FilterPredicateValueBoolean

Name	Type	Description	Notes
default_value	bool		[optional]
user_value	bool		[optional]
dynamic_value	DynamicValueBoolean		[optional]

ComplexOperation (enum)

AND | OR

DynamicValueString

Name	Type	Description	Notes
resolved_value	str		[optional]
source_type	DynamicValueSourceType		[optional]
source_attribute	str		[optional]
inherit	bool		[optional]

DynamicValueDouble

Name	Type	Description	Notes
resolved_value	float		[optional]
source_type	DynamicValueSourceType		[optional]
source_attribute	str		[optional]
inherit	bool		[optional]

DynamicValueBoolean

Name	Type	Description	Notes
resolved_value	bool		[optional]
source_type	DynamicValueSourceType		[optional]
source_attribute	str		[optional]
inherit	bool		[optional]

DynamicValueSourceType (enum)

CURRENT_TENANT | CURRENT_CUSTOMER | CURRENT_USER | CURRENT_DEVICE

Conventions

Package: tb_ce_client.models
Attribute access: obj.key, obj.name, etc.
Serialize: obj.model_dump() or obj.model_dump(by_alias=True) for camelCase JSON
Deserialize: KeyFilter.model_validate(data) or KeyFilter.model_validate_json(json_str)
None fields: Optional attributes default to None; accessing them never raises exceptions