Skip to content

AlarmCalculatedFieldConfiguration.md

Latest commit

 

History

History
314 lines (249 loc) · 11.7 KB

AlarmCalculatedFieldConfiguration.md

File metadata and controls

314 lines (249 loc) · 11.7 KB

AlarmCalculatedFieldConfiguration

org.thingsboard.client.model.AlarmCalculatedFieldConfiguration

Extends: CalculatedFieldConfiguration

Properties

Name Type Description Notes
arguments Map<String, Argument>
createRules Map<String, AlarmRule>
clearRule AlarmRule [optional]
propagate Boolean [optional]
propagateToOwner Boolean [optional]
propagateToOwnerHierarchy Boolean [optional]
propagateToTenant Boolean [optional]
propagateRelationTypes List<String> [optional]

Referenced Types

EntityId types (AdminSettingsId, AiModelId, AlarmId, ApiKeyId, ApiUsageStateId, AssetId, AssetProfileId, BlobEntityId, CalculatedFieldId, ConverterId, CustomerId, DashboardId, DeviceId, DeviceProfileId, DomainId, EdgeId, EntityGroupId, EntityViewId, GroupPermissionId, IntegrationId, JobId, MobileAppBundleId, MobileAppId, NotificationId, NotificationRequestId, NotificationRuleId, NotificationTargetId, NotificationTemplateId, OAuth2ClientId, OtaPackageId, QueueId, QueueStatsId, ReportId, ReportTemplateId, RoleId, RpcId, RuleChainId, RuleNodeId, SchedulerEventId, SecretId, TbResourceId, TenantId, TenantProfileId, UserId, WidgetTypeId, WidgetsBundleId, etc.): {entityType: EntityType, id: UUID} — all EntityId subtypes share this structure.

CalculatedFieldConfiguration

Name Type Description Notes
output Output [optional]
type String

Argument

Name Type Description Notes
refEntityId EntityId [optional]
refDynamicSourceConfiguration CfArgumentDynamicSourceConfiguration [optional]
refEntityKey ReferencedEntityKey [optional]
defaultValue String [optional]
limit Integer [optional]
timeWindow Long [optional]

AlarmRule

Name Type Description Notes
condition AlarmCondition
alarmDetails String [optional]
dashboardId DashboardId [optional]

Output

Name Type Description Notes
decimalsByDefault Integer [optional]
name String [optional]
scope AttributeScope [optional]
strategy Object [optional]
type String

AttributesOutput (extends Output, type=ATTRIBUTES)

Name Type Description Notes
strategy AttributesOutputStrategy [optional]

TimeSeriesOutput (extends Output, type=TIME_SERIES)

Name Type Description Notes
strategy TimeSeriesOutputStrategy [optional]

CfArgumentDynamicSourceConfiguration

Name Type Description Notes
type String

CurrentOwnerDynamicSourceConfiguration (extends CfArgumentDynamicSourceConfiguration, type=CURRENT_OWNER)

See CfArgumentDynamicSourceConfiguration for properties.

RelationPathQueryDynamicSourceConfiguration (extends CfArgumentDynamicSourceConfiguration, type=RELATION_PATH_QUERY)

Name Type Description Notes
levels List [optional]

ReferencedEntityKey

Name Type Description Notes
key String [optional]
type ArgumentType [optional]
scope AttributeScope [optional]

AlarmCondition

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

DurationAlarmCondition (extends AlarmCondition, type=DURATION)

Name Type Description Notes
unit TimeUnit
value AlarmConditionValueLong

RepeatingAlarmCondition (extends AlarmCondition, type=REPEATING)

Name Type Description Notes
count AlarmConditionValueInteger

SimpleAlarmCondition (extends AlarmCondition, type=SIMPLE)

See AlarmCondition for properties.

AttributeScope (enum)

CLIENT_SCOPE | SERVER_SCOPE | SHARED_SCOPE

EntityType (enum)

TENANT | CUSTOMER | USER | DASHBOARD | ASSET | DEVICE | ALARM | ENTITY_GROUP | CONVERTER | INTEGRATION | … (46 values total)

ArgumentType (enum)

TS_LATEST | ATTRIBUTE | TS_ROLLING

AlarmConditionExpression

