187 lines (145 loc) · 6.26 KB

AlarmCondition

tb_ce_client.models.AlarmCondition

Properties

Name	Type	Description	Notes
expression	AlarmConditionExpression
schedule	AlarmConditionValueAlarmSchedule		[optional]
type	str

Subtypes

DurationAlarmCondition (type=`DURATION`)

Name	Type	Description	Notes
unit	TimeUnit
value	AlarmConditionValueLong

RepeatingAlarmCondition (type=`REPEATING`)

Name	Type	Description	Notes
count	AlarmConditionValueInteger

SimpleAlarmCondition (type=`SIMPLE`)

(no additional properties)

Referenced Types

AlarmConditionExpression

Name	Type	Description	Notes
type	str

SimpleAlarmConditionExpression (extends AlarmConditionExpression, type=`SIMPLE`)

Name	Type	Description	Notes
filters	List[AlarmConditionFilter]
operation	AlarmRuleComplexOperation		[optional]

TbelAlarmConditionExpression (extends AlarmConditionExpression, type=`TBEL`)

Name	Type	Description	Notes
expression	str

AlarmConditionValueAlarmSchedule

Name	Type	Description	Notes
static_value	AlarmSchedule		[optional]
dynamic_value_argument	str		[optional]

TimeUnit (enum)

NANOSECONDS | MICROSECONDS | MILLISECONDS | SECONDS | MINUTES | HOURS | DAYS

AlarmConditionValueLong

Name	Type	Description	Notes
static_value	int		[optional]
dynamic_value_argument	str		[optional]

AlarmConditionValueInteger

Name	Type	Description	Notes
static_value	int		[optional]
dynamic_value_argument	str		[optional]

AlarmSchedule

Name	Type	Description	Notes
type	str

AnyTimeSchedule (extends AlarmSchedule, type=`ANY_TIME`)

See AlarmSchedule for properties.

CustomTimeSchedule (extends AlarmSchedule, type=`CUSTOM`)

Name	Type	Description	Notes
timezone	str		[optional]
items	List[CustomTimeScheduleItem]		[optional]

SpecificTimeSchedule (extends AlarmSchedule, type=`SPECIFIC_TIME`)

Name	Type	Description	Notes
timezone	str		[optional]
days_of_week	List[int]		[optional]
starts_on	int		[optional]
ends_on	int		[optional]

AlarmConditionFilter

Name	Type	Description	Notes
argument	str
value_type	EntityKeyValueType
operation	AlarmRuleComplexOperation		[optional]
predicates	List[AlarmRuleKeyFilterPredicate]

AlarmRuleComplexOperation (enum)

AND | OR

EntityKeyValueType (enum)

STRING | NUMERIC | BOOLEAN | DATE_TIME

AlarmRuleKeyFilterPredicate

Name	Type	Description	Notes
type	str

AlarmRuleBooleanFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)

Name	Type	Description	Notes
operation	AlarmRuleBooleanOperation
value	AlarmConditionValueBoolean

AlarmRuleComplexFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)

Name	Type	Description	Notes
operation	AlarmRuleComplexOperation		[optional]
predicates	List[AlarmRuleKeyFilterPredicate]		[optional]

NoDataFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)

Name	Type	Description	Notes
unit	TimeUnit
duration	AlarmConditionValueLong

AlarmRuleNumericFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)

Name	Type	Description	Notes
operation	AlarmRuleNumericOperation
value	AlarmConditionValueDouble

AlarmRuleStringFilterPredicate (extends AlarmRuleKeyFilterPredicate, type=`STRING`)

Name	Type	Description	Notes
operation	AlarmRuleStringOperation
value	AlarmConditionValueString
ignore_case	bool		[optional]

CustomTimeScheduleItem

Name	Type	Description	Notes
enabled	bool		[optional]
day_of_week	int		[optional]
starts_on	int		[optional]
ends_on	int		[optional]

AlarmRuleStringOperation (enum)

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

AlarmConditionValueString

Name	Type	Description	Notes
static_value	str		[optional]
dynamic_value_argument	str		[optional]

AlarmRuleNumericOperation (enum)

EQUAL | NOT_EQUAL | GREATER | LESS | GREATER_OR_EQUAL | LESS_OR_EQUAL

AlarmConditionValueDouble

Name	Type	Description	Notes
static_value	float		[optional]
dynamic_value_argument	str		[optional]

AlarmRuleBooleanOperation (enum)

EQUAL | NOT_EQUAL

AlarmConditionValueBoolean

Name	Type	Description	Notes
static_value	bool		[optional]
dynamic_value_argument	str		[optional]

Conventions

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