Name Type Description Notes
type String

SimpleAlarmConditionExpression (extends AlarmConditionExpression, type=SIMPLE)

Name Type Description Notes
filters List
operation AlarmRuleComplexOperation [optional]

TbelAlarmConditionExpression (extends AlarmConditionExpression, type=TBEL)

Name Type Description Notes
expression String

AlarmConditionValueAlarmSchedule

Name Type Description Notes
staticValue AlarmSchedule [optional]
dynamicValueArgument String [optional]

TimeSeriesOutputStrategy

Name Type Description Notes
type String

TimeSeriesImmediateOutputStrategy (extends TimeSeriesOutputStrategy, type=IMMEDIATE)

Name Type Description Notes
ttl Long [optional]
saveTimeSeries Boolean [optional]
saveLatest Boolean [optional]
sendWsUpdate Boolean [optional]
processCfs Boolean [optional]

TimeSeriesRuleChainOutputStrategy (extends TimeSeriesOutputStrategy, type=RULE_CHAIN)

See TimeSeriesOutputStrategy for properties.

AttributesOutputStrategy

Name Type Description Notes
type String

AttributesImmediateOutputStrategy (extends AttributesOutputStrategy, type=IMMEDIATE)

Name Type Description Notes
sendAttributesUpdatedNotification Boolean [optional]
updateAttributesOnlyOnValueChange Boolean [optional]
saveAttribute Boolean [optional]
sendWsUpdate Boolean [optional]
processCfs Boolean [optional]

AttributesRuleChainOutputStrategy (extends AttributesOutputStrategy, type=RULE_CHAIN)

See AttributesOutputStrategy for properties.

RelationPathLevel

Name Type Description Notes
direction EntitySearchDirection
relationType String

AlarmSchedule

Name Type Description Notes
type String

AnyTimeSchedule (extends AlarmSchedule, type=ANY_TIME)

See AlarmSchedule for properties.

CustomTimeSchedule (extends AlarmSchedule, type=CUSTOM)

Name Type Description Notes
timezone String [optional]
items List [optional]

SpecificTimeSchedule (extends AlarmSchedule, type=SPECIFIC_TIME)

Name Type Description Notes
timezone String [optional]
daysOfWeek Set [optional]
startsOn Long [optional]
endsOn Long [optional]

TimeUnit (enum)

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

AlarmConditionValueLong

Name Type Description Notes
staticValue Long [optional]
dynamicValueArgument String [optional]

AlarmConditionValueInteger

Name Type Description Notes
staticValue Integer [optional]
dynamicValueArgument String [optional]

EntitySearchDirection (enum)

FROM | TO

AlarmConditionFilter

Name Type Description Notes
argument String
valueType EntityKeyValueType
operation AlarmRuleComplexOperation [optional]
predicates List

AlarmRuleComplexOperation (enum)

AND | OR

EntityKeyValueType (enum)

STRING | NUMERIC | BOOLEAN | DATE_TIME

AlarmRuleKeyFilterPredicate

Name Type Description Notes
type String

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 [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
ignoreCase Boolean [optional]

CustomTimeScheduleItem

Name Type Description Notes
enabled Boolean [optional]
dayOfWeek Integer [optional]
startsOn Long [optional]
endsOn Long [optional]

AlarmRuleStringOperation (enum)

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

AlarmConditionValueString

Name Type Description Notes
staticValue String [optional]
dynamicValueArgument String [optional]

AlarmRuleNumericOperation (enum)

EQUAL | NOT_EQUAL | GREATER | LESS | GREATER_OR_EQUAL | LESS_OR_EQUAL

AlarmConditionValueDouble

Name Type Description Notes
staticValue Double [optional]
dynamicValueArgument String [optional]

AlarmRuleBooleanOperation (enum)

EQUAL | NOT_EQUAL

AlarmConditionValueBoolean

Name Type Description Notes
staticValue Boolean [optional]
dynamicValueArgument String [optional]

Conventions

  • Package: org.thingsboard.client.model
  • Getter pattern: get<PropertyName>() — e.g., getId(), getName()
  • Setter pattern: set<PropertyName>(value) — e.g., setId(value), setName(value)
  • Null fields: Getters return null for unset optional fields; they do not throw exceptions