From 2ac06016cfbd6d85992086ca1a2e5aa34bd06110 Mon Sep 17 00:00:00 2001 From: Viacheslav Klimov Date: Wed, 8 Apr 2026 09:16:25 +0100 Subject: [PATCH] Update PE OpenAPI spec (from master) --- pe/docs/AiModelExportData.md | 84 +- pe/docs/AlarmCalculatedFieldConfiguration.md | 84 +- ...larmRuleCondition.md => AlarmCondition.md} | 76 +- pe/docs/AlarmConditionExpression.md | 44 +- ...itionFilter.md => AlarmConditionFilter.md} | 42 +- ...md => AlarmConditionValueAlarmSchedule.md} | 28 +- pe/docs/AlarmRule.md | 196 +++++ pe/docs/AlarmRuleBooleanFilterPredicate.md | 4 +- pe/docs/AlarmRuleBooleanOperation.md | 23 + pe/docs/AlarmRuleComplexFilterPredicate.md | 4 +- pe/docs/AlarmRuleComplexOperation.md | 23 + pe/docs/AlarmRuleDefinition.md | 380 +++++++- pe/docs/AlarmRuleDefinitionInfo.md | 84 +- pe/docs/AlarmRuleKeyFilterPredicate.md | 28 +- pe/docs/AlarmRuleNumericFilterPredicate.md | 4 +- pe/docs/AlarmRuleNumericOperation.md | 31 + pe/docs/AlarmRuleStringFilterPredicate.md | 6 +- pe/docs/AlarmRuleStringOperation.md | 35 + ...{AlarmRuleSchedule.md => AlarmSchedule.md} | 22 +- pe/docs/AlarmTableComponent.md | 4 +- ...eAnyTimeSchedule.md => AnyTimeSchedule.md} | 8 +- pe/docs/AssetExportData.md | 84 +- pe/docs/AssetProfileExportData.md | 84 +- pe/docs/CalculatedField.md | 84 +- pe/docs/CalculatedFieldConfiguration.md | 84 +- pe/docs/CalculatedFieldInfo.md | 84 +- pe/docs/ConverterExportData.md | 84 +- pe/docs/CsvReportTemplateConfig.md | 4 +- ...mTimeSchedule.md => CustomTimeSchedule.md} | 16 +- ...eduleItem.md => CustomTimeScheduleItem.md} | 8 +- pe/docs/CustomerExportData.md | 84 +- pe/docs/DashboardExportData.md | 84 +- pe/docs/DeviceExportData.md | 84 +- pe/docs/DeviceProfileExportData.md | 84 +- ...Condition.md => DurationAlarmCondition.md} | 74 +- pe/docs/EntityDataDiff.md | 84 +- pe/docs/EntityExportData.md | 84 +- pe/docs/EntityGroupExportData.md | 84 +- pe/docs/EntityTableComponent.md | 4 +- pe/docs/EntityViewExportData.md | 84 +- pe/docs/HeaderFooter.md | 4 +- pe/docs/IntegrationExportData.md | 84 +- ...rPredicate.md => NoDataFilterPredicate.md} | 12 +- pe/docs/NotificationRuleExportData.md | 84 +- pe/docs/NotificationTargetExportData.md | 84 +- pe/docs/NotificationTemplateExportData.md | 84 +- pe/docs/OtaPackageExportData.md | 84 +- pe/docs/PageDataAlarmRuleDefinition.md | 376 +++++++- pe/docs/PageDataAlarmRuleDefinitionInfo.md | 84 +- pe/docs/PageDataCalculatedField.md | 84 +- pe/docs/PageDataCalculatedFieldInfo.md | 84 +- pe/docs/PdfReportTemplateConfig.md | 4 +- ...ondition.md => RepeatingAlarmCondition.md} | 80 +- pe/docs/ReportComponent.md | 4 +- pe/docs/ReportRequest.md | 4 +- pe/docs/ReportTemplate.md | 4 +- pe/docs/ReportTemplateConfig.md | 4 +- pe/docs/ReportTemplateExportData.md | 84 +- pe/docs/RoleExportData.md | 84 +- pe/docs/RuleChainExportData.md | 84 +- pe/docs/SchedulerEventExportData.md | 84 +- ...leCondition.md => SimpleAlarmCondition.md} | 80 +- pe/docs/SimpleAlarmConditionExpression.md | 44 +- pe/docs/SolutionData.md | 84 +- pe/docs/SolutionExportResponse.md | 84 +- ...imeSchedule.md => SpecificTimeSchedule.md} | 12 +- pe/docs/TableSortDirection.md | 23 + pe/docs/TableSortOrder.md | 4 +- pe/docs/TbResourceExportData.md | 84 +- pe/docs/TimeseriesTableComponent.md | 4 +- pe/docs/WidgetTypeExportData.md | 84 +- pe/docs/WidgetsBundleExportData.md | 84 +- pe/spec/openapi.json | 827 ++++++++++-------- .../AlarmCalculatedFieldConfiguration.java | 20 +- ...RuleCondition.java => AlarmCondition.java} | 54 +- ...nFilter.java => AlarmConditionFilter.java} | 114 +-- ... => AlarmConditionValueAlarmSchedule.java} | 84 +- .../thingsboard/client/model/AlarmRule.java | 230 +++++ .../AlarmRuleBooleanFilterPredicate.java | 10 +- .../model/AlarmRuleBooleanOperation.java | 80 ++ .../AlarmRuleComplexFilterPredicate.java | 10 +- .../model/AlarmRuleComplexOperation.java | 80 ++ .../client/model/AlarmRuleDefinition.java | 405 +++++++-- .../model/AlarmRuleKeyFilterPredicate.java | 4 +- .../AlarmRuleNumericFilterPredicate.java | 10 +- .../model/AlarmRuleNumericOperation.java | 88 ++ .../model/AlarmRuleStringFilterPredicate.java | 86 +- .../model/AlarmRuleStringOperation.java | 92 ++ ...rmRuleSchedule.java => AlarmSchedule.java} | 34 +- ...TimeSchedule.java => AnyTimeSchedule.java} | 16 +- ...eSchedule.java => CustomTimeSchedule.java} | 104 +-- ...eItem.java => CustomTimeScheduleItem.java} | 130 +-- ...ition.java => DurationAlarmCondition.java} | 36 +- ...dicate.java => NoDataFilterPredicate.java} | 86 +- ...tion.java => RepeatingAlarmCondition.java} | 30 +- ...ndition.java => SimpleAlarmCondition.java} | 22 +- .../model/SimpleAlarmConditionExpression.java | 22 +- ...chedule.java => SpecificTimeSchedule.java} | 140 +-- .../client/model/TableSortDirection.java | 80 ++ .../client/model/TableSortOrder.java | 10 +- 100 files changed, 4721 insertions(+), 2762 deletions(-) rename pe/docs/{AlarmRuleCondition.md => AlarmCondition.md} (78%) rename pe/docs/{AlarmRuleConditionFilter.md => AlarmConditionFilter.md} (84%) rename pe/docs/{AlarmConditionValueAlarmRuleSchedule.md => AlarmConditionValueAlarmSchedule.md} (67%) create mode 100644 pe/docs/AlarmRule.md create mode 100644 pe/docs/AlarmRuleBooleanOperation.md create mode 100644 pe/docs/AlarmRuleComplexOperation.md create mode 100644 pe/docs/AlarmRuleNumericOperation.md create mode 100644 pe/docs/AlarmRuleStringOperation.md rename pe/docs/{AlarmRuleSchedule.md => AlarmSchedule.md} (76%) rename pe/docs/{AlarmRuleAnyTimeSchedule.md => AnyTimeSchedule.md} (80%) rename pe/docs/{AlarmRuleCustomTimeSchedule.md => CustomTimeSchedule.md} (76%) rename pe/docs/{AlarmRuleCustomTimeScheduleItem.md => CustomTimeScheduleItem.md} (86%) rename pe/docs/{AlarmRuleDurationCondition.md => DurationAlarmCondition.md} (78%) rename pe/docs/{AlarmRuleNoDataFilterPredicate.md => NoDataFilterPredicate.md} (91%) rename pe/docs/{AlarmRuleRepeatingCondition.md => RepeatingAlarmCondition.md} (78%) rename pe/docs/{AlarmRuleSimpleCondition.md => SimpleAlarmCondition.md} (78%) rename pe/docs/{AlarmRuleSpecificTimeSchedule.md => SpecificTimeSchedule.md} (83%) create mode 100644 pe/docs/TableSortDirection.md rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleCondition.java => AlarmCondition.java} (78%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleConditionFilter.java => AlarmConditionFilter.java} (82%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmConditionValueAlarmRuleSchedule.java => AlarmConditionValueAlarmSchedule.java} (79%) create mode 100644 pe/src/main/java/org/thingsboard/client/model/AlarmRule.java create mode 100644 pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanOperation.java create mode 100644 pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexOperation.java create mode 100644 pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericOperation.java create mode 100644 pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringOperation.java rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleSchedule.java => AlarmSchedule.java} (81%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleAnyTimeSchedule.java => AnyTimeSchedule.java} (89%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleCustomTimeSchedule.java => CustomTimeSchedule.java} (80%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleCustomTimeScheduleItem.java => CustomTimeScheduleItem.java} (83%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleDurationCondition.java => DurationAlarmCondition.java} (83%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleNoDataFilterPredicate.java => NoDataFilterPredicate.java} (84%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleRepeatingCondition.java => RepeatingAlarmCondition.java} (83%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleSimpleCondition.java => SimpleAlarmCondition.java} (85%) rename pe/src/main/java/org/thingsboard/client/model/{AlarmRuleSpecificTimeSchedule.java => SpecificTimeSchedule.java} (83%) create mode 100644 pe/src/main/java/org/thingsboard/client/model/TableSortDirection.java diff --git a/pe/docs/AiModelExportData.md b/pe/docs/AiModelExportData.md index a437ef5b..038d83bd 100644 --- a/pe/docs/AiModelExportData.md +++ b/pe/docs/AiModelExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmCalculatedFieldConfiguration.md b/pe/docs/AlarmCalculatedFieldConfiguration.md index f3cf9b96..9731c9df 100644 --- a/pe/docs/AlarmCalculatedFieldConfiguration.md +++ b/pe/docs/AlarmCalculatedFieldConfiguration.md @@ -10,8 +10,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **arguments** | **Map\** | | | -| **createRules** | **Map\** | | | -| **clearRule** | **AlarmRuleDefinition** | | [optional] | +| **createRules** | **Map\** | | | +| **clearRule** | **AlarmRule** | | [optional] | | **propagate** | **Boolean** | | [optional] | | **propagateToOwner** | **Boolean** | | [optional] | | **propagateToOwnerHierarchy** | **Boolean** | | [optional] | @@ -40,11 +40,11 @@ | limit | Integer | | [optional] | | timeWindow | Long | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### Output @@ -86,26 +86,26 @@ | type | ArgumentType | | [optional] | | scope | AttributeScope | | [optional] | -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AttributeScope (enum) `CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE` @@ -124,19 +124,19 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | #### TimeSeriesOutputStrategy | Name | Type | Description | Notes | @@ -178,27 +178,27 @@ | direction | EntitySearchDirection | | | | relationType | String | | | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -218,17 +218,20 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -237,46 +240,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -285,7 +285,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -294,7 +294,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleCondition.md b/pe/docs/AlarmCondition.md similarity index 78% rename from pe/docs/AlarmRuleCondition.md rename to pe/docs/AlarmCondition.md index 92d6b2ad..39765535 100644 --- a/pe/docs/AlarmRuleCondition.md +++ b/pe/docs/AlarmCondition.md @@ -1,32 +1,32 @@ -# AlarmRuleCondition +# AlarmCondition -`org.thingsboard.client.model.AlarmRuleCondition` +`org.thingsboard.client.model.AlarmCondition` ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **expression** | **AlarmConditionExpression** | | | -| **schedule** | **AlarmConditionValueAlarmRuleSchedule** | | [optional] | +| **schedule** | **AlarmConditionValueAlarmSchedule** | | [optional] | | **type** | **String** | | | ## Subtypes -#### AlarmRuleDurationCondition *(type=`DURATION`)* +#### DurationAlarmCondition *(type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(type=`REPEATING`)* +#### RepeatingAlarmCondition *(type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(type=`SIMPLE`)* +#### SimpleAlarmCondition *(type=`SIMPLE`)* *(no additional properties)* ## Referenced Types @@ -39,19 +39,19 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -68,39 +68,42 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -109,46 +112,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -157,7 +157,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -166,7 +166,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmConditionExpression.md b/pe/docs/AlarmConditionExpression.md index 8f52fdc5..383fe608 100644 --- a/pe/docs/AlarmConditionExpression.md +++ b/pe/docs/AlarmConditionExpression.md @@ -16,8 +16,8 @@ #### SimpleAlarmConditionExpression *(type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(type=`TBEL`)* | Name | Type | Description | Notes | @@ -26,17 +26,20 @@ ## Referenced Types -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -45,38 +48,35 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -85,7 +85,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -94,7 +94,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean @@ -103,15 +103,15 @@ | staticValue | Boolean | | [optional] | | dynamicValueArgument | String | | [optional] | +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - --- ### Conventions diff --git a/pe/docs/AlarmRuleConditionFilter.md b/pe/docs/AlarmConditionFilter.md similarity index 84% rename from pe/docs/AlarmRuleConditionFilter.md rename to pe/docs/AlarmConditionFilter.md index 3b385623..09bd221d 100644 --- a/pe/docs/AlarmRuleConditionFilter.md +++ b/pe/docs/AlarmConditionFilter.md @@ -1,22 +1,25 @@ -# AlarmRuleConditionFilter +# AlarmConditionFilter -`org.thingsboard.client.model.AlarmRuleConditionFilter` +`org.thingsboard.client.model.AlarmConditionFilter` ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **argument** | **String** | | | -| **operation** | **ComplexOperation** | | [optional] | -| **predicates** | **List\** | | | | **valueType** | **EntityKeyValueType** | | | +| **operation** | **AlarmRuleComplexOperation** | | [optional] | +| **predicates** | **List\** | | | ## Referenced Types -#### ComplexOperation (enum) +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + +#### AlarmRuleComplexOperation (enum) `AND` | `OR` #### AlarmRuleKeyFilterPredicate @@ -27,38 +30,35 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -67,7 +67,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -76,7 +76,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean @@ -85,15 +85,15 @@ | staticValue | Boolean | | [optional] | | dynamicValueArgument | String | | [optional] | +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - --- ### Conventions diff --git a/pe/docs/AlarmConditionValueAlarmRuleSchedule.md b/pe/docs/AlarmConditionValueAlarmSchedule.md similarity index 67% rename from pe/docs/AlarmConditionValueAlarmRuleSchedule.md rename to pe/docs/AlarmConditionValueAlarmSchedule.md index 5461b4c4..a61bd2b6 100644 --- a/pe/docs/AlarmConditionValueAlarmRuleSchedule.md +++ b/pe/docs/AlarmConditionValueAlarmSchedule.md @@ -1,48 +1,48 @@ -# AlarmConditionValueAlarmRuleSchedule +# AlarmConditionValueAlarmSchedule -`org.thingsboard.client.model.AlarmConditionValueAlarmRuleSchedule` +`org.thingsboard.client.model.AlarmConditionValueAlarmSchedule` ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| **staticValue** | **AlarmSchedule** | | [optional] | | **dynamicValueArgument** | **String** | | [optional] | -| **staticValue** | **AlarmRuleSchedule** | | [optional] | ## Referenced Types -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | --- diff --git a/pe/docs/AlarmRule.md b/pe/docs/AlarmRule.md new file mode 100644 index 00000000..38bd1c4b --- /dev/null +++ b/pe/docs/AlarmRule.md @@ -0,0 +1,196 @@ + +# AlarmRule + +`org.thingsboard.client.model.AlarmRule` + +## Properties + +| Name | Type | Description | Notes | +|------------ | ------------- | ------------- | -------------| +| **condition** | **AlarmCondition** | | | +| **alarmDetails** | **String** | | [optional] | +| **dashboardId** | **DashboardId** | | [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. + +#### 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.* + +#### 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] | + +#### 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] | + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + +#### 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()` — e.g., `getId()`, `getName()` +- **Setter pattern:** `set(value)` — e.g., `setId(value)`, `setName(value)` +- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions + diff --git a/pe/docs/AlarmRuleBooleanFilterPredicate.md b/pe/docs/AlarmRuleBooleanFilterPredicate.md index 98c7f0da..d93ab5c7 100644 --- a/pe/docs/AlarmRuleBooleanFilterPredicate.md +++ b/pe/docs/AlarmRuleBooleanFilterPredicate.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **operation** | **BooleanOperation** | | | +| **operation** | **AlarmRuleBooleanOperation** | | | | **value** | **AlarmConditionValueBoolean** | | | @@ -21,7 +21,7 @@ |------|------|-------------|-------| | type | String | | | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleBooleanOperation.md b/pe/docs/AlarmRuleBooleanOperation.md new file mode 100644 index 00000000..dd9e8e87 --- /dev/null +++ b/pe/docs/AlarmRuleBooleanOperation.md @@ -0,0 +1,23 @@ + +# AlarmRuleBooleanOperation + +`org.thingsboard.client.model.AlarmRuleBooleanOperation` + +## Enum Values + + +* `EQUAL` (value: `"EQUAL"`) + +* `NOT_EQUAL` (value: `"NOT_EQUAL"`) + + + +--- + +### Conventions + +- **Package:** `org.thingsboard.client.model` +- **Getter pattern:** `get()` — e.g., `getId()`, `getName()` +- **Setter pattern:** `set(value)` — e.g., `setId(value)`, `setName(value)` +- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions + diff --git a/pe/docs/AlarmRuleComplexFilterPredicate.md b/pe/docs/AlarmRuleComplexFilterPredicate.md index 8e995c80..528c4b6f 100644 --- a/pe/docs/AlarmRuleComplexFilterPredicate.md +++ b/pe/docs/AlarmRuleComplexFilterPredicate.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **operation** | **ComplexOperation** | | [optional] | +| **operation** | **AlarmRuleComplexOperation** | | [optional] | | **predicates** | **List\** | | [optional] | @@ -21,7 +21,7 @@ |------|------|-------------|-------| | type | String | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` --- diff --git a/pe/docs/AlarmRuleComplexOperation.md b/pe/docs/AlarmRuleComplexOperation.md new file mode 100644 index 00000000..17056306 --- /dev/null +++ b/pe/docs/AlarmRuleComplexOperation.md @@ -0,0 +1,23 @@ + +# AlarmRuleComplexOperation + +`org.thingsboard.client.model.AlarmRuleComplexOperation` + +## Enum Values + + +* `AND` (value: `"AND"`) + +* `OR` (value: `"OR"`) + + + +--- + +### Conventions + +- **Package:** `org.thingsboard.client.model` +- **Getter pattern:** `get()` — e.g., `getId()`, `getName()` +- **Setter pattern:** `set(value)` — e.g., `setId(value)`, `setName(value)` +- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions + diff --git a/pe/docs/AlarmRuleDefinition.md b/pe/docs/AlarmRuleDefinition.md index c57259f5..f26e6e92 100644 --- a/pe/docs/AlarmRuleDefinition.md +++ b/pe/docs/AlarmRuleDefinition.md @@ -7,9 +7,17 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **alarmDetails** | **String** | | [optional] | -| **condition** | **AlarmRuleCondition** | | | -| **dashboardId** | **DashboardId** | | [optional] | +| **id** | **CalculatedFieldId** | JSON object with the Alarm Rule Id. Referencing non-existing Alarm Rule Id will cause error. | [optional] | +| **createdTime** | **Long** | Timestamp of the alarm rule creation, in milliseconds | [optional] [readonly] | +| **tenantId** | **TenantId** | | [optional] | +| **entityId** | **EntityId** | | [optional] | +| **name** | **String** | User defined name of the alarm rule. | [optional] | +| **debugSettings** | **DebugSettings** | Debug settings object. | [optional] | +| **configurationVersion** | **Integer** | Version of alarm rule configuration. | [optional] | +| **_configuration** | **AlarmCalculatedFieldConfiguration** | | | +| **version** | **Long** | | [optional] | +| **additionalInfo** | **com.fasterxml.jackson.databind.JsonNode** | Additional parameters of the alarm rule. May include: 'description' (string). | [optional] | +| **debugMode** | **Boolean** | | [optional] | @@ -17,26 +25,255 @@ > **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. -#### AlarmRuleCondition +#### DebugSettings +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failuresEnabled | Boolean | Debug failures. | [optional] | +| allEnabled | Boolean | Debug All. Used as a trigger for updating debugAllUntil. | [optional] | +| allEnabledUntil | Long | Timestamp of the end time for the processing debug events. | [optional] | + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + +#### CalculatedFieldConfiguration +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| output | Output | | [optional] | +| type | String | | | + +#### AlarmCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`ALARM`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | +| propagate | Boolean | | [optional] | +| propagateToOwner | Boolean | | [optional] | +| propagateToOwnerHierarchy | Boolean | | [optional] | +| propagateToTenant | Boolean | | [optional] | +| propagateRelationTypes | List | | [optional] | + +#### EntityAggregationCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`ENTITY_AGGREGATION`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| metrics | Map | | | +| interval | AggInterval | | | +| watermark | Watermark | | [optional] | +| produceIntermediateResult | Boolean | | [optional] | + +#### GeofencingCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`GEOFENCING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| entityCoordinates | EntityCoordinates | | | +| zoneGroups | Map | | | +| scheduledUpdateEnabled | Boolean | | [optional] | +| scheduledUpdateInterval | Integer | | [optional] | + +#### PropagationCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`PROPAGATION`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| expression | String | | [optional] | +| relation | RelationPathLevel | | | +| applyExpressionToResolvedArguments | Boolean | | [optional] | + +#### RelatedEntitiesAggregationCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`RELATED_ENTITIES_AGGREGATION`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| relation | RelationPathLevel | | | +| arguments | Map | | | +| deduplicationIntervalInSec | Long | | [optional] | +| metrics | Map | | | +| useLatestTs | Boolean | | [optional] | +| scheduledUpdateInterval | Integer | | [optional] | +| scheduledUpdateEnabled | Boolean | | [optional] | + +#### ScriptCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`SCRIPT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| expression | String | | [optional] | + +#### SimpleCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`SIMPLE`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| expression | String | | [optional] | +| useLatestTs | Boolean | | [optional] | + +#### 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 | +|------|------|-------------|-------| +| name | String | | [optional] | +| scope | AttributeScope | | [optional] | +| decimalsByDefault | Integer | | [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 | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* + +#### AttributeScope (enum) +`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE` + +#### EntityCoordinates +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| latitudeKeyName | String | | | +| longitudeKeyName | String | | | + +#### ZoneGroupConfiguration +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| refEntityId | EntityId | | [optional] | +| refDynamicSourceConfiguration | CfArgumentDynamicSourceConfiguration | | [optional] | +| perimeterKeyName | String | | | +| reportStrategy | GeofencingReportStrategy | | | +| createRelationsWithMatchedZones | Boolean | | [optional] | +| relationType | String | | [optional] | +| direction | EntitySearchDirection | | [optional] | + +#### RelationPathLevel +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| direction | EntitySearchDirection | | | +| relationType | String | | | + +#### AggMetric +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| function | AggFunction | | [optional] | +| filter | String | | [optional] | +| input | AggInput | | [optional] | +| defaultValue | Double | | [optional] | + +#### AggInterval +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| type | String | | | + +#### CustomInterval *(extends AggInterval, type=`CUSTOM`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | +| durationSec | Long | | | + +#### DayInterval *(extends AggInterval, type=`DAY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### HourInterval *(extends AggInterval, type=`HOUR`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### MonthInterval *(extends AggInterval, type=`MONTH`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### QuarterInterval *(extends AggInterval, type=`QUARTER`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### WeekInterval *(extends AggInterval, type=`WEEK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### WeekSunSatInterval *(extends AggInterval, type=`WEEK_SUN_SAT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### YearInterval *(extends AggInterval, type=`YEAR`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### Watermark +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| duration | Long | | [optional] | + +#### ArgumentType (enum) +`TS_LATEST` | `ATTRIBUTE` | `TS_ROLLING` #### AlarmConditionExpression | Name | Type | Description | Notes | @@ -46,41 +283,99 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### TimeSeriesOutputStrategy | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### 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.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### 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.* + +#### GeofencingReportStrategy (enum) +`REPORT_TRANSITION_EVENTS_ONLY` | `REPORT_PRESENCE_STATUS_ONLY` | `REPORT_TRANSITION_EVENTS_AND_PRESENCE_STATUS` + +#### EntitySearchDirection (enum) +`FROM` | `TO` + +#### AggFunction (enum) +`MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` + +#### AggInput +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| type | String | | | + +#### AggFunctionInput *(extends AggInput, type=`function`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| function | String | | [optional] | + +#### AggKeyInput *(extends AggInput, type=`key`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| key | String | | [optional] | + +#### 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 | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -97,20 +392,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### EntityType (enum) -`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) - -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -119,46 +414,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -167,7 +459,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -176,7 +468,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleDefinitionInfo.md b/pe/docs/AlarmRuleDefinitionInfo.md index e5a63596..c0d014db 100644 --- a/pe/docs/AlarmRuleDefinitionInfo.md +++ b/pe/docs/AlarmRuleDefinitionInfo.md @@ -46,8 +46,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -113,11 +113,11 @@ | limit | Integer | | [optional] | | timeWindow | Long | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### Output @@ -159,26 +159,26 @@ | type | ArgumentType | | [optional] | | scope | AttributeScope | | [optional] | -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AttributeScope (enum) `CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE` @@ -284,19 +284,19 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | #### TimeSeriesOutputStrategy | Name | Type | Description | Notes | @@ -356,27 +356,27 @@ |------|------|-------------|-------| | key | String | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -393,17 +393,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -412,46 +415,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -460,7 +460,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -469,7 +469,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleKeyFilterPredicate.md b/pe/docs/AlarmRuleKeyFilterPredicate.md index 07a96cd8..893efb05 100644 --- a/pe/docs/AlarmRuleKeyFilterPredicate.md +++ b/pe/docs/AlarmRuleKeyFilterPredicate.md @@ -18,37 +18,37 @@ Filter predicate for alarm rule key-based filtering #### AlarmRuleBooleanFilterPredicate *(type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(type=`NO_DATA`)* +#### NoDataFilterPredicate *(type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | ## Referenced Types -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean @@ -57,19 +57,19 @@ Filter predicate for alarm rule key-based filtering | staticValue | Boolean | | [optional] | | dynamicValueArgument | String | | [optional] | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -78,7 +78,7 @@ Filter predicate for alarm rule key-based filtering | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString diff --git a/pe/docs/AlarmRuleNumericFilterPredicate.md b/pe/docs/AlarmRuleNumericFilterPredicate.md index b00d105c..dff16331 100644 --- a/pe/docs/AlarmRuleNumericFilterPredicate.md +++ b/pe/docs/AlarmRuleNumericFilterPredicate.md @@ -9,7 +9,7 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **operation** | **NumericOperation** | | | +| **operation** | **AlarmRuleNumericOperation** | | | | **value** | **AlarmConditionValueDouble** | | | @@ -21,7 +21,7 @@ |------|------|-------------|-------| | type | String | | | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble diff --git a/pe/docs/AlarmRuleNumericOperation.md b/pe/docs/AlarmRuleNumericOperation.md new file mode 100644 index 00000000..6fbed0dc --- /dev/null +++ b/pe/docs/AlarmRuleNumericOperation.md @@ -0,0 +1,31 @@ + +# AlarmRuleNumericOperation + +`org.thingsboard.client.model.AlarmRuleNumericOperation` + +## Enum Values + + +* `EQUAL` (value: `"EQUAL"`) + +* `NOT_EQUAL` (value: `"NOT_EQUAL"`) + +* `GREATER` (value: `"GREATER"`) + +* `LESS` (value: `"LESS"`) + +* `GREATER_OR_EQUAL` (value: `"GREATER_OR_EQUAL"`) + +* `LESS_OR_EQUAL` (value: `"LESS_OR_EQUAL"`) + + + +--- + +### Conventions + +- **Package:** `org.thingsboard.client.model` +- **Getter pattern:** `get()` — e.g., `getId()`, `getName()` +- **Setter pattern:** `set(value)` — e.g., `setId(value)`, `setName(value)` +- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions + diff --git a/pe/docs/AlarmRuleStringFilterPredicate.md b/pe/docs/AlarmRuleStringFilterPredicate.md index cfc2dbb4..9058cafc 100644 --- a/pe/docs/AlarmRuleStringFilterPredicate.md +++ b/pe/docs/AlarmRuleStringFilterPredicate.md @@ -9,9 +9,9 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **ignoreCase** | **Boolean** | | [optional] | -| **operation** | **StringOperation** | | | +| **operation** | **AlarmRuleStringOperation** | | | | **value** | **AlarmConditionValueString** | | | +| **ignoreCase** | **Boolean** | | [optional] | @@ -22,7 +22,7 @@ |------|------|-------------|-------| | type | String | | | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString diff --git a/pe/docs/AlarmRuleStringOperation.md b/pe/docs/AlarmRuleStringOperation.md new file mode 100644 index 00000000..1e24542e --- /dev/null +++ b/pe/docs/AlarmRuleStringOperation.md @@ -0,0 +1,35 @@ + +# AlarmRuleStringOperation + +`org.thingsboard.client.model.AlarmRuleStringOperation` + +## Enum Values + + +* `EQUAL` (value: `"EQUAL"`) + +* `NOT_EQUAL` (value: `"NOT_EQUAL"`) + +* `STARTS_WITH` (value: `"STARTS_WITH"`) + +* `ENDS_WITH` (value: `"ENDS_WITH"`) + +* `CONTAINS` (value: `"CONTAINS"`) + +* `NOT_CONTAINS` (value: `"NOT_CONTAINS"`) + +* `IN` (value: `"IN"`) + +* `NOT_IN` (value: `"NOT_IN"`) + + + +--- + +### Conventions + +- **Package:** `org.thingsboard.client.model` +- **Getter pattern:** `get()` — e.g., `getId()`, `getName()` +- **Setter pattern:** `set(value)` — e.g., `setId(value)`, `setName(value)` +- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions + diff --git a/pe/docs/AlarmRuleSchedule.md b/pe/docs/AlarmSchedule.md similarity index 76% rename from pe/docs/AlarmRuleSchedule.md rename to pe/docs/AlarmSchedule.md index 7f017f0f..4e3e1e41 100644 --- a/pe/docs/AlarmRuleSchedule.md +++ b/pe/docs/AlarmSchedule.md @@ -1,7 +1,7 @@ -# AlarmRuleSchedule +# AlarmSchedule -`org.thingsboard.client.model.AlarmRuleSchedule` +`org.thingsboard.client.model.AlarmSchedule` ## Properties @@ -13,32 +13,32 @@ ## Subtypes -#### AlarmRuleAnyTimeSchedule *(type=`ANY_TIME`)* +#### AnyTimeSchedule *(type=`ANY_TIME`)* *(no additional properties)* -#### AlarmRuleCustomTimeSchedule *(type=`CUSTOM`)* +#### CustomTimeSchedule *(type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | ## Referenced Types -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | --- diff --git a/pe/docs/AlarmTableComponent.md b/pe/docs/AlarmTableComponent.md index 3e6a8e6a..3edb6b68 100644 --- a/pe/docs/AlarmTableComponent.md +++ b/pe/docs/AlarmTableComponent.md @@ -55,7 +55,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### DataSource | Name | Type | Description | Notes | @@ -95,7 +95,7 @@ #### VerticalAlignment (enum) `BOTTOM` | `TOP` | `MIDDLE` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### DataSourceType (enum) diff --git a/pe/docs/AlarmRuleAnyTimeSchedule.md b/pe/docs/AnyTimeSchedule.md similarity index 80% rename from pe/docs/AlarmRuleAnyTimeSchedule.md rename to pe/docs/AnyTimeSchedule.md index bc50fe7c..f0e7e30a 100644 --- a/pe/docs/AlarmRuleAnyTimeSchedule.md +++ b/pe/docs/AnyTimeSchedule.md @@ -1,9 +1,9 @@ -# AlarmRuleAnyTimeSchedule +# AnyTimeSchedule -`org.thingsboard.client.model.AlarmRuleAnyTimeSchedule` +`org.thingsboard.client.model.AnyTimeSchedule` -**Extends:** **AlarmRuleSchedule** +**Extends:** **AlarmSchedule** ## Properties @@ -14,7 +14,7 @@ ## Referenced Types -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | diff --git a/pe/docs/AssetExportData.md b/pe/docs/AssetExportData.md index 164afc34..0e70e93a 100644 --- a/pe/docs/AssetExportData.md +++ b/pe/docs/AssetExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AssetProfileExportData.md b/pe/docs/AssetProfileExportData.md index e0e56ce6..82dd56bd 100644 --- a/pe/docs/AssetProfileExportData.md +++ b/pe/docs/AssetProfileExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/CalculatedField.md b/pe/docs/CalculatedField.md index d3bc2b2c..4634bf70 100644 --- a/pe/docs/CalculatedField.md +++ b/pe/docs/CalculatedField.md @@ -46,8 +46,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -155,11 +155,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -295,26 +295,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -345,41 +345,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -396,17 +396,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -415,46 +418,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -463,7 +463,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -472,7 +472,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/CalculatedFieldConfiguration.md b/pe/docs/CalculatedFieldConfiguration.md index 3805225c..bc14d13f 100644 --- a/pe/docs/CalculatedFieldConfiguration.md +++ b/pe/docs/CalculatedFieldConfiguration.md @@ -18,8 +18,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -108,11 +108,11 @@ | limit | Integer | | [optional] | | timeWindow | Long | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### AggMetric @@ -228,26 +228,26 @@ | type | ArgumentType | | [optional] | | scope | AttributeScope | | [optional] | -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -321,41 +321,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -372,17 +372,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -391,46 +394,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -439,7 +439,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -448,7 +448,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/CalculatedFieldInfo.md b/pe/docs/CalculatedFieldInfo.md index 693302ed..44d68547 100644 --- a/pe/docs/CalculatedFieldInfo.md +++ b/pe/docs/CalculatedFieldInfo.md @@ -47,8 +47,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -156,11 +156,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -296,26 +296,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -346,41 +346,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -397,17 +397,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -416,46 +419,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -464,7 +464,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -473,7 +473,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/ConverterExportData.md b/pe/docs/ConverterExportData.md index 8244a1f6..7b9965d8 100644 --- a/pe/docs/ConverterExportData.md +++ b/pe/docs/ConverterExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/CsvReportTemplateConfig.md b/pe/docs/CsvReportTemplateConfig.md index f4e1296c..ddc23f9c 100644 --- a/pe/docs/CsvReportTemplateConfig.md +++ b/pe/docs/CsvReportTemplateConfig.md @@ -507,7 +507,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -720,7 +720,7 @@ #### FontStyle (enum) `NORMAL` | `ITALIC` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/AlarmRuleCustomTimeSchedule.md b/pe/docs/CustomTimeSchedule.md similarity index 76% rename from pe/docs/AlarmRuleCustomTimeSchedule.md rename to pe/docs/CustomTimeSchedule.md index 9249291e..1a973a98 100644 --- a/pe/docs/AlarmRuleCustomTimeSchedule.md +++ b/pe/docs/CustomTimeSchedule.md @@ -1,33 +1,33 @@ -# AlarmRuleCustomTimeSchedule +# CustomTimeSchedule -`org.thingsboard.client.model.AlarmRuleCustomTimeSchedule` +`org.thingsboard.client.model.CustomTimeSchedule` -**Extends:** **AlarmRuleSchedule** +**Extends:** **AlarmSchedule** ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **items** | **List\** | | [optional] | | **timezone** | **String** | | [optional] | +| **items** | **List\** | | [optional] | ## Referenced Types -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | --- diff --git a/pe/docs/AlarmRuleCustomTimeScheduleItem.md b/pe/docs/CustomTimeScheduleItem.md similarity index 86% rename from pe/docs/AlarmRuleCustomTimeScheduleItem.md rename to pe/docs/CustomTimeScheduleItem.md index b7b49a92..54b09d0c 100644 --- a/pe/docs/AlarmRuleCustomTimeScheduleItem.md +++ b/pe/docs/CustomTimeScheduleItem.md @@ -1,16 +1,16 @@ -# AlarmRuleCustomTimeScheduleItem +# CustomTimeScheduleItem -`org.thingsboard.client.model.AlarmRuleCustomTimeScheduleItem` +`org.thingsboard.client.model.CustomTimeScheduleItem` ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **dayOfWeek** | **Integer** | | [optional] | | **enabled** | **Boolean** | | [optional] | -| **endsOn** | **Long** | | [optional] | +| **dayOfWeek** | **Integer** | | [optional] | | **startsOn** | **Long** | | [optional] | +| **endsOn** | **Long** | | [optional] | diff --git a/pe/docs/CustomerExportData.md b/pe/docs/CustomerExportData.md index e8684627..5305d64f 100644 --- a/pe/docs/CustomerExportData.md +++ b/pe/docs/CustomerExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/DashboardExportData.md b/pe/docs/DashboardExportData.md index 5d04d48b..99ddca1d 100644 --- a/pe/docs/DashboardExportData.md +++ b/pe/docs/DashboardExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/DeviceExportData.md b/pe/docs/DeviceExportData.md index 90ebf16d..c8c0a6c8 100644 --- a/pe/docs/DeviceExportData.md +++ b/pe/docs/DeviceExportData.md @@ -116,8 +116,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -222,11 +222,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -362,26 +362,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -412,41 +412,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -463,17 +463,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -482,46 +485,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -530,7 +530,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -539,7 +539,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/DeviceProfileExportData.md b/pe/docs/DeviceProfileExportData.md index 53de7d78..767b9d17 100644 --- a/pe/docs/DeviceProfileExportData.md +++ b/pe/docs/DeviceProfileExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleDurationCondition.md b/pe/docs/DurationAlarmCondition.md similarity index 78% rename from pe/docs/AlarmRuleDurationCondition.md rename to pe/docs/DurationAlarmCondition.md index 9157ba27..2ac6405b 100644 --- a/pe/docs/AlarmRuleDurationCondition.md +++ b/pe/docs/DurationAlarmCondition.md @@ -1,9 +1,9 @@ -# AlarmRuleDurationCondition +# DurationAlarmCondition -`org.thingsboard.client.model.AlarmRuleDurationCondition` +`org.thingsboard.client.model.DurationAlarmCondition` -**Extends:** **AlarmRuleCondition** +**Extends:** **AlarmCondition** ## Properties @@ -16,11 +16,11 @@ ## Referenced Types -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | #### TimeUnit (enum) @@ -40,53 +40,56 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -95,46 +98,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -143,7 +143,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -152,7 +152,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/EntityDataDiff.md b/pe/docs/EntityDataDiff.md index 0f4c5a73..31b0da11 100644 --- a/pe/docs/EntityDataDiff.md +++ b/pe/docs/EntityDataDiff.md @@ -173,8 +173,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -382,11 +382,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -522,26 +522,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -572,41 +572,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -623,17 +623,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -642,46 +645,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -690,7 +690,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -699,7 +699,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/EntityExportData.md b/pe/docs/EntityExportData.md index c063e684..f3291bb9 100644 --- a/pe/docs/EntityExportData.md +++ b/pe/docs/EntityExportData.md @@ -216,8 +216,8 @@ Base export container for ThingsBoard entities | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -380,11 +380,11 @@ Base export container for ThingsBoard entities | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -520,26 +520,26 @@ Base export container for ThingsBoard entities #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -570,41 +570,41 @@ Base export container for ThingsBoard entities #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -621,17 +621,20 @@ Base export container for ThingsBoard entities | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -640,46 +643,43 @@ Base export container for ThingsBoard entities #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -688,7 +688,7 @@ Base export container for ThingsBoard entities | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -697,7 +697,7 @@ Base export container for ThingsBoard entities | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/EntityGroupExportData.md b/pe/docs/EntityGroupExportData.md index 4c9f274a..5b59247a 100644 --- a/pe/docs/EntityGroupExportData.md +++ b/pe/docs/EntityGroupExportData.md @@ -125,8 +125,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -231,11 +231,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -371,26 +371,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -421,41 +421,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -472,17 +472,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -491,46 +494,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -539,7 +539,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -548,7 +548,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/EntityTableComponent.md b/pe/docs/EntityTableComponent.md index 13b22aa4..6a76269d 100644 --- a/pe/docs/EntityTableComponent.md +++ b/pe/docs/EntityTableComponent.md @@ -65,7 +65,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### ReportComponentSubType (enum) `DOUGHNUT_CHART` | `HORIZONTAL_DOUGHNUT_CHART` | `POINT_CHART` | `BAR_CHART` | `PIE_CHART` | `LINE_CHART` | `LATEST_BAR_CHART` | `RANGE_CHART` | `BAR_CHART_WITH_LABELS` | `STATE_CHART` | … (11 values total) @@ -114,7 +114,7 @@ #### VerticalAlignment (enum) `BOTTOM` | `TOP` | `MIDDLE` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### Aggregation (enum) diff --git a/pe/docs/EntityViewExportData.md b/pe/docs/EntityViewExportData.md index bca570f4..ebb4a49a 100644 --- a/pe/docs/EntityViewExportData.md +++ b/pe/docs/EntityViewExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/HeaderFooter.md b/pe/docs/HeaderFooter.md index df42c6d6..6f2e47a7 100644 --- a/pe/docs/HeaderFooter.md +++ b/pe/docs/HeaderFooter.md @@ -263,7 +263,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -453,7 +453,7 @@ #### FontStyle (enum) `NORMAL` | `ITALIC` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/IntegrationExportData.md b/pe/docs/IntegrationExportData.md index f5d6b26a..633e24c8 100644 --- a/pe/docs/IntegrationExportData.md +++ b/pe/docs/IntegrationExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleNoDataFilterPredicate.md b/pe/docs/NoDataFilterPredicate.md similarity index 91% rename from pe/docs/AlarmRuleNoDataFilterPredicate.md rename to pe/docs/NoDataFilterPredicate.md index cd14aadb..dd55136e 100644 --- a/pe/docs/AlarmRuleNoDataFilterPredicate.md +++ b/pe/docs/NoDataFilterPredicate.md @@ -1,7 +1,7 @@ -# AlarmRuleNoDataFilterPredicate +# NoDataFilterPredicate -`org.thingsboard.client.model.AlarmRuleNoDataFilterPredicate` +`org.thingsboard.client.model.NoDataFilterPredicate` **Extends:** **AlarmRuleKeyFilterPredicate** @@ -9,8 +9,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **duration** | **AlarmConditionValueLong** | | | | **unit** | **TimeUnit** | | | +| **duration** | **AlarmConditionValueLong** | | | @@ -21,15 +21,15 @@ |------|------|-------------|-------| | type | String | | | +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - --- ### Conventions diff --git a/pe/docs/NotificationRuleExportData.md b/pe/docs/NotificationRuleExportData.md index 7d06a83c..403becdb 100644 --- a/pe/docs/NotificationRuleExportData.md +++ b/pe/docs/NotificationRuleExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/NotificationTargetExportData.md b/pe/docs/NotificationTargetExportData.md index 65add531..3edb81bf 100644 --- a/pe/docs/NotificationTargetExportData.md +++ b/pe/docs/NotificationTargetExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/NotificationTemplateExportData.md b/pe/docs/NotificationTemplateExportData.md index a1df763e..569002de 100644 --- a/pe/docs/NotificationTemplateExportData.md +++ b/pe/docs/NotificationTemplateExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/OtaPackageExportData.md b/pe/docs/OtaPackageExportData.md index e17d6a6b..44f02df6 100644 --- a/pe/docs/OtaPackageExportData.md +++ b/pe/docs/OtaPackageExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/PageDataAlarmRuleDefinition.md b/pe/docs/PageDataAlarmRuleDefinition.md index 702601b9..3264d137 100644 --- a/pe/docs/PageDataAlarmRuleDefinition.md +++ b/pe/docs/PageDataAlarmRuleDefinition.md @@ -21,30 +21,267 @@ #### AlarmRuleDefinition | Name | Type | Description | Notes | |------|------|-------------|-------| +| id | CalculatedFieldId | JSON object with the Alarm Rule Id. Referencing non-existing Alarm Rule Id will cause error. | [optional] | +| createdTime | Long | Timestamp of the alarm rule creation, in milliseconds | [optional] [readonly] | +| tenantId | TenantId | | [optional] | +| entityId | EntityId | | [optional] | +| name | String | User defined name of the alarm rule. | [optional] | +| debugSettings | DebugSettings | Debug settings object. | [optional] | +| configurationVersion | Integer | Version of alarm rule configuration. | [optional] | +| _configuration | AlarmCalculatedFieldConfiguration | | | +| version | Long | | [optional] | +| additionalInfo | com.fasterxml.jackson.databind.JsonNode | Additional parameters of the alarm rule. May include: 'description' (string). | [optional] | +| debugMode | Boolean | | [optional] | + +#### DebugSettings +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| failuresEnabled | Boolean | Debug failures. | [optional] | +| allEnabled | Boolean | Debug All. Used as a trigger for updating debugAllUntil. | [optional] | +| allEnabledUntil | Long | Timestamp of the end time for the processing debug events. | [optional] | + +#### EntityType (enum) +`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) + +#### CalculatedFieldConfiguration +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| output | Output | | [optional] | +| type | String | | | + +#### AlarmCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`ALARM`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | +| propagate | Boolean | | [optional] | +| propagateToOwner | Boolean | | [optional] | +| propagateToOwnerHierarchy | Boolean | | [optional] | +| propagateToTenant | Boolean | | [optional] | +| propagateRelationTypes | List | | [optional] | + +#### EntityAggregationCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`ENTITY_AGGREGATION`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| metrics | Map | | | +| interval | AggInterval | | | +| watermark | Watermark | | [optional] | +| produceIntermediateResult | Boolean | | [optional] | + +#### GeofencingCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`GEOFENCING`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| entityCoordinates | EntityCoordinates | | | +| zoneGroups | Map | | | +| scheduledUpdateEnabled | Boolean | | [optional] | +| scheduledUpdateInterval | Integer | | [optional] | + +#### PropagationCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`PROPAGATION`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| expression | String | | [optional] | +| relation | RelationPathLevel | | | +| applyExpressionToResolvedArguments | Boolean | | [optional] | + +#### RelatedEntitiesAggregationCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`RELATED_ENTITIES_AGGREGATION`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| relation | RelationPathLevel | | | +| arguments | Map | | | +| deduplicationIntervalInSec | Long | | [optional] | +| metrics | Map | | | +| useLatestTs | Boolean | | [optional] | +| scheduledUpdateInterval | Integer | | [optional] | +| scheduledUpdateEnabled | Boolean | | [optional] | + +#### ScriptCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`SCRIPT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| expression | String | | [optional] | + +#### SimpleCalculatedFieldConfiguration *(extends CalculatedFieldConfiguration, type=`SIMPLE`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| arguments | Map | | | +| expression | String | | [optional] | +| useLatestTs | Boolean | | [optional] | + +#### 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] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | -#### AlarmRuleCondition +#### Output +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| name | String | | [optional] | +| scope | AttributeScope | | [optional] | +| decimalsByDefault | Integer | | [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 | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* + +#### AttributeScope (enum) +`CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE` + +#### EntityCoordinates +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| latitudeKeyName | String | | | +| longitudeKeyName | String | | | + +#### ZoneGroupConfiguration +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| refEntityId | EntityId | | [optional] | +| refDynamicSourceConfiguration | CfArgumentDynamicSourceConfiguration | | [optional] | +| perimeterKeyName | String | | | +| reportStrategy | GeofencingReportStrategy | | | +| createRelationsWithMatchedZones | Boolean | | [optional] | +| relationType | String | | [optional] | +| direction | EntitySearchDirection | | [optional] | + +#### RelationPathLevel +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| direction | EntitySearchDirection | | | +| relationType | String | | | + +#### AggMetric +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| function | AggFunction | | [optional] | +| filter | String | | [optional] | +| input | AggInput | | [optional] | +| defaultValue | Double | | [optional] | + +#### AggInterval +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| type | String | | | + +#### CustomInterval *(extends AggInterval, type=`CUSTOM`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | +| durationSec | Long | | | + +#### DayInterval *(extends AggInterval, type=`DAY`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### HourInterval *(extends AggInterval, type=`HOUR`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### MonthInterval *(extends AggInterval, type=`MONTH`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### QuarterInterval *(extends AggInterval, type=`QUARTER`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### WeekInterval *(extends AggInterval, type=`WEEK`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### WeekSunSatInterval *(extends AggInterval, type=`WEEK_SUN_SAT`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### YearInterval *(extends AggInterval, type=`YEAR`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| tz | String | | | +| offsetSec | Long | | [optional] | + +#### Watermark +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| duration | Long | | [optional] | + +#### ArgumentType (enum) +`TS_LATEST` | `ATTRIBUTE` | `TS_ROLLING` #### AlarmConditionExpression | Name | Type | Description | Notes | @@ -54,41 +291,99 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### TimeSeriesOutputStrategy | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### 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.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### 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.* + +#### GeofencingReportStrategy (enum) +`REPORT_TRANSITION_EVENTS_ONLY` | `REPORT_PRESENCE_STATUS_ONLY` | `REPORT_TRANSITION_EVENTS_AND_PRESENCE_STATUS` + +#### EntitySearchDirection (enum) +`FROM` | `TO` + +#### AggFunction (enum) +`MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` + +#### AggInput +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| type | String | | | + +#### AggFunctionInput *(extends AggInput, type=`function`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| function | String | | [optional] | + +#### AggKeyInput *(extends AggInput, type=`key`)* +| Name | Type | Description | Notes | +|------|------|-------------|-------| +| key | String | | [optional] | + +#### 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 | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -105,20 +400,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### EntityType (enum) -`TENANT` | `CUSTOMER` | `USER` | `DASHBOARD` | `ASSET` | `DEVICE` | `ALARM` | `ENTITY_GROUP` | `CONVERTER` | `INTEGRATION` | … (46 values total) - -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -127,46 +422,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -175,7 +467,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -184,7 +476,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/PageDataAlarmRuleDefinitionInfo.md b/pe/docs/PageDataAlarmRuleDefinitionInfo.md index c60e91b6..9415dbfa 100644 --- a/pe/docs/PageDataAlarmRuleDefinitionInfo.md +++ b/pe/docs/PageDataAlarmRuleDefinitionInfo.md @@ -54,8 +54,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -121,11 +121,11 @@ | limit | Integer | | [optional] | | timeWindow | Long | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### Output @@ -167,26 +167,26 @@ | type | ArgumentType | | [optional] | | scope | AttributeScope | | [optional] | -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AttributeScope (enum) `CLIENT_SCOPE` | `SERVER_SCOPE` | `SHARED_SCOPE` @@ -292,19 +292,19 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | #### TimeSeriesOutputStrategy | Name | Type | Description | Notes | @@ -364,27 +364,27 @@ |------|------|-------------|-------| | key | String | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -401,17 +401,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -420,46 +423,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -468,7 +468,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -477,7 +477,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/PageDataCalculatedField.md b/pe/docs/PageDataCalculatedField.md index 5caad691..fcf4b88e 100644 --- a/pe/docs/PageDataCalculatedField.md +++ b/pe/docs/PageDataCalculatedField.md @@ -54,8 +54,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -163,11 +163,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -303,26 +303,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -353,41 +353,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -404,17 +404,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -423,46 +426,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -471,7 +471,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -480,7 +480,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/PageDataCalculatedFieldInfo.md b/pe/docs/PageDataCalculatedFieldInfo.md index 1641dae0..b329d839 100644 --- a/pe/docs/PageDataCalculatedFieldInfo.md +++ b/pe/docs/PageDataCalculatedFieldInfo.md @@ -55,8 +55,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -164,11 +164,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -304,26 +304,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -354,41 +354,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -405,17 +405,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -424,46 +427,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -472,7 +472,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -481,7 +481,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/PdfReportTemplateConfig.md b/pe/docs/PdfReportTemplateConfig.md index 1ca8c49a..dad00f94 100644 --- a/pe/docs/PdfReportTemplateConfig.md +++ b/pe/docs/PdfReportTemplateConfig.md @@ -526,7 +526,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -739,7 +739,7 @@ #### FontStyle (enum) `NORMAL` | `ITALIC` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/AlarmRuleRepeatingCondition.md b/pe/docs/RepeatingAlarmCondition.md similarity index 78% rename from pe/docs/AlarmRuleRepeatingCondition.md rename to pe/docs/RepeatingAlarmCondition.md index e97c1ac2..1ef4a882 100644 --- a/pe/docs/AlarmRuleRepeatingCondition.md +++ b/pe/docs/RepeatingAlarmCondition.md @@ -1,9 +1,9 @@ -# AlarmRuleRepeatingCondition +# RepeatingAlarmCondition -`org.thingsboard.client.model.AlarmRuleRepeatingCondition` +`org.thingsboard.client.model.RepeatingAlarmCondition` -**Extends:** **AlarmRuleCondition** +**Extends:** **AlarmCondition** ## Properties @@ -15,11 +15,11 @@ ## Referenced Types -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | #### AlarmConditionValueInteger @@ -36,53 +36,56 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -91,46 +94,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -139,7 +139,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -148,7 +148,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean @@ -157,15 +157,15 @@ | staticValue | Boolean | | [optional] | | dynamicValueArgument | String | | [optional] | +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - --- ### Conventions diff --git a/pe/docs/ReportComponent.md b/pe/docs/ReportComponent.md index 346c508e..6588f938 100644 --- a/pe/docs/ReportComponent.md +++ b/pe/docs/ReportComponent.md @@ -233,7 +233,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### DataSource | Name | Type | Description | Notes | @@ -415,7 +415,7 @@ | rangeUnits | String | | [optional] | | rangeDecimals | Integer | | [optional] | -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### DataSourceType (enum) diff --git a/pe/docs/ReportRequest.md b/pe/docs/ReportRequest.md index e84d0a31..fe63dc53 100644 --- a/pe/docs/ReportRequest.md +++ b/pe/docs/ReportRequest.md @@ -541,7 +541,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -751,7 +751,7 @@ #### FontStyle (enum) `NORMAL` | `ITALIC` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/ReportTemplate.md b/pe/docs/ReportTemplate.md index e2474038..054a6f25 100644 --- a/pe/docs/ReportTemplate.md +++ b/pe/docs/ReportTemplate.md @@ -550,7 +550,7 @@ A JSON value representing the Report Template. | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -760,7 +760,7 @@ A JSON value representing the Report Template. #### FontStyle (enum) `NORMAL` | `ITALIC` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/ReportTemplateConfig.md b/pe/docs/ReportTemplateConfig.md index 7efb57b6..fd6c49f6 100644 --- a/pe/docs/ReportTemplateConfig.md +++ b/pe/docs/ReportTemplateConfig.md @@ -529,7 +529,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -742,7 +742,7 @@ #### FontStyle (enum) `NORMAL` | `ITALIC` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/ReportTemplateExportData.md b/pe/docs/ReportTemplateExportData.md index eb36fd2b..6891a623 100644 --- a/pe/docs/ReportTemplateExportData.md +++ b/pe/docs/ReportTemplateExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/RoleExportData.md b/pe/docs/RoleExportData.md index 45782a13..a8f25c0e 100644 --- a/pe/docs/RoleExportData.md +++ b/pe/docs/RoleExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/RuleChainExportData.md b/pe/docs/RuleChainExportData.md index 3787934e..8637d6e0 100644 --- a/pe/docs/RuleChainExportData.md +++ b/pe/docs/RuleChainExportData.md @@ -155,8 +155,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -261,11 +261,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -401,26 +401,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -451,41 +451,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -502,17 +502,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -521,46 +524,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -569,7 +569,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -578,7 +578,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/SchedulerEventExportData.md b/pe/docs/SchedulerEventExportData.md index b5dbc17d..cf62babb 100644 --- a/pe/docs/SchedulerEventExportData.md +++ b/pe/docs/SchedulerEventExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleSimpleCondition.md b/pe/docs/SimpleAlarmCondition.md similarity index 78% rename from pe/docs/AlarmRuleSimpleCondition.md rename to pe/docs/SimpleAlarmCondition.md index 91b822cb..a1d713b2 100644 --- a/pe/docs/AlarmRuleSimpleCondition.md +++ b/pe/docs/SimpleAlarmCondition.md @@ -1,9 +1,9 @@ -# AlarmRuleSimpleCondition +# SimpleAlarmCondition -`org.thingsboard.client.model.AlarmRuleSimpleCondition` +`org.thingsboard.client.model.SimpleAlarmCondition` -**Extends:** **AlarmRuleCondition** +**Extends:** **AlarmCondition** ## Properties @@ -14,11 +14,11 @@ ## Referenced Types -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | #### AlarmConditionExpression @@ -29,53 +29,56 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -84,46 +87,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -132,7 +132,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -141,7 +141,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean @@ -150,15 +150,15 @@ | staticValue | Boolean | | [optional] | | dynamicValueArgument | String | | [optional] | +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - --- ### Conventions diff --git a/pe/docs/SimpleAlarmConditionExpression.md b/pe/docs/SimpleAlarmConditionExpression.md index 8c450201..3f59cb1a 100644 --- a/pe/docs/SimpleAlarmConditionExpression.md +++ b/pe/docs/SimpleAlarmConditionExpression.md @@ -9,8 +9,8 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| -| **filters** | **List\** | | | -| **operation** | **ComplexOperation** | | [optional] | +| **filters** | **List\** | | | +| **operation** | **AlarmRuleComplexOperation** | | [optional] | @@ -21,17 +21,20 @@ |------|------|-------------|-------| | type | String | | | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -40,38 +43,35 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -80,7 +80,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -89,7 +89,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean @@ -98,15 +98,15 @@ | staticValue | Boolean | | [optional] | | dynamicValueArgument | String | | [optional] | +#### TimeUnit (enum) +`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` + #### AlarmConditionValueLong | Name | Type | Description | Notes | |------|------|-------------|-------| | staticValue | Long | | [optional] | | dynamicValueArgument | String | | [optional] | -#### TimeUnit (enum) -`NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` - --- ### Conventions diff --git a/pe/docs/SolutionData.md b/pe/docs/SolutionData.md index 8a6e8720..eb5851f6 100644 --- a/pe/docs/SolutionData.md +++ b/pe/docs/SolutionData.md @@ -174,8 +174,8 @@ Portable solution package containing exported entities grouped by type. Represen | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -383,11 +383,11 @@ Portable solution package containing exported entities grouped by type. Represen | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -523,26 +523,26 @@ Portable solution package containing exported entities grouped by type. Represen #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -573,41 +573,41 @@ Portable solution package containing exported entities grouped by type. Represen #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -624,17 +624,20 @@ Portable solution package containing exported entities grouped by type. Represen | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -643,46 +646,43 @@ Portable solution package containing exported entities grouped by type. Represen #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -691,7 +691,7 @@ Portable solution package containing exported entities grouped by type. Represen | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -700,7 +700,7 @@ Portable solution package containing exported entities grouped by type. Represen | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/SolutionExportResponse.md b/pe/docs/SolutionExportResponse.md index 364387de..081393c6 100644 --- a/pe/docs/SolutionExportResponse.md +++ b/pe/docs/SolutionExportResponse.md @@ -180,8 +180,8 @@ Solution export response containing the exported solution data and any dependenc | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -389,11 +389,11 @@ Solution export response containing the exported solution data and any dependenc | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -529,26 +529,26 @@ Solution export response containing the exported solution data and any dependenc #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -579,41 +579,41 @@ Solution export response containing the exported solution data and any dependenc #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -630,17 +630,20 @@ Solution export response containing the exported solution data and any dependenc | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -649,46 +652,43 @@ Solution export response containing the exported solution data and any dependenc #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -697,7 +697,7 @@ Solution export response containing the exported solution data and any dependenc | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -706,7 +706,7 @@ Solution export response containing the exported solution data and any dependenc | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/AlarmRuleSpecificTimeSchedule.md b/pe/docs/SpecificTimeSchedule.md similarity index 83% rename from pe/docs/AlarmRuleSpecificTimeSchedule.md rename to pe/docs/SpecificTimeSchedule.md index c54e4d20..534762f1 100644 --- a/pe/docs/AlarmRuleSpecificTimeSchedule.md +++ b/pe/docs/SpecificTimeSchedule.md @@ -1,24 +1,24 @@ -# AlarmRuleSpecificTimeSchedule +# SpecificTimeSchedule -`org.thingsboard.client.model.AlarmRuleSpecificTimeSchedule` +`org.thingsboard.client.model.SpecificTimeSchedule` -**Extends:** **AlarmRuleSchedule** +**Extends:** **AlarmSchedule** ## Properties | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| +| **timezone** | **String** | | [optional] | | **daysOfWeek** | **Set\** | | [optional] | -| **endsOn** | **Long** | | [optional] | | **startsOn** | **Long** | | [optional] | -| **timezone** | **String** | | [optional] | +| **endsOn** | **Long** | | [optional] | ## Referenced Types -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | diff --git a/pe/docs/TableSortDirection.md b/pe/docs/TableSortDirection.md new file mode 100644 index 00000000..116d41fb --- /dev/null +++ b/pe/docs/TableSortDirection.md @@ -0,0 +1,23 @@ + +# TableSortDirection + +`org.thingsboard.client.model.TableSortDirection` + +## Enum Values + + +* `ASC` (value: `"ASC"`) + +* `DESC` (value: `"DESC"`) + + + +--- + +### Conventions + +- **Package:** `org.thingsboard.client.model` +- **Getter pattern:** `get()` — e.g., `getId()`, `getName()` +- **Setter pattern:** `set(value)` — e.g., `setId(value)`, `setName(value)` +- **Null fields:** Getters return `null` for unset optional fields; they do not throw exceptions + diff --git a/pe/docs/TableSortOrder.md b/pe/docs/TableSortOrder.md index 749c9c28..0709440a 100644 --- a/pe/docs/TableSortOrder.md +++ b/pe/docs/TableSortOrder.md @@ -8,13 +8,13 @@ | Name | Type | Description | Notes | |------------ | ------------- | ------------- | -------------| | **column** | **String** | | [optional] | -| **direction** | **Direction** | | [optional] | +| **direction** | **TableSortDirection** | | [optional] | ## Referenced Types -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` --- diff --git a/pe/docs/TbResourceExportData.md b/pe/docs/TbResourceExportData.md index 41dfb7d6..c6a9bc81 100644 --- a/pe/docs/TbResourceExportData.md +++ b/pe/docs/TbResourceExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/TimeseriesTableComponent.md b/pe/docs/TimeseriesTableComponent.md index f529743c..21dec263 100644 --- a/pe/docs/TimeseriesTableComponent.md +++ b/pe/docs/TimeseriesTableComponent.md @@ -70,7 +70,7 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | column | String | | [optional] | -| direction | Direction | | [optional] | +| direction | TableSortDirection | | [optional] | #### TimeWindowConfiguration | Name | Type | Description | Notes | @@ -126,7 +126,7 @@ #### VerticalAlignment (enum) `BOTTOM` | `TOP` | `MIDDLE` -#### Direction (enum) +#### TableSortDirection (enum) `ASC` | `DESC` #### History diff --git a/pe/docs/WidgetTypeExportData.md b/pe/docs/WidgetTypeExportData.md index aa0e8a0f..15d2e65c 100644 --- a/pe/docs/WidgetTypeExportData.md +++ b/pe/docs/WidgetTypeExportData.md @@ -96,8 +96,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -202,11 +202,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -342,26 +342,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -392,41 +392,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -443,17 +443,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -462,46 +465,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -510,7 +510,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -519,7 +519,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/docs/WidgetsBundleExportData.md b/pe/docs/WidgetsBundleExportData.md index 3bbb8bbc..55204d61 100644 --- a/pe/docs/WidgetsBundleExportData.md +++ b/pe/docs/WidgetsBundleExportData.md @@ -98,8 +98,8 @@ | Name | Type | Description | Notes | |------|------|-------------|-------| | arguments | Map | | | -| createRules | Map | | | -| clearRule | AlarmRuleDefinition | | [optional] | +| createRules | Map | | | +| clearRule | AlarmRule | | [optional] | | propagate | Boolean | | [optional] | | propagateToOwner | Boolean | | [optional] | | propagateToOwnerHierarchy | Boolean | | [optional] | @@ -204,11 +204,11 @@ | relationType | String | | [optional] | | direction | EntitySearchDirection | | [optional] | -#### AlarmRuleDefinition +#### AlarmRule | Name | Type | Description | Notes | |------|------|-------------|-------| +| condition | AlarmCondition | | | | alarmDetails | String | | [optional] | -| condition | AlarmRuleCondition | | | | dashboardId | DashboardId | | [optional] | #### RelationPathLevel @@ -344,26 +344,26 @@ #### EntitySearchDirection (enum) `FROM` | `TO` -#### AlarmRuleCondition +#### AlarmCondition | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | AlarmConditionExpression | | | -| schedule | AlarmConditionValueAlarmRuleSchedule | | [optional] | +| schedule | AlarmConditionValueAlarmSchedule | | [optional] | | type | String | | | -#### AlarmRuleDurationCondition *(extends AlarmRuleCondition, type=`DURATION`)* +#### DurationAlarmCondition *(extends AlarmCondition, type=`DURATION`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | unit | TimeUnit | | | | value | AlarmConditionValueLong | | | -#### AlarmRuleRepeatingCondition *(extends AlarmRuleCondition, type=`REPEATING`)* +#### RepeatingAlarmCondition *(extends AlarmCondition, type=`REPEATING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | count | AlarmConditionValueInteger | | | -#### AlarmRuleSimpleCondition *(extends AlarmRuleCondition, type=`SIMPLE`)* -*See AlarmRuleCondition for properties.* +#### SimpleAlarmCondition *(extends AlarmCondition, type=`SIMPLE`)* +*See AlarmCondition for properties.* #### AggFunction (enum) `MIN` | `MAX` | `SUM` | `AVG` | `COUNT` | `COUNT_UNIQUE` @@ -394,41 +394,41 @@ #### SimpleAlarmConditionExpression *(extends AlarmConditionExpression, type=`SIMPLE`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| filters | List | | | -| operation | ComplexOperation | | [optional] | +| filters | List | | | +| operation | AlarmRuleComplexOperation | | [optional] | #### TbelAlarmConditionExpression *(extends AlarmConditionExpression, type=`TBEL`)* | Name | Type | Description | Notes | |------|------|-------------|-------| | expression | String | | | -#### AlarmConditionValueAlarmRuleSchedule +#### AlarmConditionValueAlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| +| staticValue | AlarmSchedule | | [optional] | | dynamicValueArgument | String | | [optional] | -| staticValue | AlarmRuleSchedule | | [optional] | -#### AlarmRuleSchedule +#### AlarmSchedule | Name | Type | Description | Notes | |------|------|-------------|-------| | type | String | | | -#### AlarmRuleAnyTimeSchedule *(extends AlarmRuleSchedule, type=`ANY_TIME`)* -*See AlarmRuleSchedule for properties.* +#### AnyTimeSchedule *(extends AlarmSchedule, type=`ANY_TIME`)* +*See AlarmSchedule for properties.* -#### AlarmRuleCustomTimeSchedule *(extends AlarmRuleSchedule, type=`CUSTOM`)* +#### CustomTimeSchedule *(extends AlarmSchedule, type=`CUSTOM`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| items | List | | [optional] | | timezone | String | | [optional] | +| items | List | | [optional] | -#### AlarmRuleSpecificTimeSchedule *(extends AlarmRuleSchedule, type=`SPECIFIC_TIME`)* +#### SpecificTimeSchedule *(extends AlarmSchedule, type=`SPECIFIC_TIME`)* | Name | Type | Description | Notes | |------|------|-------------|-------| +| timezone | String | | [optional] | | daysOfWeek | Set | | [optional] | -| endsOn | Long | | [optional] | | startsOn | Long | | [optional] | -| timezone | String | | [optional] | +| endsOn | Long | | [optional] | #### TimeUnit (enum) `NANOSECONDS` | `MICROSECONDS` | `MILLISECONDS` | `SECONDS` | `MINUTES` | `HOURS` | `DAYS` @@ -445,17 +445,20 @@ | staticValue | Integer | | [optional] | | dynamicValueArgument | String | | [optional] | -#### AlarmRuleConditionFilter +#### AlarmConditionFilter | Name | Type | Description | Notes | |------|------|-------------|-------| | argument | String | | | -| operation | ComplexOperation | | [optional] | -| predicates | List | | | | valueType | EntityKeyValueType | | | +| operation | AlarmRuleComplexOperation | | [optional] | +| predicates | List | | | -#### ComplexOperation (enum) +#### AlarmRuleComplexOperation (enum) `AND` | `OR` +#### EntityKeyValueType (enum) +`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` + #### AlarmRuleKeyFilterPredicate | Name | Type | Description | Notes | |------|------|-------------|-------| @@ -464,46 +467,43 @@ #### AlarmRuleBooleanFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`BOOLEAN`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | BooleanOperation | | | +| operation | AlarmRuleBooleanOperation | | | | value | AlarmConditionValueBoolean | | | #### AlarmRuleComplexFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`COMPLEX`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | ComplexOperation | | [optional] | +| operation | AlarmRuleComplexOperation | | [optional] | | predicates | List | | [optional] | -#### AlarmRuleNoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* +#### NoDataFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NO_DATA`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| duration | AlarmConditionValueLong | | | | unit | TimeUnit | | | +| duration | AlarmConditionValueLong | | | #### AlarmRuleNumericFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`NUMERIC`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| operation | NumericOperation | | | +| operation | AlarmRuleNumericOperation | | | | value | AlarmConditionValueDouble | | | #### AlarmRuleStringFilterPredicate *(extends AlarmRuleKeyFilterPredicate, type=`STRING`)* | Name | Type | Description | Notes | |------|------|-------------|-------| -| ignoreCase | Boolean | | [optional] | -| operation | StringOperation | | | +| operation | AlarmRuleStringOperation | | | | value | AlarmConditionValueString | | | +| ignoreCase | Boolean | | [optional] | -#### EntityKeyValueType (enum) -`STRING` | `NUMERIC` | `BOOLEAN` | `DATE_TIME` - -#### AlarmRuleCustomTimeScheduleItem +#### CustomTimeScheduleItem | Name | Type | Description | Notes | |------|------|-------------|-------| -| dayOfWeek | Integer | | [optional] | | enabled | Boolean | | [optional] | -| endsOn | Long | | [optional] | +| dayOfWeek | Integer | | [optional] | | startsOn | Long | | [optional] | +| endsOn | Long | | [optional] | -#### StringOperation (enum) +#### AlarmRuleStringOperation (enum) `EQUAL` | `NOT_EQUAL` | `STARTS_WITH` | `ENDS_WITH` | `CONTAINS` | `NOT_CONTAINS` | `IN` | `NOT_IN` #### AlarmConditionValueString @@ -512,7 +512,7 @@ | staticValue | String | | [optional] | | dynamicValueArgument | String | | [optional] | -#### NumericOperation (enum) +#### AlarmRuleNumericOperation (enum) `EQUAL` | `NOT_EQUAL` | `GREATER` | `LESS` | `GREATER_OR_EQUAL` | `LESS_OR_EQUAL` #### AlarmConditionValueDouble @@ -521,7 +521,7 @@ | staticValue | Double | | [optional] | | dynamicValueArgument | String | | [optional] | -#### BooleanOperation (enum) +#### AlarmRuleBooleanOperation (enum) `EQUAL` | `NOT_EQUAL` #### AlarmConditionValueBoolean diff --git a/pe/spec/openapi.json b/pe/spec/openapi.json index ddc676f1..8774ffb7 100644 --- a/pe/spec/openapi.json +++ b/pe/spec/openapi.json @@ -64103,27 +64103,6 @@ } } }, - "400": { - "description": "Bad Request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ThingsboardErrorResponse" - }, - "examples": { - "error-code-400": { - "summary": "Bad Request", - "value": { - "status": 400, - "message": "Invalid request body", - "errorCode": 31, - "timestamp": 1609459200000 - } - } - } - } - } - }, "401": { "description": "Unauthorized", "content": { @@ -64198,6 +64177,27 @@ } } }, + "400": { + "description": "Bad Request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ThingsboardErrorResponse" + }, + "examples": { + "error-code-400": { + "summary": "Bad Request", + "value": { + "status": 400, + "message": "Invalid request body", + "errorCode": 31, + "timestamp": 1609459200000 + } + } + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -80481,6 +80481,26 @@ } } }, + "413": { + "description": "Request payload is too large", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "504": { + "description": "Timeout to process the RPC call. Most likely, device is offline.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -80523,16 +80543,6 @@ } } }, - "413": { - "description": "Request payload is too large", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, "429": { "description": "Too Many Requests", "content": { @@ -80553,16 +80563,6 @@ } } } - }, - "504": { - "description": "Timeout to process the RPC call. Most likely, device is offline.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -81140,6 +81140,26 @@ } } }, + "413": { + "description": "Request payload is too large", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, + "504": { + "description": "Timeout to process the RPC call. Most likely, device is offline.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -81182,16 +81202,6 @@ } } }, - "413": { - "description": "Request payload is too large", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } - }, "429": { "description": "Too Many Requests", "content": { @@ -81212,16 +81222,6 @@ } } } - }, - "504": { - "description": "Timeout to process the RPC call. Most likely, device is offline.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -95446,6 +95446,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -95508,16 +95518,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about device attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -95612,6 +95612,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about device attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -95674,16 +95684,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about device attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -95779,6 +95779,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -95841,16 +95851,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -96480,6 +96480,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series removal with action type 'TIMESERIES_DELETED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -96542,16 +96552,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series removal with action type 'TIMESERIES_DELETED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -96646,6 +96646,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -96708,16 +96718,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -96822,6 +96822,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -96884,16 +96894,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity time series updates with action type 'TIMESERIES_UPDATED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -98006,6 +98006,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -98068,16 +98078,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes updates with action type 'ATTRIBUTES_UPDATED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -98181,6 +98181,16 @@ } } }, + "500": { + "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace.", + "content": { + "application/json": { + "schema": { + "type": "string" + } + } + } + }, "403": { "description": "Forbidden", "content": { @@ -98243,16 +98253,6 @@ } } } - }, - "500": { - "description": "The exception was thrown during processing the request. Platform creates an audit log event about entity attributes removal with action type 'ATTRIBUTES_DELETED' that includes an error stacktrace.", - "content": { - "application/json": { - "schema": { - "type": "string" - } - } - } } }, "security": [ @@ -116222,12 +116222,12 @@ "createRules": { "type": "object", "additionalProperties": { - "$ref": "#/components/schemas/AlarmRuleDefinition" + "$ref": "#/components/schemas/AlarmRule" }, "minProperties": 1 }, "clearRule": { - "$ref": "#/components/schemas/AlarmRuleDefinition" + "$ref": "#/components/schemas/AlarmRule" }, "propagate": { "type": "boolean" @@ -116435,6 +116435,32 @@ "OTHER" ] }, + "AlarmCondition": { + "type": "object", + "discriminator": { + "propertyName": "type", + "mapping": { + "SIMPLE": "#/components/schemas/SimpleAlarmCondition", + "DURATION": "#/components/schemas/DurationAlarmCondition", + "REPEATING": "#/components/schemas/RepeatingAlarmCondition" + } + }, + "properties": { + "expression": { + "$ref": "#/components/schemas/AlarmConditionExpression" + }, + "schedule": { + "$ref": "#/components/schemas/AlarmConditionValueAlarmSchedule" + }, + "type": { + "type": "string" + } + }, + "required": [ + "expression", + "type" + ] + }, "AlarmConditionExpression": { "discriminator": { "propertyName": "type", @@ -116452,14 +116478,41 @@ "type" ] }, - "AlarmConditionValueAlarmRuleSchedule": { + "AlarmConditionFilter": { "type": "object", "properties": { - "dynamicValueArgument": { - "type": "string" + "argument": { + "type": "string", + "minLength": 1 + }, + "valueType": { + "$ref": "#/components/schemas/EntityKeyValueType" }, + "operation": { + "$ref": "#/components/schemas/AlarmRuleComplexOperation" + }, + "predicates": { + "type": "array", + "items": { + "$ref": "#/components/schemas/AlarmRuleKeyFilterPredicate" + }, + "minItems": 1 + } + }, + "required": [ + "argument", + "predicates", + "valueType" + ] + }, + "AlarmConditionValueAlarmSchedule": { + "type": "object", + "properties": { "staticValue": { - "$ref": "#/components/schemas/AlarmRuleSchedule" + "$ref": "#/components/schemas/AlarmSchedule" + }, + "dynamicValueArgument": { + "type": "string" } } }, @@ -117068,11 +117121,21 @@ "notifyOn" ] }, - "AlarmRuleAnyTimeSchedule": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleSchedule" + "AlarmRule": { + "type": "object", + "properties": { + "condition": { + "$ref": "#/components/schemas/AlarmCondition" + }, + "alarmDetails": { + "type": "string" + }, + "dashboardId": { + "$ref": "#/components/schemas/DashboardId" } + }, + "required": [ + "condition" ] }, "AlarmRuleBooleanFilterPredicate": { @@ -117084,7 +117147,7 @@ "type": "object", "properties": { "operation": { - "$ref": "#/components/schemas/BooleanOperation" + "$ref": "#/components/schemas/AlarmRuleBooleanOperation" }, "value": { "$ref": "#/components/schemas/AlarmConditionValueBoolean" @@ -117097,6 +117160,13 @@ "value" ] }, + "AlarmRuleBooleanOperation": { + "type": "string", + "enum": [ + "EQUAL", + "NOT_EQUAL" + ] + }, "AlarmRuleComplexFilterPredicate": { "allOf": [ { @@ -117106,7 +117176,7 @@ "type": "object", "properties": { "operation": { - "$ref": "#/components/schemas/ComplexOperation" + "$ref": "#/components/schemas/AlarmRuleComplexOperation" }, "predicates": { "type": "array", @@ -117118,115 +117188,69 @@ } ] }, - "AlarmRuleCondition": { - "type": "object", - "discriminator": { - "propertyName": "type", - "mapping": { - "SIMPLE": "#/components/schemas/AlarmRuleSimpleCondition", - "DURATION": "#/components/schemas/AlarmRuleDurationCondition", - "REPEATING": "#/components/schemas/AlarmRuleRepeatingCondition" - } - }, - "properties": { - "expression": { - "$ref": "#/components/schemas/AlarmConditionExpression" - }, - "schedule": { - "$ref": "#/components/schemas/AlarmConditionValueAlarmRuleSchedule" - }, - "type": { - "type": "string" - } - }, - "required": [ - "expression", - "type" + "AlarmRuleComplexOperation": { + "type": "string", + "enum": [ + "AND", + "OR" ] }, - "AlarmRuleConditionFilter": { + "AlarmRuleDefinition": { "type": "object", "properties": { - "argument": { - "type": "string", - "minLength": 1 + "id": { + "$ref": "#/components/schemas/CalculatedFieldId", + "description": "JSON object with the Alarm Rule Id. Referencing non-existing Alarm Rule Id will cause error." }, - "operation": { - "$ref": "#/components/schemas/ComplexOperation" + "createdTime": { + "type": "integer", + "format": "int64", + "description": "Timestamp of the alarm rule creation, in milliseconds", + "example": 1609459200000, + "readOnly": true }, - "predicates": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlarmRuleKeyFilterPredicate" - }, - "minItems": 1 + "tenantId": { + "$ref": "#/components/schemas/TenantId" }, - "valueType": { - "$ref": "#/components/schemas/EntityKeyValueType" - } - }, - "required": [ - "argument", - "predicates", - "valueType" - ] - }, - "AlarmRuleCustomTimeSchedule": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleSchedule" + "entityId": { + "$ref": "#/components/schemas/EntityId" }, - { - "type": "object", - "properties": { - "items": { - "type": "array", - "items": { - "$ref": "#/components/schemas/AlarmRuleCustomTimeScheduleItem" - } - }, - "timezone": { - "type": "string" - } - } - } - ] - }, - "AlarmRuleCustomTimeScheduleItem": { - "type": "object", - "properties": { - "dayOfWeek": { - "type": "integer", - "format": "int32" + "name": { + "type": "string", + "description": "User defined name of the alarm rule." }, - "enabled": { - "type": "boolean" + "debugSettings": { + "$ref": "#/components/schemas/DebugSettings", + "description": "Debug settings object." }, - "endsOn": { + "configurationVersion": { "type": "integer", - "format": "int64" + "format": "int32", + "description": "Version of alarm rule configuration.", + "example": 0 }, - "startsOn": { + "configuration": { + "$ref": "#/components/schemas/AlarmCalculatedFieldConfiguration" + }, + "version": { "type": "integer", "format": "int64" - } - } - }, - "AlarmRuleDefinition": { - "type": "object", - "properties": { - "alarmDetails": { - "type": "string" }, - "condition": { - "$ref": "#/components/schemas/AlarmRuleCondition" + "additionalInfo": { + "$ref": "#/components/schemas/JsonNode", + "description": "Additional parameters of the alarm rule. May include: 'description' (string).", + "example": { + "description": "High temperature alarm rule" + } }, - "dashboardId": { - "$ref": "#/components/schemas/DashboardId" + "debugMode": { + "type": "boolean", + "deprecated": true, + "writeOnly": true } }, "required": [ - "condition" + "configuration" ] }, "AlarmRuleDefinitionInfo": { @@ -117290,28 +117314,6 @@ "configuration" ] }, - "AlarmRuleDurationCondition": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleCondition" - }, - { - "type": "object", - "properties": { - "unit": { - "$ref": "#/components/schemas/TimeUnit" - }, - "value": { - "$ref": "#/components/schemas/AlarmConditionValueLong" - } - } - } - ], - "required": [ - "unit", - "value" - ] - }, "AlarmRuleKeyFilterPredicate": { "description": "Filter predicate for alarm rule key-based filtering", "discriminator": { @@ -117320,7 +117322,7 @@ "STRING": "#/components/schemas/AlarmRuleStringFilterPredicate", "NUMERIC": "#/components/schemas/AlarmRuleNumericFilterPredicate", "BOOLEAN": "#/components/schemas/AlarmRuleBooleanFilterPredicate", - "NO_DATA": "#/components/schemas/AlarmRuleNoDataFilterPredicate", + "NO_DATA": "#/components/schemas/NoDataFilterPredicate", "COMPLEX": "#/components/schemas/AlarmRuleComplexFilterPredicate" } }, @@ -117333,7 +117335,7 @@ "type" ] }, - "AlarmRuleNoDataFilterPredicate": { + "AlarmRuleNumericFilterPredicate": { "allOf": [ { "$ref": "#/components/schemas/AlarmRuleKeyFilterPredicate" @@ -117341,21 +117343,32 @@ { "type": "object", "properties": { - "duration": { - "$ref": "#/components/schemas/AlarmConditionValueLong" + "operation": { + "$ref": "#/components/schemas/AlarmRuleNumericOperation" }, - "unit": { - "$ref": "#/components/schemas/TimeUnit" + "value": { + "$ref": "#/components/schemas/AlarmConditionValueDouble" } } } ], "required": [ - "duration", - "unit" + "operation", + "value" ] }, - "AlarmRuleNumericFilterPredicate": { + "AlarmRuleNumericOperation": { + "type": "string", + "enum": [ + "EQUAL", + "NOT_EQUAL", + "GREATER", + "LESS", + "GREATER_OR_EQUAL", + "LESS_OR_EQUAL" + ] + }, + "AlarmRuleStringFilterPredicate": { "allOf": [ { "$ref": "#/components/schemas/AlarmRuleKeyFilterPredicate" @@ -117364,10 +117377,13 @@ "type": "object", "properties": { "operation": { - "$ref": "#/components/schemas/NumericOperation" + "$ref": "#/components/schemas/AlarmRuleStringOperation" }, "value": { - "$ref": "#/components/schemas/AlarmConditionValueDouble" + "$ref": "#/components/schemas/AlarmConditionValueString" + }, + "ignoreCase": { + "type": "boolean" } } } @@ -117377,31 +117393,26 @@ "value" ] }, - "AlarmRuleRepeatingCondition": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleCondition" - }, - { - "type": "object", - "properties": { - "count": { - "$ref": "#/components/schemas/AlarmConditionValueInteger" - } - } - } - ], - "required": [ - "count" + "AlarmRuleStringOperation": { + "type": "string", + "enum": [ + "EQUAL", + "NOT_EQUAL", + "STARTS_WITH", + "ENDS_WITH", + "CONTAINS", + "NOT_CONTAINS", + "IN", + "NOT_IN" ] }, - "AlarmRuleSchedule": { + "AlarmSchedule": { "discriminator": { "propertyName": "type", "mapping": { - "ANY_TIME": "#/components/schemas/AlarmRuleAnyTimeSchedule", - "SPECIFIC_TIME": "#/components/schemas/AlarmRuleSpecificTimeSchedule", - "CUSTOM": "#/components/schemas/AlarmRuleCustomTimeSchedule" + "ANY_TIME": "#/components/schemas/AnyTimeSchedule", + "SPECIFIC_TIME": "#/components/schemas/SpecificTimeSchedule", + "CUSTOM": "#/components/schemas/CustomTimeSchedule" } }, "properties": { @@ -117413,69 +117424,6 @@ "type" ] }, - "AlarmRuleSimpleCondition": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleCondition" - } - ] - }, - "AlarmRuleSpecificTimeSchedule": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleSchedule" - }, - { - "type": "object", - "properties": { - "daysOfWeek": { - "type": "array", - "items": { - "type": "integer", - "format": "int32" - }, - "uniqueItems": true - }, - "endsOn": { - "type": "integer", - "format": "int64" - }, - "startsOn": { - "type": "integer", - "format": "int64" - }, - "timezone": { - "type": "string" - } - } - } - ] - }, - "AlarmRuleStringFilterPredicate": { - "allOf": [ - { - "$ref": "#/components/schemas/AlarmRuleKeyFilterPredicate" - }, - { - "type": "object", - "properties": { - "ignoreCase": { - "type": "boolean" - }, - "operation": { - "$ref": "#/components/schemas/StringOperation" - }, - "value": { - "$ref": "#/components/schemas/AlarmConditionValueString" - } - } - } - ], - "required": [ - "operation", - "value" - ] - }, "AlarmSearchStatus": { "type": "string", "enum": [ @@ -117783,6 +117731,13 @@ "apiKey" ] }, + "AnyTimeSchedule": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmSchedule" + } + ] + }, "ApiFeature": { "type": "string", "enum": [ @@ -120669,6 +120624,47 @@ } ] }, + "CustomTimeSchedule": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmSchedule" + }, + { + "type": "object", + "properties": { + "timezone": { + "type": "string" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/components/schemas/CustomTimeScheduleItem" + } + } + } + } + ] + }, + "CustomTimeScheduleItem": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "dayOfWeek": { + "type": "integer", + "format": "int32" + }, + "startsOn": { + "type": "integer", + "format": "int64" + }, + "endsOn": { + "type": "integer", + "format": "int64" + } + } + }, "Customer": { "type": "object", "properties": { @@ -123077,6 +123073,28 @@ } ] }, + "DurationAlarmCondition": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmCondition" + }, + { + "type": "object", + "properties": { + "unit": { + "$ref": "#/components/schemas/TimeUnit" + }, + "value": { + "$ref": "#/components/schemas/AlarmConditionValueLong" + } + } + } + ], + "required": [ + "unit", + "value" + ] + }, "DynamicValueBoolean": { "type": "object", "properties": { @@ -128783,6 +128801,28 @@ "targets" ] }, + "NoDataFilterPredicate": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmRuleKeyFilterPredicate" + }, + { + "type": "object", + "properties": { + "unit": { + "$ref": "#/components/schemas/TimeUnit" + }, + "duration": { + "$ref": "#/components/schemas/AlarmConditionValueLong" + } + } + } + ], + "required": [ + "duration", + "unit" + ] + }, "NoSecLwM2MBootstrapServerCredential": { "allOf": [ { @@ -133831,6 +133871,24 @@ } } }, + "RepeatingAlarmCondition": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmCondition" + }, + { + "type": "object", + "properties": { + "count": { + "$ref": "#/components/schemas/AlarmConditionValueInteger" + } + } + } + ], + "required": [ + "count" + ] + }, "Report": { "type": "object", "properties": { @@ -136611,6 +136669,13 @@ } } }, + "SimpleAlarmCondition": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmCondition" + } + ] + }, "SimpleAlarmConditionExpression": { "allOf": [ { @@ -136622,12 +136687,12 @@ "filters": { "type": "array", "items": { - "$ref": "#/components/schemas/AlarmRuleConditionFilter" + "$ref": "#/components/schemas/AlarmConditionFilter" }, "minItems": 1 }, "operation": { - "$ref": "#/components/schemas/ComplexOperation" + "$ref": "#/components/schemas/AlarmRuleComplexOperation" } } } @@ -137274,6 +137339,37 @@ } } }, + "SpecificTimeSchedule": { + "allOf": [ + { + "$ref": "#/components/schemas/AlarmSchedule" + }, + { + "type": "object", + "properties": { + "timezone": { + "type": "string" + }, + "daysOfWeek": { + "type": "array", + "items": { + "type": "integer", + "format": "int32" + }, + "uniqueItems": true + }, + "startsOn": { + "type": "integer", + "format": "int64" + }, + "endsOn": { + "type": "integer", + "format": "int64" + } + } + } + ] + }, "SplitViewComponent": { "allOf": [ { @@ -137605,6 +137701,13 @@ } }, "SystemLevelUsersFilter": {}, + "TableSortDirection": { + "type": "string", + "enum": [ + "ASC", + "DESC" + ] + }, "TableSortOrder": { "type": "object", "properties": { @@ -137612,7 +137715,7 @@ "type": "string" }, "direction": { - "$ref": "#/components/schemas/Direction" + "$ref": "#/components/schemas/TableSortDirection" } } }, diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmCalculatedFieldConfiguration.java b/pe/src/main/java/org/thingsboard/client/model/AlarmCalculatedFieldConfiguration.java index 941212c4..4d3c482c 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmCalculatedFieldConfiguration.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmCalculatedFieldConfiguration.java @@ -37,7 +37,7 @@ import java.util.HashMap; import java.util.List; import java.util.Map; -import org.thingsboard.client.model.AlarmRuleDefinition; +import org.thingsboard.client.model.AlarmRule; import org.thingsboard.client.model.Argument; import org.thingsboard.client.model.CalculatedFieldConfiguration; import org.thingsboard.client.model.Output; @@ -73,11 +73,11 @@ public class AlarmCalculatedFieldConfiguration extends CalculatedFieldConfigurat public static final String JSON_PROPERTY_CREATE_RULES = "createRules"; @Nonnull - private Map createRules = new HashMap<>(); + private Map createRules = new HashMap<>(); public static final String JSON_PROPERTY_CLEAR_RULE = "clearRule"; @Nullable - private AlarmRuleDefinition clearRule; + private AlarmRule clearRule; public static final String JSON_PROPERTY_PROPAGATE = "propagate"; @Nullable @@ -134,12 +134,12 @@ public void setArguments(@Nonnull Map arguments) { } - public AlarmCalculatedFieldConfiguration createRules(@Nonnull Map createRules) { + public AlarmCalculatedFieldConfiguration createRules(@Nonnull Map createRules) { this.createRules = createRules; return this; } - public AlarmCalculatedFieldConfiguration putCreateRulesItem(String key, AlarmRuleDefinition createRulesItem) { + public AlarmCalculatedFieldConfiguration putCreateRulesItem(String key, AlarmRule createRulesItem) { if (this.createRules == null) { this.createRules = new HashMap<>(); } @@ -154,19 +154,19 @@ public AlarmCalculatedFieldConfiguration putCreateRulesItem(String key, AlarmRul @Nonnull @JsonProperty(value = JSON_PROPERTY_CREATE_RULES, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public Map getCreateRules() { + public Map getCreateRules() { return createRules; } @JsonProperty(value = JSON_PROPERTY_CREATE_RULES, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCreateRules(@Nonnull Map createRules) { + public void setCreateRules(@Nonnull Map createRules) { this.createRules = createRules; } - public AlarmCalculatedFieldConfiguration clearRule(@Nullable AlarmRuleDefinition clearRule) { + public AlarmCalculatedFieldConfiguration clearRule(@Nullable AlarmRule clearRule) { this.clearRule = clearRule; return this; } @@ -178,14 +178,14 @@ public AlarmCalculatedFieldConfiguration clearRule(@Nullable AlarmRuleDefinition @Nullable @JsonProperty(value = JSON_PROPERTY_CLEAR_RULE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public AlarmRuleDefinition getClearRule() { + public AlarmRule getClearRule() { return clearRule; } @JsonProperty(value = JSON_PROPERTY_CLEAR_RULE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setClearRule(@Nullable AlarmRuleDefinition clearRule) { + public void setClearRule(@Nullable AlarmRule clearRule) { this.clearRule = clearRule; } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleCondition.java b/pe/src/main/java/org/thingsboard/client/model/AlarmCondition.java similarity index 78% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleCondition.java rename to pe/src/main/java/org/thingsboard/client/model/AlarmCondition.java index 685599a5..3ad5f169 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleCondition.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmCondition.java @@ -34,19 +34,19 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; import org.thingsboard.client.model.AlarmConditionExpression; -import org.thingsboard.client.model.AlarmConditionValueAlarmRuleSchedule; +import org.thingsboard.client.model.AlarmConditionValueAlarmSchedule; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleCondition + * AlarmCondition */ @JsonPropertyOrder({ - AlarmRuleCondition.JSON_PROPERTY_EXPRESSION, - AlarmRuleCondition.JSON_PROPERTY_SCHEDULE, - AlarmRuleCondition.JSON_PROPERTY_TYPE + AlarmCondition.JSON_PROPERTY_EXPRESSION, + AlarmCondition.JSON_PROPERTY_SCHEDULE, + AlarmCondition.JSON_PROPERTY_TYPE }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -55,28 +55,28 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) @JsonSubTypes({ - @JsonSubTypes.Type(value = AlarmRuleDurationCondition.class, name = "DURATION"), - @JsonSubTypes.Type(value = AlarmRuleRepeatingCondition.class, name = "REPEATING"), - @JsonSubTypes.Type(value = AlarmRuleSimpleCondition.class, name = "SIMPLE"), + @JsonSubTypes.Type(value = DurationAlarmCondition.class, name = "DURATION"), + @JsonSubTypes.Type(value = RepeatingAlarmCondition.class, name = "REPEATING"), + @JsonSubTypes.Type(value = SimpleAlarmCondition.class, name = "SIMPLE"), }) -public class AlarmRuleCondition { +public class AlarmCondition { public static final String JSON_PROPERTY_EXPRESSION = "expression"; @Nonnull private AlarmConditionExpression expression; public static final String JSON_PROPERTY_SCHEDULE = "schedule"; @Nullable - private AlarmConditionValueAlarmRuleSchedule schedule; + private AlarmConditionValueAlarmSchedule schedule; public static final String JSON_PROPERTY_TYPE = "type"; @Nonnull private String type; - public AlarmRuleCondition() { + public AlarmCondition() { } - public AlarmRuleCondition expression(@Nonnull AlarmConditionExpression expression) { + public AlarmCondition expression(@Nonnull AlarmConditionExpression expression) { this.expression = expression; return this; } @@ -100,7 +100,7 @@ public void setExpression(@Nonnull AlarmConditionExpression expression) { } - public AlarmRuleCondition schedule(@Nullable AlarmConditionValueAlarmRuleSchedule schedule) { + public AlarmCondition schedule(@Nullable AlarmConditionValueAlarmSchedule schedule) { this.schedule = schedule; return this; } @@ -112,19 +112,19 @@ public AlarmRuleCondition schedule(@Nullable AlarmConditionValueAlarmRuleSchedul @Nullable @JsonProperty(value = JSON_PROPERTY_SCHEDULE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public AlarmConditionValueAlarmRuleSchedule getSchedule() { + public AlarmConditionValueAlarmSchedule getSchedule() { return schedule; } @JsonProperty(value = JSON_PROPERTY_SCHEDULE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setSchedule(@Nullable AlarmConditionValueAlarmRuleSchedule schedule) { + public void setSchedule(@Nullable AlarmConditionValueAlarmSchedule schedule) { this.schedule = schedule; } - public AlarmRuleCondition type(@Nonnull String type) { + public AlarmCondition type(@Nonnull String type) { this.type = type; return this; } @@ -149,7 +149,7 @@ public void setType(@Nonnull String type) { /** - * Return true if this AlarmRuleCondition object is equal to o. + * Return true if this AlarmCondition object is equal to o. */ @Override public boolean equals(Object o) { @@ -159,10 +159,10 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleCondition alarmRuleCondition = (AlarmRuleCondition) o; - return Objects.equals(this.expression, alarmRuleCondition.expression) && - Objects.equals(this.schedule, alarmRuleCondition.schedule) && - Objects.equals(this.type, alarmRuleCondition.type); + AlarmCondition alarmCondition = (AlarmCondition) o; + return Objects.equals(this.expression, alarmCondition.expression) && + Objects.equals(this.schedule, alarmCondition.schedule) && + Objects.equals(this.type, alarmCondition.type); } @Override @@ -173,7 +173,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleCondition {\n"); + sb.append("class AlarmCondition {\n"); sb.append(" expression: ").append(toIndentedString(expression)).append("\n"); sb.append(" schedule: ").append(toIndentedString(schedule)).append("\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); @@ -244,11 +244,11 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("DURATION", AlarmRuleDurationCondition.class); - mappings.put("REPEATING", AlarmRuleRepeatingCondition.class); - mappings.put("SIMPLE", AlarmRuleSimpleCondition.class); - mappings.put("AlarmRuleCondition", AlarmRuleCondition.class); - JSON.registerDiscriminator(AlarmRuleCondition.class, "type", mappings); + mappings.put("DURATION", DurationAlarmCondition.class); + mappings.put("REPEATING", RepeatingAlarmCondition.class); + mappings.put("SIMPLE", SimpleAlarmCondition.class); + mappings.put("AlarmCondition", AlarmCondition.class); + JSON.registerDiscriminator(AlarmCondition.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleConditionFilter.java b/pe/src/main/java/org/thingsboard/client/model/AlarmConditionFilter.java similarity index 82% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleConditionFilter.java rename to pe/src/main/java/org/thingsboard/client/model/AlarmConditionFilter.java index 6af9fc70..ea8f7316 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleConditionFilter.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmConditionFilter.java @@ -32,44 +32,44 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import org.thingsboard.client.model.AlarmRuleComplexOperation; import org.thingsboard.client.model.AlarmRuleKeyFilterPredicate; -import org.thingsboard.client.model.ComplexOperation; import org.thingsboard.client.model.EntityKeyValueType; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.ApiClient; /** - * AlarmRuleConditionFilter + * AlarmConditionFilter */ @JsonPropertyOrder({ - AlarmRuleConditionFilter.JSON_PROPERTY_ARGUMENT, - AlarmRuleConditionFilter.JSON_PROPERTY_OPERATION, - AlarmRuleConditionFilter.JSON_PROPERTY_PREDICATES, - AlarmRuleConditionFilter.JSON_PROPERTY_VALUE_TYPE + AlarmConditionFilter.JSON_PROPERTY_ARGUMENT, + AlarmConditionFilter.JSON_PROPERTY_VALUE_TYPE, + AlarmConditionFilter.JSON_PROPERTY_OPERATION, + AlarmConditionFilter.JSON_PROPERTY_PREDICATES }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") -public class AlarmRuleConditionFilter { +public class AlarmConditionFilter { public static final String JSON_PROPERTY_ARGUMENT = "argument"; @Nonnull private String argument; + public static final String JSON_PROPERTY_VALUE_TYPE = "valueType"; + @Nonnull + private EntityKeyValueType valueType; + public static final String JSON_PROPERTY_OPERATION = "operation"; @Nullable - private ComplexOperation operation; + private AlarmRuleComplexOperation operation; public static final String JSON_PROPERTY_PREDICATES = "predicates"; @Nonnull private List predicates = new ArrayList<>(); - public static final String JSON_PROPERTY_VALUE_TYPE = "valueType"; - @Nonnull - private EntityKeyValueType valueType; - - public AlarmRuleConditionFilter() { + public AlarmConditionFilter() { } - public AlarmRuleConditionFilter argument(@Nonnull String argument) { + public AlarmConditionFilter argument(@Nonnull String argument) { this.argument = argument; return this; } @@ -93,7 +93,31 @@ public void setArgument(@Nonnull String argument) { } - public AlarmRuleConditionFilter operation(@Nullable ComplexOperation operation) { + public AlarmConditionFilter valueType(@Nonnull EntityKeyValueType valueType) { + this.valueType = valueType; + return this; + } + + /** + * Get valueType + * @return valueType + */ + @Nonnull + @JsonProperty(value = JSON_PROPERTY_VALUE_TYPE, required = true) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public EntityKeyValueType getValueType() { + return valueType; + } + + + @JsonProperty(value = JSON_PROPERTY_VALUE_TYPE, required = true) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setValueType(@Nonnull EntityKeyValueType valueType) { + this.valueType = valueType; + } + + + public AlarmConditionFilter operation(@Nullable AlarmRuleComplexOperation operation) { this.operation = operation; return this; } @@ -105,24 +129,24 @@ public AlarmRuleConditionFilter operation(@Nullable ComplexOperation operation) @Nullable @JsonProperty(value = JSON_PROPERTY_OPERATION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public ComplexOperation getOperation() { + public AlarmRuleComplexOperation getOperation() { return operation; } @JsonProperty(value = JSON_PROPERTY_OPERATION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOperation(@Nullable ComplexOperation operation) { + public void setOperation(@Nullable AlarmRuleComplexOperation operation) { this.operation = operation; } - public AlarmRuleConditionFilter predicates(@Nonnull List predicates) { + public AlarmConditionFilter predicates(@Nonnull List predicates) { this.predicates = predicates; return this; } - public AlarmRuleConditionFilter addPredicatesItem(AlarmRuleKeyFilterPredicate predicatesItem) { + public AlarmConditionFilter addPredicatesItem(AlarmRuleKeyFilterPredicate predicatesItem) { if (this.predicates == null) { this.predicates = new ArrayList<>(); } @@ -149,32 +173,8 @@ public void setPredicates(@Nonnull List predicates) } - public AlarmRuleConditionFilter valueType(@Nonnull EntityKeyValueType valueType) { - this.valueType = valueType; - return this; - } - - /** - * Get valueType - * @return valueType - */ - @Nonnull - @JsonProperty(value = JSON_PROPERTY_VALUE_TYPE, required = true) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public EntityKeyValueType getValueType() { - return valueType; - } - - - @JsonProperty(value = JSON_PROPERTY_VALUE_TYPE, required = true) - @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setValueType(@Nonnull EntityKeyValueType valueType) { - this.valueType = valueType; - } - - /** - * Return true if this AlarmRuleConditionFilter object is equal to o. + * Return true if this AlarmConditionFilter object is equal to o. */ @Override public boolean equals(Object o) { @@ -184,26 +184,26 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleConditionFilter alarmRuleConditionFilter = (AlarmRuleConditionFilter) o; - return Objects.equals(this.argument, alarmRuleConditionFilter.argument) && - Objects.equals(this.operation, alarmRuleConditionFilter.operation) && - Objects.equals(this.predicates, alarmRuleConditionFilter.predicates) && - Objects.equals(this.valueType, alarmRuleConditionFilter.valueType); + AlarmConditionFilter alarmConditionFilter = (AlarmConditionFilter) o; + return Objects.equals(this.argument, alarmConditionFilter.argument) && + Objects.equals(this.valueType, alarmConditionFilter.valueType) && + Objects.equals(this.operation, alarmConditionFilter.operation) && + Objects.equals(this.predicates, alarmConditionFilter.predicates); } @Override public int hashCode() { - return Objects.hash(argument, operation, predicates, valueType); + return Objects.hash(argument, valueType, operation, predicates); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleConditionFilter {\n"); + sb.append("class AlarmConditionFilter {\n"); sb.append(" argument: ").append(toIndentedString(argument)).append("\n"); + sb.append(" valueType: ").append(toIndentedString(valueType)).append("\n"); sb.append(" operation: ").append(toIndentedString(operation)).append("\n"); sb.append(" predicates: ").append(toIndentedString(predicates)).append("\n"); - sb.append(" valueType: ").append(toIndentedString(valueType)).append("\n"); sb.append("}"); return sb.toString(); } @@ -256,6 +256,11 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format(java.util.Locale.ROOT, "%sargument%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getArgument())))); } + // add `valueType` to the URL query string + if (getValueType() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%svalueType%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getValueType())))); + } + // add `operation` to the URL query string if (getOperation() != null) { joiner.add(String.format(java.util.Locale.ROOT, "%soperation%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getOperation())))); @@ -271,11 +276,6 @@ public String toUrlQueryString(String prefix) { } } - // add `valueType` to the URL query string - if (getValueType() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%svalueType%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getValueType())))); - } - return joiner.toString(); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmConditionValueAlarmRuleSchedule.java b/pe/src/main/java/org/thingsboard/client/model/AlarmConditionValueAlarmSchedule.java similarity index 79% rename from pe/src/main/java/org/thingsboard/client/model/AlarmConditionValueAlarmRuleSchedule.java rename to pe/src/main/java/org/thingsboard/client/model/AlarmConditionValueAlarmSchedule.java index bba1061a..5f7a74e3 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmConditionValueAlarmRuleSchedule.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmConditionValueAlarmSchedule.java @@ -29,81 +29,81 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; -import org.thingsboard.client.model.AlarmRuleSchedule; +import org.thingsboard.client.model.AlarmSchedule; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.ApiClient; /** - * AlarmConditionValueAlarmRuleSchedule + * AlarmConditionValueAlarmSchedule */ @JsonPropertyOrder({ - AlarmConditionValueAlarmRuleSchedule.JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT, - AlarmConditionValueAlarmRuleSchedule.JSON_PROPERTY_STATIC_VALUE + AlarmConditionValueAlarmSchedule.JSON_PROPERTY_STATIC_VALUE, + AlarmConditionValueAlarmSchedule.JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") -public class AlarmConditionValueAlarmRuleSchedule { - public static final String JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT = "dynamicValueArgument"; +public class AlarmConditionValueAlarmSchedule { + public static final String JSON_PROPERTY_STATIC_VALUE = "staticValue"; @Nullable - private String dynamicValueArgument; + private AlarmSchedule staticValue; - public static final String JSON_PROPERTY_STATIC_VALUE = "staticValue"; + public static final String JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT = "dynamicValueArgument"; @Nullable - private AlarmRuleSchedule staticValue; + private String dynamicValueArgument; - public AlarmConditionValueAlarmRuleSchedule() { + public AlarmConditionValueAlarmSchedule() { } - public AlarmConditionValueAlarmRuleSchedule dynamicValueArgument(@Nullable String dynamicValueArgument) { - this.dynamicValueArgument = dynamicValueArgument; + public AlarmConditionValueAlarmSchedule staticValue(@Nullable AlarmSchedule staticValue) { + this.staticValue = staticValue; return this; } /** - * Get dynamicValueArgument - * @return dynamicValueArgument + * Get staticValue + * @return staticValue */ @Nullable - @JsonProperty(value = JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT, required = false) + @JsonProperty(value = JSON_PROPERTY_STATIC_VALUE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getDynamicValueArgument() { - return dynamicValueArgument; + public AlarmSchedule getStaticValue() { + return staticValue; } - @JsonProperty(value = JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT, required = false) + @JsonProperty(value = JSON_PROPERTY_STATIC_VALUE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDynamicValueArgument(@Nullable String dynamicValueArgument) { - this.dynamicValueArgument = dynamicValueArgument; + public void setStaticValue(@Nullable AlarmSchedule staticValue) { + this.staticValue = staticValue; } - public AlarmConditionValueAlarmRuleSchedule staticValue(@Nullable AlarmRuleSchedule staticValue) { - this.staticValue = staticValue; + public AlarmConditionValueAlarmSchedule dynamicValueArgument(@Nullable String dynamicValueArgument) { + this.dynamicValueArgument = dynamicValueArgument; return this; } /** - * Get staticValue - * @return staticValue + * Get dynamicValueArgument + * @return dynamicValueArgument */ @Nullable - @JsonProperty(value = JSON_PROPERTY_STATIC_VALUE, required = false) + @JsonProperty(value = JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public AlarmRuleSchedule getStaticValue() { - return staticValue; + public String getDynamicValueArgument() { + return dynamicValueArgument; } - @JsonProperty(value = JSON_PROPERTY_STATIC_VALUE, required = false) + @JsonProperty(value = JSON_PROPERTY_DYNAMIC_VALUE_ARGUMENT, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setStaticValue(@Nullable AlarmRuleSchedule staticValue) { - this.staticValue = staticValue; + public void setDynamicValueArgument(@Nullable String dynamicValueArgument) { + this.dynamicValueArgument = dynamicValueArgument; } /** - * Return true if this AlarmConditionValueAlarmRuleSchedule object is equal to o. + * Return true if this AlarmConditionValueAlarmSchedule object is equal to o. */ @Override public boolean equals(Object o) { @@ -113,22 +113,22 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmConditionValueAlarmRuleSchedule alarmConditionValueAlarmRuleSchedule = (AlarmConditionValueAlarmRuleSchedule) o; - return Objects.equals(this.dynamicValueArgument, alarmConditionValueAlarmRuleSchedule.dynamicValueArgument) && - Objects.equals(this.staticValue, alarmConditionValueAlarmRuleSchedule.staticValue); + AlarmConditionValueAlarmSchedule alarmConditionValueAlarmSchedule = (AlarmConditionValueAlarmSchedule) o; + return Objects.equals(this.staticValue, alarmConditionValueAlarmSchedule.staticValue) && + Objects.equals(this.dynamicValueArgument, alarmConditionValueAlarmSchedule.dynamicValueArgument); } @Override public int hashCode() { - return Objects.hash(dynamicValueArgument, staticValue); + return Objects.hash(staticValue, dynamicValueArgument); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmConditionValueAlarmRuleSchedule {\n"); - sb.append(" dynamicValueArgument: ").append(toIndentedString(dynamicValueArgument)).append("\n"); + sb.append("class AlarmConditionValueAlarmSchedule {\n"); sb.append(" staticValue: ").append(toIndentedString(staticValue)).append("\n"); + sb.append(" dynamicValueArgument: ").append(toIndentedString(dynamicValueArgument)).append("\n"); sb.append("}"); return sb.toString(); } @@ -176,16 +176,16 @@ public String toUrlQueryString(String prefix) { StringJoiner joiner = new StringJoiner("&"); - // add `dynamicValueArgument` to the URL query string - if (getDynamicValueArgument() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%sdynamicValueArgument%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getDynamicValueArgument())))); - } - // add `staticValue` to the URL query string if (getStaticValue() != null) { joiner.add(getStaticValue().toUrlQueryString(prefix + "staticValue" + suffix)); } + // add `dynamicValueArgument` to the URL query string + if (getDynamicValueArgument() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sdynamicValueArgument%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getDynamicValueArgument())))); + } + return joiner.toString(); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRule.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRule.java new file mode 100644 index 00000000..2620dda5 --- /dev/null +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRule.java @@ -0,0 +1,230 @@ +/** + * Copyright © 2026-2026 ThingsBoard, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.client.model; + +import javax.annotation.Generated; +import javax.annotation.Nonnull; +import javax.annotation.Nullable; +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonTypeName; +import com.fasterxml.jackson.annotation.JsonValue; +import java.util.Arrays; +import org.thingsboard.client.model.AlarmCondition; +import org.thingsboard.client.model.DashboardId; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +import org.thingsboard.client.ApiClient; +/** + * AlarmRule + */ +@JsonPropertyOrder({ + AlarmRule.JSON_PROPERTY_CONDITION, + AlarmRule.JSON_PROPERTY_ALARM_DETAILS, + AlarmRule.JSON_PROPERTY_DASHBOARD_ID +}) +@Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") +public class AlarmRule { + public static final String JSON_PROPERTY_CONDITION = "condition"; + @Nonnull + private AlarmCondition condition; + + public static final String JSON_PROPERTY_ALARM_DETAILS = "alarmDetails"; + @Nullable + private String alarmDetails; + + public static final String JSON_PROPERTY_DASHBOARD_ID = "dashboardId"; + @Nullable + private DashboardId dashboardId; + + public AlarmRule() { + } + + public AlarmRule condition(@Nonnull AlarmCondition condition) { + this.condition = condition; + return this; + } + + /** + * Get condition + * @return condition + */ + @Nonnull + @JsonProperty(value = JSON_PROPERTY_CONDITION, required = true) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public AlarmCondition getCondition() { + return condition; + } + + + @JsonProperty(value = JSON_PROPERTY_CONDITION, required = true) + @JsonInclude(value = JsonInclude.Include.ALWAYS) + public void setCondition(@Nonnull AlarmCondition condition) { + this.condition = condition; + } + + + public AlarmRule alarmDetails(@Nullable String alarmDetails) { + this.alarmDetails = alarmDetails; + return this; + } + + /** + * Get alarmDetails + * @return alarmDetails + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_ALARM_DETAILS, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getAlarmDetails() { + return alarmDetails; + } + + + @JsonProperty(value = JSON_PROPERTY_ALARM_DETAILS, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setAlarmDetails(@Nullable String alarmDetails) { + this.alarmDetails = alarmDetails; + } + + + public AlarmRule dashboardId(@Nullable DashboardId dashboardId) { + this.dashboardId = dashboardId; + return this; + } + + /** + * Get dashboardId + * @return dashboardId + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_DASHBOARD_ID, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public DashboardId getDashboardId() { + return dashboardId; + } + + + @JsonProperty(value = JSON_PROPERTY_DASHBOARD_ID, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDashboardId(@Nullable DashboardId dashboardId) { + this.dashboardId = dashboardId; + } + + + /** + * Return true if this AlarmRule object is equal to o. + */ + @Override + public boolean equals(Object o) { + if (this == o) { + return true; + } + if (o == null || getClass() != o.getClass()) { + return false; + } + AlarmRule alarmRule = (AlarmRule) o; + return Objects.equals(this.condition, alarmRule.condition) && + Objects.equals(this.alarmDetails, alarmRule.alarmDetails) && + Objects.equals(this.dashboardId, alarmRule.dashboardId); + } + + @Override + public int hashCode() { + return Objects.hash(condition, alarmDetails, dashboardId); + } + + @Override + public String toString() { + StringBuilder sb = new StringBuilder(); + sb.append("class AlarmRule {\n"); + sb.append(" condition: ").append(toIndentedString(condition)).append("\n"); + sb.append(" alarmDetails: ").append(toIndentedString(alarmDetails)).append("\n"); + sb.append(" dashboardId: ").append(toIndentedString(dashboardId)).append("\n"); + sb.append("}"); + return sb.toString(); + } + + /** + * Convert the given object to string with each line indented by 4 spaces + * (except the first line). + */ + private String toIndentedString(Object o) { + if (o == null) { + return "null"; + } + return o.toString().replace("\n", "\n "); + } + + /** + * Convert the instance into URL query string. + * + * @return URL query string + */ + public String toUrlQueryString() { + return toUrlQueryString(null); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + String suffix = ""; + String containerSuffix = ""; + String containerPrefix = ""; + if (prefix == null) { + // style=form, explode=true, e.g. /pet?name=cat&type=manx + prefix = ""; + } else { + // deepObject style e.g. /pet?id[name]=cat&id[type]=manx + prefix = prefix + "["; + suffix = "]"; + containerSuffix = "]"; + containerPrefix = "["; + } + + StringJoiner joiner = new StringJoiner("&"); + + // add `condition` to the URL query string + if (getCondition() != null) { + joiner.add(getCondition().toUrlQueryString(prefix + "condition" + suffix)); + } + + // add `alarmDetails` to the URL query string + if (getAlarmDetails() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%salarmDetails%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getAlarmDetails())))); + } + + // add `dashboardId` to the URL query string + if (getDashboardId() != null) { + joiner.add(getDashboardId().toUrlQueryString(prefix + "dashboardId" + suffix)); + } + + return joiner.toString(); + } +} + diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanFilterPredicate.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanFilterPredicate.java index 95154389..11688972 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanFilterPredicate.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanFilterPredicate.java @@ -33,8 +33,8 @@ import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; import org.thingsboard.client.model.AlarmConditionValueBoolean; +import org.thingsboard.client.model.AlarmRuleBooleanOperation; import org.thingsboard.client.model.AlarmRuleKeyFilterPredicate; -import org.thingsboard.client.model.BooleanOperation; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -57,7 +57,7 @@ public class AlarmRuleBooleanFilterPredicate extends AlarmRuleKeyFilterPredicate { public static final String JSON_PROPERTY_OPERATION = "operation"; @Nonnull - private BooleanOperation operation; + private AlarmRuleBooleanOperation operation; public static final String JSON_PROPERTY_VALUE = "value"; @Nonnull @@ -66,7 +66,7 @@ public class AlarmRuleBooleanFilterPredicate extends AlarmRuleKeyFilterPredicate public AlarmRuleBooleanFilterPredicate() { } - public AlarmRuleBooleanFilterPredicate operation(@Nonnull BooleanOperation operation) { + public AlarmRuleBooleanFilterPredicate operation(@Nonnull AlarmRuleBooleanOperation operation) { this.operation = operation; return this; } @@ -78,14 +78,14 @@ public AlarmRuleBooleanFilterPredicate operation(@Nonnull BooleanOperation opera @Nonnull @JsonProperty(value = JSON_PROPERTY_OPERATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public BooleanOperation getOperation() { + public AlarmRuleBooleanOperation getOperation() { return operation; } @JsonProperty(value = JSON_PROPERTY_OPERATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setOperation(@Nonnull BooleanOperation operation) { + public void setOperation(@Nonnull AlarmRuleBooleanOperation operation) { this.operation = operation; } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanOperation.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanOperation.java new file mode 100644 index 00000000..a87dfc84 --- /dev/null +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleBooleanOperation.java @@ -0,0 +1,80 @@ +/** + * Copyright © 2026-2026 ThingsBoard, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.client.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets AlarmRuleBooleanOperation + */ +public enum AlarmRuleBooleanOperation { + + EQUAL("EQUAL"), + + NOT_EQUAL("NOT_EQUAL"); + + private String value; + + AlarmRuleBooleanOperation(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static AlarmRuleBooleanOperation fromValue(String value) { + for (AlarmRuleBooleanOperation b : AlarmRuleBooleanOperation.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format(java.util.Locale.ROOT, "%s=%s", prefix, this.toString()); + } + +} + diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexFilterPredicate.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexFilterPredicate.java index b76c7f7a..1b745bf6 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexFilterPredicate.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexFilterPredicate.java @@ -34,8 +34,8 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; +import org.thingsboard.client.model.AlarmRuleComplexOperation; import org.thingsboard.client.model.AlarmRuleKeyFilterPredicate; -import org.thingsboard.client.model.ComplexOperation; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -58,7 +58,7 @@ public class AlarmRuleComplexFilterPredicate extends AlarmRuleKeyFilterPredicate { public static final String JSON_PROPERTY_OPERATION = "operation"; @Nullable - private ComplexOperation operation; + private AlarmRuleComplexOperation operation; public static final String JSON_PROPERTY_PREDICATES = "predicates"; @Nullable @@ -67,7 +67,7 @@ public class AlarmRuleComplexFilterPredicate extends AlarmRuleKeyFilterPredicate public AlarmRuleComplexFilterPredicate() { } - public AlarmRuleComplexFilterPredicate operation(@Nullable ComplexOperation operation) { + public AlarmRuleComplexFilterPredicate operation(@Nullable AlarmRuleComplexOperation operation) { this.operation = operation; return this; } @@ -79,14 +79,14 @@ public AlarmRuleComplexFilterPredicate operation(@Nullable ComplexOperation oper @Nullable @JsonProperty(value = JSON_PROPERTY_OPERATION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public ComplexOperation getOperation() { + public AlarmRuleComplexOperation getOperation() { return operation; } @JsonProperty(value = JSON_PROPERTY_OPERATION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOperation(@Nullable ComplexOperation operation) { + public void setOperation(@Nullable AlarmRuleComplexOperation operation) { this.operation = operation; } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexOperation.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexOperation.java new file mode 100644 index 00000000..1b4a7106 --- /dev/null +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleComplexOperation.java @@ -0,0 +1,80 @@ +/** + * Copyright © 2026-2026 ThingsBoard, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.client.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets AlarmRuleComplexOperation + */ +public enum AlarmRuleComplexOperation { + + AND("AND"), + + OR("OR"); + + private String value; + + AlarmRuleComplexOperation(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static AlarmRuleComplexOperation fromValue(String value) { + for (AlarmRuleComplexOperation b : AlarmRuleComplexOperation.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format(java.util.Locale.ROOT, "%s=%s", prefix, this.toString()); + } + +} + diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleDefinition.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleDefinition.java index 8a87627e..d22e098c 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleDefinition.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleDefinition.java @@ -30,8 +30,11 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; -import org.thingsboard.client.model.AlarmRuleCondition; -import org.thingsboard.client.model.DashboardId; +import org.thingsboard.client.model.AlarmCalculatedFieldConfiguration; +import org.thingsboard.client.model.CalculatedFieldId; +import org.thingsboard.client.model.DebugSettings; +import org.thingsboard.client.model.EntityId; +import org.thingsboard.client.model.TenantId; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -40,96 +43,328 @@ * AlarmRuleDefinition */ @JsonPropertyOrder({ - AlarmRuleDefinition.JSON_PROPERTY_ALARM_DETAILS, - AlarmRuleDefinition.JSON_PROPERTY_CONDITION, - AlarmRuleDefinition.JSON_PROPERTY_DASHBOARD_ID + AlarmRuleDefinition.JSON_PROPERTY_ID, + AlarmRuleDefinition.JSON_PROPERTY_CREATED_TIME, + AlarmRuleDefinition.JSON_PROPERTY_TENANT_ID, + AlarmRuleDefinition.JSON_PROPERTY_ENTITY_ID, + AlarmRuleDefinition.JSON_PROPERTY_NAME, + AlarmRuleDefinition.JSON_PROPERTY_DEBUG_SETTINGS, + AlarmRuleDefinition.JSON_PROPERTY_CONFIGURATION_VERSION, + AlarmRuleDefinition.JSON_PROPERTY_CONFIGURATION, + AlarmRuleDefinition.JSON_PROPERTY_VERSION, + AlarmRuleDefinition.JSON_PROPERTY_ADDITIONAL_INFO, + AlarmRuleDefinition.JSON_PROPERTY_DEBUG_MODE }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") public class AlarmRuleDefinition { - public static final String JSON_PROPERTY_ALARM_DETAILS = "alarmDetails"; + public static final String JSON_PROPERTY_ID = "id"; @Nullable - private String alarmDetails; + private CalculatedFieldId id; - public static final String JSON_PROPERTY_CONDITION = "condition"; + public static final String JSON_PROPERTY_CREATED_TIME = "createdTime"; + @Nullable + private Long createdTime; + + public static final String JSON_PROPERTY_TENANT_ID = "tenantId"; + @Nullable + private TenantId tenantId; + + public static final String JSON_PROPERTY_ENTITY_ID = "entityId"; + @Nullable + private EntityId entityId; + + public static final String JSON_PROPERTY_NAME = "name"; + @Nullable + private String name; + + public static final String JSON_PROPERTY_DEBUG_SETTINGS = "debugSettings"; + @Nullable + private DebugSettings debugSettings; + + public static final String JSON_PROPERTY_CONFIGURATION_VERSION = "configurationVersion"; + @Nullable + private Integer configurationVersion; + + public static final String JSON_PROPERTY_CONFIGURATION = "configuration"; @Nonnull - private AlarmRuleCondition condition; + private AlarmCalculatedFieldConfiguration _configuration; + + public static final String JSON_PROPERTY_VERSION = "version"; + @Nullable + private Long version; - public static final String JSON_PROPERTY_DASHBOARD_ID = "dashboardId"; + public static final String JSON_PROPERTY_ADDITIONAL_INFO = "additionalInfo"; @Nullable - private DashboardId dashboardId; + private com.fasterxml.jackson.databind.JsonNode additionalInfo; + + public static final String JSON_PROPERTY_DEBUG_MODE = "debugMode"; + @Nullable + private Boolean debugMode; public AlarmRuleDefinition() { } - public AlarmRuleDefinition alarmDetails(@Nullable String alarmDetails) { - this.alarmDetails = alarmDetails; + @JsonCreator + public AlarmRuleDefinition( + @JsonProperty(JSON_PROPERTY_CREATED_TIME) Long createdTime + ) { + this(); + this.createdTime = createdTime; + } + + public AlarmRuleDefinition id(@Nullable CalculatedFieldId id) { + this.id = id; return this; } /** - * Get alarmDetails - * @return alarmDetails + * JSON object with the Alarm Rule Id. Referencing non-existing Alarm Rule Id will cause error. + * @return id */ @Nullable - @JsonProperty(value = JSON_PROPERTY_ALARM_DETAILS, required = false) + @JsonProperty(value = JSON_PROPERTY_ID, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getAlarmDetails() { - return alarmDetails; + public CalculatedFieldId getId() { + return id; } - @JsonProperty(value = JSON_PROPERTY_ALARM_DETAILS, required = false) + @JsonProperty(value = JSON_PROPERTY_ID, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setAlarmDetails(@Nullable String alarmDetails) { - this.alarmDetails = alarmDetails; + public void setId(@Nullable CalculatedFieldId id) { + this.id = id; } - public AlarmRuleDefinition condition(@Nonnull AlarmRuleCondition condition) { - this.condition = condition; + /** + * Timestamp of the alarm rule creation, in milliseconds + * @return createdTime + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_CREATED_TIME, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Long getCreatedTime() { + return createdTime; + } + + + + + public AlarmRuleDefinition tenantId(@Nullable TenantId tenantId) { + this.tenantId = tenantId; return this; } /** - * Get condition - * @return condition + * Get tenantId + * @return tenantId + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_TENANT_ID, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public TenantId getTenantId() { + return tenantId; + } + + + @JsonProperty(value = JSON_PROPERTY_TENANT_ID, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTenantId(@Nullable TenantId tenantId) { + this.tenantId = tenantId; + } + + + public AlarmRuleDefinition entityId(@Nullable EntityId entityId) { + this.entityId = entityId; + return this; + } + + /** + * Get entityId + * @return entityId + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_ENTITY_ID, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public EntityId getEntityId() { + return entityId; + } + + + @JsonProperty(value = JSON_PROPERTY_ENTITY_ID, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEntityId(@Nullable EntityId entityId) { + this.entityId = entityId; + } + + + public AlarmRuleDefinition name(@Nullable String name) { + this.name = name; + return this; + } + + /** + * User defined name of the alarm rule. + * @return name + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_NAME, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getName() { + return name; + } + + + @JsonProperty(value = JSON_PROPERTY_NAME, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setName(@Nullable String name) { + this.name = name; + } + + + public AlarmRuleDefinition debugSettings(@Nullable DebugSettings debugSettings) { + this.debugSettings = debugSettings; + return this; + } + + /** + * Debug settings object. + * @return debugSettings + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_DEBUG_SETTINGS, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public DebugSettings getDebugSettings() { + return debugSettings; + } + + + @JsonProperty(value = JSON_PROPERTY_DEBUG_SETTINGS, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDebugSettings(@Nullable DebugSettings debugSettings) { + this.debugSettings = debugSettings; + } + + + public AlarmRuleDefinition configurationVersion(@Nullable Integer configurationVersion) { + this.configurationVersion = configurationVersion; + return this; + } + + /** + * Version of alarm rule configuration. + * @return configurationVersion + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_CONFIGURATION_VERSION, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Integer getConfigurationVersion() { + return configurationVersion; + } + + + @JsonProperty(value = JSON_PROPERTY_CONFIGURATION_VERSION, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setConfigurationVersion(@Nullable Integer configurationVersion) { + this.configurationVersion = configurationVersion; + } + + + public AlarmRuleDefinition _configuration(@Nonnull AlarmCalculatedFieldConfiguration _configuration) { + this._configuration = _configuration; + return this; + } + + /** + * Get _configuration + * @return _configuration */ @Nonnull - @JsonProperty(value = JSON_PROPERTY_CONDITION, required = true) + @JsonProperty(value = JSON_PROPERTY_CONFIGURATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public AlarmRuleCondition getCondition() { - return condition; + public AlarmCalculatedFieldConfiguration getConfiguration() { + return _configuration; } - @JsonProperty(value = JSON_PROPERTY_CONDITION, required = true) + @JsonProperty(value = JSON_PROPERTY_CONFIGURATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setCondition(@Nonnull AlarmRuleCondition condition) { - this.condition = condition; + public void setConfiguration(@Nonnull AlarmCalculatedFieldConfiguration _configuration) { + this._configuration = _configuration; + } + + + public AlarmRuleDefinition version(@Nullable Long version) { + this.version = version; + return this; + } + + /** + * Get version + * @return version + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_VERSION, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Long getVersion() { + return version; + } + + + @JsonProperty(value = JSON_PROPERTY_VERSION, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setVersion(@Nullable Long version) { + this.version = version; } - public AlarmRuleDefinition dashboardId(@Nullable DashboardId dashboardId) { - this.dashboardId = dashboardId; + public AlarmRuleDefinition additionalInfo(@Nullable com.fasterxml.jackson.databind.JsonNode additionalInfo) { + this.additionalInfo = additionalInfo; return this; } /** - * Get dashboardId - * @return dashboardId + * Additional parameters of the alarm rule. May include: 'description' (string). + * @return additionalInfo */ @Nullable - @JsonProperty(value = JSON_PROPERTY_DASHBOARD_ID, required = false) + @JsonProperty(value = JSON_PROPERTY_ADDITIONAL_INFO, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public DashboardId getDashboardId() { - return dashboardId; + public com.fasterxml.jackson.databind.JsonNode getAdditionalInfo() { + return additionalInfo; } - @JsonProperty(value = JSON_PROPERTY_DASHBOARD_ID, required = false) + @JsonProperty(value = JSON_PROPERTY_ADDITIONAL_INFO, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDashboardId(@Nullable DashboardId dashboardId) { - this.dashboardId = dashboardId; + public void setAdditionalInfo(@Nullable com.fasterxml.jackson.databind.JsonNode additionalInfo) { + this.additionalInfo = additionalInfo; + } + + + public AlarmRuleDefinition debugMode(@Nullable Boolean debugMode) { + this.debugMode = debugMode; + return this; + } + + /** + * Get debugMode + * @return debugMode + * @deprecated + */ + @Deprecated + @Nullable + @JsonProperty(value = JSON_PROPERTY_DEBUG_MODE, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getDebugMode() { + return debugMode; + } + + + @JsonProperty(value = JSON_PROPERTY_DEBUG_MODE, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setDebugMode(@Nullable Boolean debugMode) { + this.debugMode = debugMode; } @@ -145,23 +380,39 @@ public boolean equals(Object o) { return false; } AlarmRuleDefinition alarmRuleDefinition = (AlarmRuleDefinition) o; - return Objects.equals(this.alarmDetails, alarmRuleDefinition.alarmDetails) && - Objects.equals(this.condition, alarmRuleDefinition.condition) && - Objects.equals(this.dashboardId, alarmRuleDefinition.dashboardId); + return Objects.equals(this.id, alarmRuleDefinition.id) && + Objects.equals(this.createdTime, alarmRuleDefinition.createdTime) && + Objects.equals(this.tenantId, alarmRuleDefinition.tenantId) && + Objects.equals(this.entityId, alarmRuleDefinition.entityId) && + Objects.equals(this.name, alarmRuleDefinition.name) && + Objects.equals(this.debugSettings, alarmRuleDefinition.debugSettings) && + Objects.equals(this.configurationVersion, alarmRuleDefinition.configurationVersion) && + Objects.equals(this._configuration, alarmRuleDefinition._configuration) && + Objects.equals(this.version, alarmRuleDefinition.version) && + Objects.equals(this.additionalInfo, alarmRuleDefinition.additionalInfo) && + Objects.equals(this.debugMode, alarmRuleDefinition.debugMode); } @Override public int hashCode() { - return Objects.hash(alarmDetails, condition, dashboardId); + return Objects.hash(id, createdTime, tenantId, entityId, name, debugSettings, configurationVersion, _configuration, version, additionalInfo, debugMode); } @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AlarmRuleDefinition {\n"); - sb.append(" alarmDetails: ").append(toIndentedString(alarmDetails)).append("\n"); - sb.append(" condition: ").append(toIndentedString(condition)).append("\n"); - sb.append(" dashboardId: ").append(toIndentedString(dashboardId)).append("\n"); + sb.append(" id: ").append(toIndentedString(id)).append("\n"); + sb.append(" createdTime: ").append(toIndentedString(createdTime)).append("\n"); + sb.append(" tenantId: ").append(toIndentedString(tenantId)).append("\n"); + sb.append(" entityId: ").append(toIndentedString(entityId)).append("\n"); + sb.append(" name: ").append(toIndentedString(name)).append("\n"); + sb.append(" debugSettings: ").append(toIndentedString(debugSettings)).append("\n"); + sb.append(" configurationVersion: ").append(toIndentedString(configurationVersion)).append("\n"); + sb.append(" _configuration: ").append(toIndentedString(_configuration)).append("\n"); + sb.append(" version: ").append(toIndentedString(version)).append("\n"); + sb.append(" additionalInfo: ").append(toIndentedString(additionalInfo)).append("\n"); + sb.append(" debugMode: ").append(toIndentedString(debugMode)).append("\n"); sb.append("}"); return sb.toString(); } @@ -209,19 +460,59 @@ public String toUrlQueryString(String prefix) { StringJoiner joiner = new StringJoiner("&"); - // add `alarmDetails` to the URL query string - if (getAlarmDetails() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%salarmDetails%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getAlarmDetails())))); + // add `id` to the URL query string + if (getId() != null) { + joiner.add(getId().toUrlQueryString(prefix + "id" + suffix)); + } + + // add `createdTime` to the URL query string + if (getCreatedTime() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%screatedTime%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getCreatedTime())))); + } + + // add `tenantId` to the URL query string + if (getTenantId() != null) { + joiner.add(getTenantId().toUrlQueryString(prefix + "tenantId" + suffix)); + } + + // add `entityId` to the URL query string + if (getEntityId() != null) { + joiner.add(getEntityId().toUrlQueryString(prefix + "entityId" + suffix)); + } + + // add `name` to the URL query string + if (getName() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sname%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getName())))); + } + + // add `debugSettings` to the URL query string + if (getDebugSettings() != null) { + joiner.add(getDebugSettings().toUrlQueryString(prefix + "debugSettings" + suffix)); + } + + // add `configurationVersion` to the URL query string + if (getConfigurationVersion() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sconfigurationVersion%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getConfigurationVersion())))); + } + + // add `configuration` to the URL query string + if (getConfiguration() != null) { + joiner.add(getConfiguration().toUrlQueryString(prefix + "configuration" + suffix)); + } + + // add `version` to the URL query string + if (getVersion() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sversion%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getVersion())))); } - // add `condition` to the URL query string - if (getCondition() != null) { - joiner.add(getCondition().toUrlQueryString(prefix + "condition" + suffix)); + // add `additionalInfo` to the URL query string + if (getAdditionalInfo() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sadditionalInfo%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getAdditionalInfo())))); } - // add `dashboardId` to the URL query string - if (getDashboardId() != null) { - joiner.add(getDashboardId().toUrlQueryString(prefix + "dashboardId" + suffix)); + // add `debugMode` to the URL query string + if (getDebugMode() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sdebugMode%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getDebugMode())))); } return joiner.toString(); diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleKeyFilterPredicate.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleKeyFilterPredicate.java index d1fe90cc..4795aa86 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleKeyFilterPredicate.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleKeyFilterPredicate.java @@ -52,7 +52,7 @@ @JsonSubTypes({ @JsonSubTypes.Type(value = AlarmRuleBooleanFilterPredicate.class, name = "BOOLEAN"), @JsonSubTypes.Type(value = AlarmRuleComplexFilterPredicate.class, name = "COMPLEX"), - @JsonSubTypes.Type(value = AlarmRuleNoDataFilterPredicate.class, name = "NO_DATA"), + @JsonSubTypes.Type(value = NoDataFilterPredicate.class, name = "NO_DATA"), @JsonSubTypes.Type(value = AlarmRuleNumericFilterPredicate.class, name = "NUMERIC"), @JsonSubTypes.Type(value = AlarmRuleStringFilterPredicate.class, name = "STRING"), }) @@ -173,7 +173,7 @@ public String toUrlQueryString(String prefix) { Map> mappings = new HashMap>(); mappings.put("BOOLEAN", AlarmRuleBooleanFilterPredicate.class); mappings.put("COMPLEX", AlarmRuleComplexFilterPredicate.class); - mappings.put("NO_DATA", AlarmRuleNoDataFilterPredicate.class); + mappings.put("NO_DATA", NoDataFilterPredicate.class); mappings.put("NUMERIC", AlarmRuleNumericFilterPredicate.class); mappings.put("STRING", AlarmRuleStringFilterPredicate.class); mappings.put("AlarmRuleKeyFilterPredicate", AlarmRuleKeyFilterPredicate.class); diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericFilterPredicate.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericFilterPredicate.java index 311f8dee..e730ca75 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericFilterPredicate.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericFilterPredicate.java @@ -34,7 +34,7 @@ import java.util.Arrays; import org.thingsboard.client.model.AlarmConditionValueDouble; import org.thingsboard.client.model.AlarmRuleKeyFilterPredicate; -import org.thingsboard.client.model.NumericOperation; +import org.thingsboard.client.model.AlarmRuleNumericOperation; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -57,7 +57,7 @@ public class AlarmRuleNumericFilterPredicate extends AlarmRuleKeyFilterPredicate { public static final String JSON_PROPERTY_OPERATION = "operation"; @Nonnull - private NumericOperation operation; + private AlarmRuleNumericOperation operation; public static final String JSON_PROPERTY_VALUE = "value"; @Nonnull @@ -66,7 +66,7 @@ public class AlarmRuleNumericFilterPredicate extends AlarmRuleKeyFilterPredicate public AlarmRuleNumericFilterPredicate() { } - public AlarmRuleNumericFilterPredicate operation(@Nonnull NumericOperation operation) { + public AlarmRuleNumericFilterPredicate operation(@Nonnull AlarmRuleNumericOperation operation) { this.operation = operation; return this; } @@ -78,14 +78,14 @@ public AlarmRuleNumericFilterPredicate operation(@Nonnull NumericOperation opera @Nonnull @JsonProperty(value = JSON_PROPERTY_OPERATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public NumericOperation getOperation() { + public AlarmRuleNumericOperation getOperation() { return operation; } @JsonProperty(value = JSON_PROPERTY_OPERATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setOperation(@Nonnull NumericOperation operation) { + public void setOperation(@Nonnull AlarmRuleNumericOperation operation) { this.operation = operation; } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericOperation.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericOperation.java new file mode 100644 index 00000000..9e14b719 --- /dev/null +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNumericOperation.java @@ -0,0 +1,88 @@ +/** + * Copyright © 2026-2026 ThingsBoard, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.client.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets AlarmRuleNumericOperation + */ +public enum AlarmRuleNumericOperation { + + EQUAL("EQUAL"), + + NOT_EQUAL("NOT_EQUAL"), + + GREATER("GREATER"), + + LESS("LESS"), + + GREATER_OR_EQUAL("GREATER_OR_EQUAL"), + + LESS_OR_EQUAL("LESS_OR_EQUAL"); + + private String value; + + AlarmRuleNumericOperation(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static AlarmRuleNumericOperation fromValue(String value) { + for (AlarmRuleNumericOperation b : AlarmRuleNumericOperation.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format(java.util.Locale.ROOT, "%s=%s", prefix, this.toString()); + } + +} + diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringFilterPredicate.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringFilterPredicate.java index 643535c9..70890778 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringFilterPredicate.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringFilterPredicate.java @@ -35,7 +35,7 @@ import java.util.Arrays; import org.thingsboard.client.model.AlarmConditionValueString; import org.thingsboard.client.model.AlarmRuleKeyFilterPredicate; -import org.thingsboard.client.model.StringOperation; +import org.thingsboard.client.model.AlarmRuleStringOperation; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -45,9 +45,9 @@ * AlarmRuleStringFilterPredicate */ @JsonPropertyOrder({ - AlarmRuleStringFilterPredicate.JSON_PROPERTY_IGNORE_CASE, AlarmRuleStringFilterPredicate.JSON_PROPERTY_OPERATION, - AlarmRuleStringFilterPredicate.JSON_PROPERTY_VALUE + AlarmRuleStringFilterPredicate.JSON_PROPERTY_VALUE, + AlarmRuleStringFilterPredicate.JSON_PROPERTY_IGNORE_CASE }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -57,46 +57,22 @@ @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) public class AlarmRuleStringFilterPredicate extends AlarmRuleKeyFilterPredicate { - public static final String JSON_PROPERTY_IGNORE_CASE = "ignoreCase"; - @Nullable - private Boolean ignoreCase; - public static final String JSON_PROPERTY_OPERATION = "operation"; @Nonnull - private StringOperation operation; + private AlarmRuleStringOperation operation; public static final String JSON_PROPERTY_VALUE = "value"; @Nonnull private AlarmConditionValueString value; - public AlarmRuleStringFilterPredicate() { - } - - public AlarmRuleStringFilterPredicate ignoreCase(@Nullable Boolean ignoreCase) { - this.ignoreCase = ignoreCase; - return this; - } - - /** - * Get ignoreCase - * @return ignoreCase - */ + public static final String JSON_PROPERTY_IGNORE_CASE = "ignoreCase"; @Nullable - @JsonProperty(value = JSON_PROPERTY_IGNORE_CASE, required = false) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Boolean getIgnoreCase() { - return ignoreCase; - } - + private Boolean ignoreCase; - @JsonProperty(value = JSON_PROPERTY_IGNORE_CASE, required = false) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setIgnoreCase(@Nullable Boolean ignoreCase) { - this.ignoreCase = ignoreCase; + public AlarmRuleStringFilterPredicate() { } - - public AlarmRuleStringFilterPredicate operation(@Nonnull StringOperation operation) { + public AlarmRuleStringFilterPredicate operation(@Nonnull AlarmRuleStringOperation operation) { this.operation = operation; return this; } @@ -108,14 +84,14 @@ public AlarmRuleStringFilterPredicate operation(@Nonnull StringOperation operati @Nonnull @JsonProperty(value = JSON_PROPERTY_OPERATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public StringOperation getOperation() { + public AlarmRuleStringOperation getOperation() { return operation; } @JsonProperty(value = JSON_PROPERTY_OPERATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setOperation(@Nonnull StringOperation operation) { + public void setOperation(@Nonnull AlarmRuleStringOperation operation) { this.operation = operation; } @@ -144,6 +120,30 @@ public void setValue(@Nonnull AlarmConditionValueString value) { } + public AlarmRuleStringFilterPredicate ignoreCase(@Nullable Boolean ignoreCase) { + this.ignoreCase = ignoreCase; + return this; + } + + /** + * Get ignoreCase + * @return ignoreCase + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_IGNORE_CASE, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Boolean getIgnoreCase() { + return ignoreCase; + } + + + @JsonProperty(value = JSON_PROPERTY_IGNORE_CASE, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setIgnoreCase(@Nullable Boolean ignoreCase) { + this.ignoreCase = ignoreCase; + } + + /** * Return true if this AlarmRuleStringFilterPredicate object is equal to o. */ @@ -156,15 +156,15 @@ public boolean equals(Object o) { return false; } AlarmRuleStringFilterPredicate alarmRuleStringFilterPredicate = (AlarmRuleStringFilterPredicate) o; - return Objects.equals(this.ignoreCase, alarmRuleStringFilterPredicate.ignoreCase) && - Objects.equals(this.operation, alarmRuleStringFilterPredicate.operation) && + return Objects.equals(this.operation, alarmRuleStringFilterPredicate.operation) && Objects.equals(this.value, alarmRuleStringFilterPredicate.value) && + Objects.equals(this.ignoreCase, alarmRuleStringFilterPredicate.ignoreCase) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(ignoreCase, operation, value, super.hashCode()); + return Objects.hash(operation, value, ignoreCase, super.hashCode()); } @Override @@ -172,9 +172,9 @@ public String toString() { StringBuilder sb = new StringBuilder(); sb.append("class AlarmRuleStringFilterPredicate {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); - sb.append(" ignoreCase: ").append(toIndentedString(ignoreCase)).append("\n"); sb.append(" operation: ").append(toIndentedString(operation)).append("\n"); sb.append(" value: ").append(toIndentedString(value)).append("\n"); + sb.append(" ignoreCase: ").append(toIndentedString(ignoreCase)).append("\n"); sb.append("}"); return sb.toString(); } @@ -227,11 +227,6 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format(java.util.Locale.ROOT, "%stype%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getType())))); } - // add `ignoreCase` to the URL query string - if (getIgnoreCase() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%signoreCase%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getIgnoreCase())))); - } - // add `operation` to the URL query string if (getOperation() != null) { joiner.add(String.format(java.util.Locale.ROOT, "%soperation%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getOperation())))); @@ -242,6 +237,11 @@ public String toUrlQueryString(String prefix) { joiner.add(getValue().toUrlQueryString(prefix + "value" + suffix)); } + // add `ignoreCase` to the URL query string + if (getIgnoreCase() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%signoreCase%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getIgnoreCase())))); + } + return joiner.toString(); } static { diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringOperation.java b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringOperation.java new file mode 100644 index 00000000..aec34796 --- /dev/null +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmRuleStringOperation.java @@ -0,0 +1,92 @@ +/** + * Copyright © 2026-2026 ThingsBoard, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.client.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets AlarmRuleStringOperation + */ +public enum AlarmRuleStringOperation { + + EQUAL("EQUAL"), + + NOT_EQUAL("NOT_EQUAL"), + + STARTS_WITH("STARTS_WITH"), + + ENDS_WITH("ENDS_WITH"), + + CONTAINS("CONTAINS"), + + NOT_CONTAINS("NOT_CONTAINS"), + + IN("IN"), + + NOT_IN("NOT_IN"); + + private String value; + + AlarmRuleStringOperation(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static AlarmRuleStringOperation fromValue(String value) { + for (AlarmRuleStringOperation b : AlarmRuleStringOperation.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format(java.util.Locale.ROOT, "%s=%s", prefix, this.toString()); + } + +} + diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleSchedule.java b/pe/src/main/java/org/thingsboard/client/model/AlarmSchedule.java similarity index 81% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleSchedule.java rename to pe/src/main/java/org/thingsboard/client/model/AlarmSchedule.java index 1192bea2..2c4c7537 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleSchedule.java +++ b/pe/src/main/java/org/thingsboard/client/model/AlarmSchedule.java @@ -38,10 +38,10 @@ import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleSchedule + * AlarmSchedule */ @JsonPropertyOrder({ - AlarmRuleSchedule.JSON_PROPERTY_TYPE + AlarmSchedule.JSON_PROPERTY_TYPE }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -50,20 +50,20 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) @JsonSubTypes({ - @JsonSubTypes.Type(value = AlarmRuleAnyTimeSchedule.class, name = "ANY_TIME"), - @JsonSubTypes.Type(value = AlarmRuleCustomTimeSchedule.class, name = "CUSTOM"), - @JsonSubTypes.Type(value = AlarmRuleSpecificTimeSchedule.class, name = "SPECIFIC_TIME"), + @JsonSubTypes.Type(value = AnyTimeSchedule.class, name = "ANY_TIME"), + @JsonSubTypes.Type(value = CustomTimeSchedule.class, name = "CUSTOM"), + @JsonSubTypes.Type(value = SpecificTimeSchedule.class, name = "SPECIFIC_TIME"), }) -public class AlarmRuleSchedule { +public class AlarmSchedule { public static final String JSON_PROPERTY_TYPE = "type"; @Nonnull private String type; - public AlarmRuleSchedule() { + public AlarmSchedule() { } - public AlarmRuleSchedule type(@Nonnull String type) { + public AlarmSchedule type(@Nonnull String type) { this.type = type; return this; } @@ -88,7 +88,7 @@ public void setType(@Nonnull String type) { /** - * Return true if this AlarmRuleSchedule object is equal to o. + * Return true if this AlarmSchedule object is equal to o. */ @Override public boolean equals(Object o) { @@ -98,8 +98,8 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleSchedule alarmRuleSchedule = (AlarmRuleSchedule) o; - return Objects.equals(this.type, alarmRuleSchedule.type); + AlarmSchedule alarmSchedule = (AlarmSchedule) o; + return Objects.equals(this.type, alarmSchedule.type); } @Override @@ -110,7 +110,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleSchedule {\n"); + sb.append("class AlarmSchedule {\n"); sb.append(" type: ").append(toIndentedString(type)).append("\n"); sb.append("}"); return sb.toString(); @@ -169,11 +169,11 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("ANY_TIME", AlarmRuleAnyTimeSchedule.class); - mappings.put("CUSTOM", AlarmRuleCustomTimeSchedule.class); - mappings.put("SPECIFIC_TIME", AlarmRuleSpecificTimeSchedule.class); - mappings.put("AlarmRuleSchedule", AlarmRuleSchedule.class); - JSON.registerDiscriminator(AlarmRuleSchedule.class, "type", mappings); + mappings.put("ANY_TIME", AnyTimeSchedule.class); + mappings.put("CUSTOM", CustomTimeSchedule.class); + mappings.put("SPECIFIC_TIME", SpecificTimeSchedule.class); + mappings.put("AlarmSchedule", AlarmSchedule.class); + JSON.registerDiscriminator(AlarmSchedule.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleAnyTimeSchedule.java b/pe/src/main/java/org/thingsboard/client/model/AnyTimeSchedule.java similarity index 89% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleAnyTimeSchedule.java rename to pe/src/main/java/org/thingsboard/client/model/AnyTimeSchedule.java index d6292653..df07f722 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleAnyTimeSchedule.java +++ b/pe/src/main/java/org/thingsboard/client/model/AnyTimeSchedule.java @@ -31,14 +31,14 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; -import org.thingsboard.client.model.AlarmRuleSchedule; +import org.thingsboard.client.model.AlarmSchedule; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleAnyTimeSchedule + * AnyTimeSchedule */ @JsonPropertyOrder({ }) @@ -49,12 +49,12 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleAnyTimeSchedule extends AlarmRuleSchedule { - public AlarmRuleAnyTimeSchedule() { +public class AnyTimeSchedule extends AlarmSchedule { + public AnyTimeSchedule() { } /** - * Return true if this AlarmRuleAnyTimeSchedule object is equal to o. + * Return true if this AnyTimeSchedule object is equal to o. */ @Override public boolean equals(Object o) { @@ -75,7 +75,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleAnyTimeSchedule {\n"); + sb.append("class AnyTimeSchedule {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append("}"); return sb.toString(); @@ -134,8 +134,8 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleAnyTimeSchedule", AlarmRuleAnyTimeSchedule.class); - JSON.registerDiscriminator(AlarmRuleAnyTimeSchedule.class, "type", mappings); + mappings.put("AnyTimeSchedule", AnyTimeSchedule.class); + JSON.registerDiscriminator(AnyTimeSchedule.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleCustomTimeSchedule.java b/pe/src/main/java/org/thingsboard/client/model/CustomTimeSchedule.java similarity index 80% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleCustomTimeSchedule.java rename to pe/src/main/java/org/thingsboard/client/model/CustomTimeSchedule.java index 2503ab6b..ae2912a9 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleCustomTimeSchedule.java +++ b/pe/src/main/java/org/thingsboard/client/model/CustomTimeSchedule.java @@ -34,19 +34,19 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.List; -import org.thingsboard.client.model.AlarmRuleCustomTimeScheduleItem; -import org.thingsboard.client.model.AlarmRuleSchedule; +import org.thingsboard.client.model.AlarmSchedule; +import org.thingsboard.client.model.CustomTimeScheduleItem; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleCustomTimeSchedule + * CustomTimeSchedule */ @JsonPropertyOrder({ - AlarmRuleCustomTimeSchedule.JSON_PROPERTY_ITEMS, - AlarmRuleCustomTimeSchedule.JSON_PROPERTY_TIMEZONE + CustomTimeSchedule.JSON_PROPERTY_TIMEZONE, + CustomTimeSchedule.JSON_PROPERTY_ITEMS }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -55,76 +55,76 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleCustomTimeSchedule extends AlarmRuleSchedule { - public static final String JSON_PROPERTY_ITEMS = "items"; - @Nullable - private List items = new ArrayList<>(); - +public class CustomTimeSchedule extends AlarmSchedule { public static final String JSON_PROPERTY_TIMEZONE = "timezone"; @Nullable private String timezone; - public AlarmRuleCustomTimeSchedule() { - } + public static final String JSON_PROPERTY_ITEMS = "items"; + @Nullable + private List items = new ArrayList<>(); - public AlarmRuleCustomTimeSchedule items(@Nullable List items) { - this.items = items; - return this; + public CustomTimeSchedule() { } - public AlarmRuleCustomTimeSchedule addItemsItem(AlarmRuleCustomTimeScheduleItem itemsItem) { - if (this.items == null) { - this.items = new ArrayList<>(); - } - this.items.add(itemsItem); + public CustomTimeSchedule timezone(@Nullable String timezone) { + this.timezone = timezone; return this; } /** - * Get items - * @return items + * Get timezone + * @return timezone */ @Nullable - @JsonProperty(value = JSON_PROPERTY_ITEMS, required = false) + @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public List getItems() { - return items; + public String getTimezone() { + return timezone; } - @JsonProperty(value = JSON_PROPERTY_ITEMS, required = false) + @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setItems(@Nullable List items) { - this.items = items; + public void setTimezone(@Nullable String timezone) { + this.timezone = timezone; } - public AlarmRuleCustomTimeSchedule timezone(@Nullable String timezone) { - this.timezone = timezone; + public CustomTimeSchedule items(@Nullable List items) { + this.items = items; + return this; + } + + public CustomTimeSchedule addItemsItem(CustomTimeScheduleItem itemsItem) { + if (this.items == null) { + this.items = new ArrayList<>(); + } + this.items.add(itemsItem); return this; } /** - * Get timezone - * @return timezone + * Get items + * @return items */ @Nullable - @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) + @JsonProperty(value = JSON_PROPERTY_ITEMS, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getTimezone() { - return timezone; + public List getItems() { + return items; } - @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) + @JsonProperty(value = JSON_PROPERTY_ITEMS, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTimezone(@Nullable String timezone) { - this.timezone = timezone; + public void setItems(@Nullable List items) { + this.items = items; } /** - * Return true if this AlarmRuleCustomTimeSchedule object is equal to o. + * Return true if this CustomTimeSchedule object is equal to o. */ @Override public boolean equals(Object o) { @@ -134,24 +134,24 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleCustomTimeSchedule alarmRuleCustomTimeSchedule = (AlarmRuleCustomTimeSchedule) o; - return Objects.equals(this.items, alarmRuleCustomTimeSchedule.items) && - Objects.equals(this.timezone, alarmRuleCustomTimeSchedule.timezone) && + CustomTimeSchedule customTimeSchedule = (CustomTimeSchedule) o; + return Objects.equals(this.timezone, customTimeSchedule.timezone) && + Objects.equals(this.items, customTimeSchedule.items) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(items, timezone, super.hashCode()); + return Objects.hash(timezone, items, super.hashCode()); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleCustomTimeSchedule {\n"); + sb.append("class CustomTimeSchedule {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); - sb.append(" items: ").append(toIndentedString(items)).append("\n"); sb.append(" timezone: ").append(toIndentedString(timezone)).append("\n"); + sb.append(" items: ").append(toIndentedString(items)).append("\n"); sb.append("}"); return sb.toString(); } @@ -204,6 +204,11 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format(java.util.Locale.ROOT, "%stype%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getType())))); } + // add `timezone` to the URL query string + if (getTimezone() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%stimezone%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getTimezone())))); + } + // add `items` to the URL query string if (getItems() != null) { for (int i = 0; i < getItems().size(); i++) { @@ -214,18 +219,13 @@ public String toUrlQueryString(String prefix) { } } - // add `timezone` to the URL query string - if (getTimezone() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%stimezone%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getTimezone())))); - } - return joiner.toString(); } static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleCustomTimeSchedule", AlarmRuleCustomTimeSchedule.class); - JSON.registerDiscriminator(AlarmRuleCustomTimeSchedule.class, "type", mappings); + mappings.put("CustomTimeSchedule", CustomTimeSchedule.class); + JSON.registerDiscriminator(CustomTimeSchedule.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleCustomTimeScheduleItem.java b/pe/src/main/java/org/thingsboard/client/model/CustomTimeScheduleItem.java similarity index 83% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleCustomTimeScheduleItem.java rename to pe/src/main/java/org/thingsboard/client/model/CustomTimeScheduleItem.java index 1152ea55..0e0bf890 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleCustomTimeScheduleItem.java +++ b/pe/src/main/java/org/thingsboard/client/model/CustomTimeScheduleItem.java @@ -34,60 +34,36 @@ import org.thingsboard.client.ApiClient; /** - * AlarmRuleCustomTimeScheduleItem + * CustomTimeScheduleItem */ @JsonPropertyOrder({ - AlarmRuleCustomTimeScheduleItem.JSON_PROPERTY_DAY_OF_WEEK, - AlarmRuleCustomTimeScheduleItem.JSON_PROPERTY_ENABLED, - AlarmRuleCustomTimeScheduleItem.JSON_PROPERTY_ENDS_ON, - AlarmRuleCustomTimeScheduleItem.JSON_PROPERTY_STARTS_ON + CustomTimeScheduleItem.JSON_PROPERTY_ENABLED, + CustomTimeScheduleItem.JSON_PROPERTY_DAY_OF_WEEK, + CustomTimeScheduleItem.JSON_PROPERTY_STARTS_ON, + CustomTimeScheduleItem.JSON_PROPERTY_ENDS_ON }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") -public class AlarmRuleCustomTimeScheduleItem { - public static final String JSON_PROPERTY_DAY_OF_WEEK = "dayOfWeek"; - @Nullable - private Integer dayOfWeek; - +public class CustomTimeScheduleItem { public static final String JSON_PROPERTY_ENABLED = "enabled"; @Nullable private Boolean enabled; - public static final String JSON_PROPERTY_ENDS_ON = "endsOn"; + public static final String JSON_PROPERTY_DAY_OF_WEEK = "dayOfWeek"; @Nullable - private Long endsOn; + private Integer dayOfWeek; public static final String JSON_PROPERTY_STARTS_ON = "startsOn"; @Nullable private Long startsOn; - public AlarmRuleCustomTimeScheduleItem() { - } - - public AlarmRuleCustomTimeScheduleItem dayOfWeek(@Nullable Integer dayOfWeek) { - this.dayOfWeek = dayOfWeek; - return this; - } - - /** - * Get dayOfWeek - * @return dayOfWeek - */ + public static final String JSON_PROPERTY_ENDS_ON = "endsOn"; @Nullable - @JsonProperty(value = JSON_PROPERTY_DAY_OF_WEEK, required = false) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Integer getDayOfWeek() { - return dayOfWeek; - } - + private Long endsOn; - @JsonProperty(value = JSON_PROPERTY_DAY_OF_WEEK, required = false) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDayOfWeek(@Nullable Integer dayOfWeek) { - this.dayOfWeek = dayOfWeek; + public CustomTimeScheduleItem() { } - - public AlarmRuleCustomTimeScheduleItem enabled(@Nullable Boolean enabled) { + public CustomTimeScheduleItem enabled(@Nullable Boolean enabled) { this.enabled = enabled; return this; } @@ -111,31 +87,31 @@ public void setEnabled(@Nullable Boolean enabled) { } - public AlarmRuleCustomTimeScheduleItem endsOn(@Nullable Long endsOn) { - this.endsOn = endsOn; + public CustomTimeScheduleItem dayOfWeek(@Nullable Integer dayOfWeek) { + this.dayOfWeek = dayOfWeek; return this; } /** - * Get endsOn - * @return endsOn + * Get dayOfWeek + * @return dayOfWeek */ @Nullable - @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) + @JsonProperty(value = JSON_PROPERTY_DAY_OF_WEEK, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Long getEndsOn() { - return endsOn; + public Integer getDayOfWeek() { + return dayOfWeek; } - @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) + @JsonProperty(value = JSON_PROPERTY_DAY_OF_WEEK, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndsOn(@Nullable Long endsOn) { - this.endsOn = endsOn; + public void setDayOfWeek(@Nullable Integer dayOfWeek) { + this.dayOfWeek = dayOfWeek; } - public AlarmRuleCustomTimeScheduleItem startsOn(@Nullable Long startsOn) { + public CustomTimeScheduleItem startsOn(@Nullable Long startsOn) { this.startsOn = startsOn; return this; } @@ -159,8 +135,32 @@ public void setStartsOn(@Nullable Long startsOn) { } + public CustomTimeScheduleItem endsOn(@Nullable Long endsOn) { + this.endsOn = endsOn; + return this; + } + + /** + * Get endsOn + * @return endsOn + */ + @Nullable + @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public Long getEndsOn() { + return endsOn; + } + + + @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setEndsOn(@Nullable Long endsOn) { + this.endsOn = endsOn; + } + + /** - * Return true if this AlarmRuleCustomTimeScheduleItem object is equal to o. + * Return true if this CustomTimeScheduleItem object is equal to o. */ @Override public boolean equals(Object o) { @@ -170,26 +170,26 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleCustomTimeScheduleItem alarmRuleCustomTimeScheduleItem = (AlarmRuleCustomTimeScheduleItem) o; - return Objects.equals(this.dayOfWeek, alarmRuleCustomTimeScheduleItem.dayOfWeek) && - Objects.equals(this.enabled, alarmRuleCustomTimeScheduleItem.enabled) && - Objects.equals(this.endsOn, alarmRuleCustomTimeScheduleItem.endsOn) && - Objects.equals(this.startsOn, alarmRuleCustomTimeScheduleItem.startsOn); + CustomTimeScheduleItem customTimeScheduleItem = (CustomTimeScheduleItem) o; + return Objects.equals(this.enabled, customTimeScheduleItem.enabled) && + Objects.equals(this.dayOfWeek, customTimeScheduleItem.dayOfWeek) && + Objects.equals(this.startsOn, customTimeScheduleItem.startsOn) && + Objects.equals(this.endsOn, customTimeScheduleItem.endsOn); } @Override public int hashCode() { - return Objects.hash(dayOfWeek, enabled, endsOn, startsOn); + return Objects.hash(enabled, dayOfWeek, startsOn, endsOn); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleCustomTimeScheduleItem {\n"); - sb.append(" dayOfWeek: ").append(toIndentedString(dayOfWeek)).append("\n"); + sb.append("class CustomTimeScheduleItem {\n"); sb.append(" enabled: ").append(toIndentedString(enabled)).append("\n"); - sb.append(" endsOn: ").append(toIndentedString(endsOn)).append("\n"); + sb.append(" dayOfWeek: ").append(toIndentedString(dayOfWeek)).append("\n"); sb.append(" startsOn: ").append(toIndentedString(startsOn)).append("\n"); + sb.append(" endsOn: ").append(toIndentedString(endsOn)).append("\n"); sb.append("}"); return sb.toString(); } @@ -237,19 +237,14 @@ public String toUrlQueryString(String prefix) { StringJoiner joiner = new StringJoiner("&"); - // add `dayOfWeek` to the URL query string - if (getDayOfWeek() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%sdayOfWeek%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getDayOfWeek())))); - } - // add `enabled` to the URL query string if (getEnabled() != null) { joiner.add(String.format(java.util.Locale.ROOT, "%senabled%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getEnabled())))); } - // add `endsOn` to the URL query string - if (getEndsOn() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%sendsOn%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getEndsOn())))); + // add `dayOfWeek` to the URL query string + if (getDayOfWeek() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sdayOfWeek%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getDayOfWeek())))); } // add `startsOn` to the URL query string @@ -257,6 +252,11 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format(java.util.Locale.ROOT, "%sstartsOn%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getStartsOn())))); } + // add `endsOn` to the URL query string + if (getEndsOn() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sendsOn%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getEndsOn())))); + } + return joiner.toString(); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleDurationCondition.java b/pe/src/main/java/org/thingsboard/client/model/DurationAlarmCondition.java similarity index 83% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleDurationCondition.java rename to pe/src/main/java/org/thingsboard/client/model/DurationAlarmCondition.java index d5d02631..f2964866 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleDurationCondition.java +++ b/pe/src/main/java/org/thingsboard/client/model/DurationAlarmCondition.java @@ -33,10 +33,10 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; +import org.thingsboard.client.model.AlarmCondition; import org.thingsboard.client.model.AlarmConditionExpression; -import org.thingsboard.client.model.AlarmConditionValueAlarmRuleSchedule; +import org.thingsboard.client.model.AlarmConditionValueAlarmSchedule; import org.thingsboard.client.model.AlarmConditionValueLong; -import org.thingsboard.client.model.AlarmRuleCondition; import org.thingsboard.client.model.TimeUnit; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -44,11 +44,11 @@ import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleDurationCondition + * DurationAlarmCondition */ @JsonPropertyOrder({ - AlarmRuleDurationCondition.JSON_PROPERTY_UNIT, - AlarmRuleDurationCondition.JSON_PROPERTY_VALUE + DurationAlarmCondition.JSON_PROPERTY_UNIT, + DurationAlarmCondition.JSON_PROPERTY_VALUE }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -57,7 +57,7 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleDurationCondition extends AlarmRuleCondition { +public class DurationAlarmCondition extends AlarmCondition { public static final String JSON_PROPERTY_UNIT = "unit"; @Nonnull private TimeUnit unit; @@ -66,10 +66,10 @@ public class AlarmRuleDurationCondition extends AlarmRuleCondition { @Nonnull private AlarmConditionValueLong value; - public AlarmRuleDurationCondition() { + public DurationAlarmCondition() { } - public AlarmRuleDurationCondition unit(@Nonnull TimeUnit unit) { + public DurationAlarmCondition unit(@Nonnull TimeUnit unit) { this.unit = unit; return this; } @@ -93,7 +93,7 @@ public void setUnit(@Nonnull TimeUnit unit) { } - public AlarmRuleDurationCondition value(@Nonnull AlarmConditionValueLong value) { + public DurationAlarmCondition value(@Nonnull AlarmConditionValueLong value) { this.value = value; return this; } @@ -118,19 +118,19 @@ public void setValue(@Nonnull AlarmConditionValueLong value) { @Override - public AlarmRuleDurationCondition expression(@Nonnull AlarmConditionExpression expression) { + public DurationAlarmCondition expression(@Nonnull AlarmConditionExpression expression) { this.setExpression(expression); return this; } @Override - public AlarmRuleDurationCondition schedule(@Nullable AlarmConditionValueAlarmRuleSchedule schedule) { + public DurationAlarmCondition schedule(@Nullable AlarmConditionValueAlarmSchedule schedule) { this.setSchedule(schedule); return this; } /** - * Return true if this AlarmRuleDurationCondition object is equal to o. + * Return true if this DurationAlarmCondition object is equal to o. */ @Override public boolean equals(Object o) { @@ -140,9 +140,9 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleDurationCondition alarmRuleDurationCondition = (AlarmRuleDurationCondition) o; - return Objects.equals(this.unit, alarmRuleDurationCondition.unit) && - Objects.equals(this.value, alarmRuleDurationCondition.value) && + DurationAlarmCondition durationAlarmCondition = (DurationAlarmCondition) o; + return Objects.equals(this.unit, durationAlarmCondition.unit) && + Objects.equals(this.value, durationAlarmCondition.value) && super.equals(o); } @@ -154,7 +154,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleDurationCondition {\n"); + sb.append("class DurationAlarmCondition {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" unit: ").append(toIndentedString(unit)).append("\n"); sb.append(" value: ").append(toIndentedString(value)).append("\n"); @@ -235,8 +235,8 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleDurationCondition", AlarmRuleDurationCondition.class); - JSON.registerDiscriminator(AlarmRuleDurationCondition.class, "type", mappings); + mappings.put("DurationAlarmCondition", DurationAlarmCondition.class); + JSON.registerDiscriminator(DurationAlarmCondition.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNoDataFilterPredicate.java b/pe/src/main/java/org/thingsboard/client/model/NoDataFilterPredicate.java similarity index 84% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleNoDataFilterPredicate.java rename to pe/src/main/java/org/thingsboard/client/model/NoDataFilterPredicate.java index aa93a1de..69c4103f 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleNoDataFilterPredicate.java +++ b/pe/src/main/java/org/thingsboard/client/model/NoDataFilterPredicate.java @@ -41,11 +41,11 @@ import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleNoDataFilterPredicate + * NoDataFilterPredicate */ @JsonPropertyOrder({ - AlarmRuleNoDataFilterPredicate.JSON_PROPERTY_DURATION, - AlarmRuleNoDataFilterPredicate.JSON_PROPERTY_UNIT + NoDataFilterPredicate.JSON_PROPERTY_UNIT, + NoDataFilterPredicate.JSON_PROPERTY_DURATION }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -54,68 +54,68 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleNoDataFilterPredicate extends AlarmRuleKeyFilterPredicate { - public static final String JSON_PROPERTY_DURATION = "duration"; - @Nonnull - private AlarmConditionValueLong duration; - +public class NoDataFilterPredicate extends AlarmRuleKeyFilterPredicate { public static final String JSON_PROPERTY_UNIT = "unit"; @Nonnull private TimeUnit unit; - public AlarmRuleNoDataFilterPredicate() { + public static final String JSON_PROPERTY_DURATION = "duration"; + @Nonnull + private AlarmConditionValueLong duration; + + public NoDataFilterPredicate() { } - public AlarmRuleNoDataFilterPredicate duration(@Nonnull AlarmConditionValueLong duration) { - this.duration = duration; + public NoDataFilterPredicate unit(@Nonnull TimeUnit unit) { + this.unit = unit; return this; } /** - * Get duration - * @return duration + * Get unit + * @return unit */ @Nonnull - @JsonProperty(value = JSON_PROPERTY_DURATION, required = true) + @JsonProperty(value = JSON_PROPERTY_UNIT, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public AlarmConditionValueLong getDuration() { - return duration; + public TimeUnit getUnit() { + return unit; } - @JsonProperty(value = JSON_PROPERTY_DURATION, required = true) + @JsonProperty(value = JSON_PROPERTY_UNIT, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setDuration(@Nonnull AlarmConditionValueLong duration) { - this.duration = duration; + public void setUnit(@Nonnull TimeUnit unit) { + this.unit = unit; } - public AlarmRuleNoDataFilterPredicate unit(@Nonnull TimeUnit unit) { - this.unit = unit; + public NoDataFilterPredicate duration(@Nonnull AlarmConditionValueLong duration) { + this.duration = duration; return this; } /** - * Get unit - * @return unit + * Get duration + * @return duration */ @Nonnull - @JsonProperty(value = JSON_PROPERTY_UNIT, required = true) + @JsonProperty(value = JSON_PROPERTY_DURATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public TimeUnit getUnit() { - return unit; + public AlarmConditionValueLong getDuration() { + return duration; } - @JsonProperty(value = JSON_PROPERTY_UNIT, required = true) + @JsonProperty(value = JSON_PROPERTY_DURATION, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setUnit(@Nonnull TimeUnit unit) { - this.unit = unit; + public void setDuration(@Nonnull AlarmConditionValueLong duration) { + this.duration = duration; } /** - * Return true if this AlarmRuleNoDataFilterPredicate object is equal to o. + * Return true if this NoDataFilterPredicate object is equal to o. */ @Override public boolean equals(Object o) { @@ -125,24 +125,24 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleNoDataFilterPredicate alarmRuleNoDataFilterPredicate = (AlarmRuleNoDataFilterPredicate) o; - return Objects.equals(this.duration, alarmRuleNoDataFilterPredicate.duration) && - Objects.equals(this.unit, alarmRuleNoDataFilterPredicate.unit) && + NoDataFilterPredicate noDataFilterPredicate = (NoDataFilterPredicate) o; + return Objects.equals(this.unit, noDataFilterPredicate.unit) && + Objects.equals(this.duration, noDataFilterPredicate.duration) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(duration, unit, super.hashCode()); + return Objects.hash(unit, duration, super.hashCode()); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleNoDataFilterPredicate {\n"); + sb.append("class NoDataFilterPredicate {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); - sb.append(" duration: ").append(toIndentedString(duration)).append("\n"); sb.append(" unit: ").append(toIndentedString(unit)).append("\n"); + sb.append(" duration: ").append(toIndentedString(duration)).append("\n"); sb.append("}"); return sb.toString(); } @@ -195,23 +195,23 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format(java.util.Locale.ROOT, "%stype%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getType())))); } - // add `duration` to the URL query string - if (getDuration() != null) { - joiner.add(getDuration().toUrlQueryString(prefix + "duration" + suffix)); - } - // add `unit` to the URL query string if (getUnit() != null) { joiner.add(String.format(java.util.Locale.ROOT, "%sunit%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getUnit())))); } + // add `duration` to the URL query string + if (getDuration() != null) { + joiner.add(getDuration().toUrlQueryString(prefix + "duration" + suffix)); + } + return joiner.toString(); } static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleNoDataFilterPredicate", AlarmRuleNoDataFilterPredicate.class); - JSON.registerDiscriminator(AlarmRuleNoDataFilterPredicate.class, "type", mappings); + mappings.put("NoDataFilterPredicate", NoDataFilterPredicate.class); + JSON.registerDiscriminator(NoDataFilterPredicate.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleRepeatingCondition.java b/pe/src/main/java/org/thingsboard/client/model/RepeatingAlarmCondition.java similarity index 83% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleRepeatingCondition.java rename to pe/src/main/java/org/thingsboard/client/model/RepeatingAlarmCondition.java index 65a77f5f..c19f598a 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleRepeatingCondition.java +++ b/pe/src/main/java/org/thingsboard/client/model/RepeatingAlarmCondition.java @@ -33,20 +33,20 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; +import org.thingsboard.client.model.AlarmCondition; import org.thingsboard.client.model.AlarmConditionExpression; -import org.thingsboard.client.model.AlarmConditionValueAlarmRuleSchedule; +import org.thingsboard.client.model.AlarmConditionValueAlarmSchedule; import org.thingsboard.client.model.AlarmConditionValueInteger; -import org.thingsboard.client.model.AlarmRuleCondition; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleRepeatingCondition + * RepeatingAlarmCondition */ @JsonPropertyOrder({ - AlarmRuleRepeatingCondition.JSON_PROPERTY_COUNT + RepeatingAlarmCondition.JSON_PROPERTY_COUNT }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -55,15 +55,15 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleRepeatingCondition extends AlarmRuleCondition { +public class RepeatingAlarmCondition extends AlarmCondition { public static final String JSON_PROPERTY_COUNT = "count"; @Nonnull private AlarmConditionValueInteger count; - public AlarmRuleRepeatingCondition() { + public RepeatingAlarmCondition() { } - public AlarmRuleRepeatingCondition count(@Nonnull AlarmConditionValueInteger count) { + public RepeatingAlarmCondition count(@Nonnull AlarmConditionValueInteger count) { this.count = count; return this; } @@ -88,19 +88,19 @@ public void setCount(@Nonnull AlarmConditionValueInteger count) { @Override - public AlarmRuleRepeatingCondition expression(@Nonnull AlarmConditionExpression expression) { + public RepeatingAlarmCondition expression(@Nonnull AlarmConditionExpression expression) { this.setExpression(expression); return this; } @Override - public AlarmRuleRepeatingCondition schedule(@Nullable AlarmConditionValueAlarmRuleSchedule schedule) { + public RepeatingAlarmCondition schedule(@Nullable AlarmConditionValueAlarmSchedule schedule) { this.setSchedule(schedule); return this; } /** - * Return true if this AlarmRuleRepeatingCondition object is equal to o. + * Return true if this RepeatingAlarmCondition object is equal to o. */ @Override public boolean equals(Object o) { @@ -110,8 +110,8 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleRepeatingCondition alarmRuleRepeatingCondition = (AlarmRuleRepeatingCondition) o; - return Objects.equals(this.count, alarmRuleRepeatingCondition.count) && + RepeatingAlarmCondition repeatingAlarmCondition = (RepeatingAlarmCondition) o; + return Objects.equals(this.count, repeatingAlarmCondition.count) && super.equals(o); } @@ -123,7 +123,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleRepeatingCondition {\n"); + sb.append("class RepeatingAlarmCondition {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append(" count: ").append(toIndentedString(count)).append("\n"); sb.append("}"); @@ -198,8 +198,8 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleRepeatingCondition", AlarmRuleRepeatingCondition.class); - JSON.registerDiscriminator(AlarmRuleRepeatingCondition.class, "type", mappings); + mappings.put("RepeatingAlarmCondition", RepeatingAlarmCondition.class); + JSON.registerDiscriminator(RepeatingAlarmCondition.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleSimpleCondition.java b/pe/src/main/java/org/thingsboard/client/model/SimpleAlarmCondition.java similarity index 85% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleSimpleCondition.java rename to pe/src/main/java/org/thingsboard/client/model/SimpleAlarmCondition.java index 2c40aa83..200ce71b 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleSimpleCondition.java +++ b/pe/src/main/java/org/thingsboard/client/model/SimpleAlarmCondition.java @@ -33,16 +33,16 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; +import org.thingsboard.client.model.AlarmCondition; import org.thingsboard.client.model.AlarmConditionExpression; -import org.thingsboard.client.model.AlarmConditionValueAlarmRuleSchedule; -import org.thingsboard.client.model.AlarmRuleCondition; +import org.thingsboard.client.model.AlarmConditionValueAlarmSchedule; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleSimpleCondition + * SimpleAlarmCondition */ @JsonPropertyOrder({ }) @@ -53,24 +53,24 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleSimpleCondition extends AlarmRuleCondition { - public AlarmRuleSimpleCondition() { +public class SimpleAlarmCondition extends AlarmCondition { + public SimpleAlarmCondition() { } @Override - public AlarmRuleSimpleCondition expression(@Nonnull AlarmConditionExpression expression) { + public SimpleAlarmCondition expression(@Nonnull AlarmConditionExpression expression) { this.setExpression(expression); return this; } @Override - public AlarmRuleSimpleCondition schedule(@Nullable AlarmConditionValueAlarmRuleSchedule schedule) { + public SimpleAlarmCondition schedule(@Nullable AlarmConditionValueAlarmSchedule schedule) { this.setSchedule(schedule); return this; } /** - * Return true if this AlarmRuleSimpleCondition object is equal to o. + * Return true if this SimpleAlarmCondition object is equal to o. */ @Override public boolean equals(Object o) { @@ -91,7 +91,7 @@ public int hashCode() { @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleSimpleCondition {\n"); + sb.append("class SimpleAlarmCondition {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); sb.append("}"); return sb.toString(); @@ -160,8 +160,8 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleSimpleCondition", AlarmRuleSimpleCondition.class); - JSON.registerDiscriminator(AlarmRuleSimpleCondition.class, "type", mappings); + mappings.put("SimpleAlarmCondition", SimpleAlarmCondition.class); + JSON.registerDiscriminator(SimpleAlarmCondition.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/SimpleAlarmConditionExpression.java b/pe/src/main/java/org/thingsboard/client/model/SimpleAlarmConditionExpression.java index e6a84462..b4faec69 100644 --- a/pe/src/main/java/org/thingsboard/client/model/SimpleAlarmConditionExpression.java +++ b/pe/src/main/java/org/thingsboard/client/model/SimpleAlarmConditionExpression.java @@ -36,8 +36,8 @@ import java.util.Arrays; import java.util.List; import org.thingsboard.client.model.AlarmConditionExpression; -import org.thingsboard.client.model.AlarmRuleConditionFilter; -import org.thingsboard.client.model.ComplexOperation; +import org.thingsboard.client.model.AlarmConditionFilter; +import org.thingsboard.client.model.AlarmRuleComplexOperation; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -60,21 +60,21 @@ public class SimpleAlarmConditionExpression extends AlarmConditionExpression { public static final String JSON_PROPERTY_FILTERS = "filters"; @Nonnull - private List filters = new ArrayList<>(); + private List filters = new ArrayList<>(); public static final String JSON_PROPERTY_OPERATION = "operation"; @Nullable - private ComplexOperation operation; + private AlarmRuleComplexOperation operation; public SimpleAlarmConditionExpression() { } - public SimpleAlarmConditionExpression filters(@Nonnull List filters) { + public SimpleAlarmConditionExpression filters(@Nonnull List filters) { this.filters = filters; return this; } - public SimpleAlarmConditionExpression addFiltersItem(AlarmRuleConditionFilter filtersItem) { + public SimpleAlarmConditionExpression addFiltersItem(AlarmConditionFilter filtersItem) { if (this.filters == null) { this.filters = new ArrayList<>(); } @@ -89,19 +89,19 @@ public SimpleAlarmConditionExpression addFiltersItem(AlarmRuleConditionFilter fi @Nonnull @JsonProperty(value = JSON_PROPERTY_FILTERS, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public List getFilters() { + public List getFilters() { return filters; } @JsonProperty(value = JSON_PROPERTY_FILTERS, required = true) @JsonInclude(value = JsonInclude.Include.ALWAYS) - public void setFilters(@Nonnull List filters) { + public void setFilters(@Nonnull List filters) { this.filters = filters; } - public SimpleAlarmConditionExpression operation(@Nullable ComplexOperation operation) { + public SimpleAlarmConditionExpression operation(@Nullable AlarmRuleComplexOperation operation) { this.operation = operation; return this; } @@ -113,14 +113,14 @@ public SimpleAlarmConditionExpression operation(@Nullable ComplexOperation opera @Nullable @JsonProperty(value = JSON_PROPERTY_OPERATION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public ComplexOperation getOperation() { + public AlarmRuleComplexOperation getOperation() { return operation; } @JsonProperty(value = JSON_PROPERTY_OPERATION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setOperation(@Nullable ComplexOperation operation) { + public void setOperation(@Nullable AlarmRuleComplexOperation operation) { this.operation = operation; } diff --git a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleSpecificTimeSchedule.java b/pe/src/main/java/org/thingsboard/client/model/SpecificTimeSchedule.java similarity index 83% rename from pe/src/main/java/org/thingsboard/client/model/AlarmRuleSpecificTimeSchedule.java rename to pe/src/main/java/org/thingsboard/client/model/SpecificTimeSchedule.java index 1743bd11..91c49425 100644 --- a/pe/src/main/java/org/thingsboard/client/model/AlarmRuleSpecificTimeSchedule.java +++ b/pe/src/main/java/org/thingsboard/client/model/SpecificTimeSchedule.java @@ -35,20 +35,20 @@ import java.util.Arrays; import java.util.LinkedHashSet; import java.util.Set; -import org.thingsboard.client.model.AlarmRuleSchedule; +import org.thingsboard.client.model.AlarmSchedule; import com.fasterxml.jackson.annotation.JsonPropertyOrder; import org.thingsboard.client.JSON; import org.thingsboard.client.ApiClient; /** - * AlarmRuleSpecificTimeSchedule + * SpecificTimeSchedule */ @JsonPropertyOrder({ - AlarmRuleSpecificTimeSchedule.JSON_PROPERTY_DAYS_OF_WEEK, - AlarmRuleSpecificTimeSchedule.JSON_PROPERTY_ENDS_ON, - AlarmRuleSpecificTimeSchedule.JSON_PROPERTY_STARTS_ON, - AlarmRuleSpecificTimeSchedule.JSON_PROPERTY_TIMEZONE + SpecificTimeSchedule.JSON_PROPERTY_TIMEZONE, + SpecificTimeSchedule.JSON_PROPERTY_DAYS_OF_WEEK, + SpecificTimeSchedule.JSON_PROPERTY_STARTS_ON, + SpecificTimeSchedule.JSON_PROPERTY_ENDS_ON }) @Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", comments = "Generator version: 7.20.0") @JsonIgnoreProperties( @@ -57,32 +57,56 @@ ) @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type", visible = true) -public class AlarmRuleSpecificTimeSchedule extends AlarmRuleSchedule { +public class SpecificTimeSchedule extends AlarmSchedule { + public static final String JSON_PROPERTY_TIMEZONE = "timezone"; + @Nullable + private String timezone; + public static final String JSON_PROPERTY_DAYS_OF_WEEK = "daysOfWeek"; @Nullable private Set daysOfWeek = new LinkedHashSet<>(); + public static final String JSON_PROPERTY_STARTS_ON = "startsOn"; + @Nullable + private Long startsOn; + public static final String JSON_PROPERTY_ENDS_ON = "endsOn"; @Nullable private Long endsOn; - public static final String JSON_PROPERTY_STARTS_ON = "startsOn"; - @Nullable - private Long startsOn; + public SpecificTimeSchedule() { + } - public static final String JSON_PROPERTY_TIMEZONE = "timezone"; + public SpecificTimeSchedule timezone(@Nullable String timezone) { + this.timezone = timezone; + return this; + } + + /** + * Get timezone + * @return timezone + */ @Nullable - private String timezone; + @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public String getTimezone() { + return timezone; + } - public AlarmRuleSpecificTimeSchedule() { + + @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) + @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) + public void setTimezone(@Nullable String timezone) { + this.timezone = timezone; } - public AlarmRuleSpecificTimeSchedule daysOfWeek(@Nullable Set daysOfWeek) { + + public SpecificTimeSchedule daysOfWeek(@Nullable Set daysOfWeek) { this.daysOfWeek = daysOfWeek; return this; } - public AlarmRuleSpecificTimeSchedule addDaysOfWeekItem(Integer daysOfWeekItem) { + public SpecificTimeSchedule addDaysOfWeekItem(Integer daysOfWeekItem) { if (this.daysOfWeek == null) { this.daysOfWeek = new LinkedHashSet<>(); } @@ -110,31 +134,7 @@ public void setDaysOfWeek(@Nullable Set daysOfWeek) { } - public AlarmRuleSpecificTimeSchedule endsOn(@Nullable Long endsOn) { - this.endsOn = endsOn; - return this; - } - - /** - * Get endsOn - * @return endsOn - */ - @Nullable - @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Long getEndsOn() { - return endsOn; - } - - - @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) - @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setEndsOn(@Nullable Long endsOn) { - this.endsOn = endsOn; - } - - - public AlarmRuleSpecificTimeSchedule startsOn(@Nullable Long startsOn) { + public SpecificTimeSchedule startsOn(@Nullable Long startsOn) { this.startsOn = startsOn; return this; } @@ -158,32 +158,32 @@ public void setStartsOn(@Nullable Long startsOn) { } - public AlarmRuleSpecificTimeSchedule timezone(@Nullable String timezone) { - this.timezone = timezone; + public SpecificTimeSchedule endsOn(@Nullable Long endsOn) { + this.endsOn = endsOn; return this; } /** - * Get timezone - * @return timezone + * Get endsOn + * @return endsOn */ @Nullable - @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) + @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public String getTimezone() { - return timezone; + public Long getEndsOn() { + return endsOn; } - @JsonProperty(value = JSON_PROPERTY_TIMEZONE, required = false) + @JsonProperty(value = JSON_PROPERTY_ENDS_ON, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setTimezone(@Nullable String timezone) { - this.timezone = timezone; + public void setEndsOn(@Nullable Long endsOn) { + this.endsOn = endsOn; } /** - * Return true if this AlarmRuleSpecificTimeSchedule object is equal to o. + * Return true if this SpecificTimeSchedule object is equal to o. */ @Override public boolean equals(Object o) { @@ -193,28 +193,28 @@ public boolean equals(Object o) { if (o == null || getClass() != o.getClass()) { return false; } - AlarmRuleSpecificTimeSchedule alarmRuleSpecificTimeSchedule = (AlarmRuleSpecificTimeSchedule) o; - return Objects.equals(this.daysOfWeek, alarmRuleSpecificTimeSchedule.daysOfWeek) && - Objects.equals(this.endsOn, alarmRuleSpecificTimeSchedule.endsOn) && - Objects.equals(this.startsOn, alarmRuleSpecificTimeSchedule.startsOn) && - Objects.equals(this.timezone, alarmRuleSpecificTimeSchedule.timezone) && + SpecificTimeSchedule specificTimeSchedule = (SpecificTimeSchedule) o; + return Objects.equals(this.timezone, specificTimeSchedule.timezone) && + Objects.equals(this.daysOfWeek, specificTimeSchedule.daysOfWeek) && + Objects.equals(this.startsOn, specificTimeSchedule.startsOn) && + Objects.equals(this.endsOn, specificTimeSchedule.endsOn) && super.equals(o); } @Override public int hashCode() { - return Objects.hash(daysOfWeek, endsOn, startsOn, timezone, super.hashCode()); + return Objects.hash(timezone, daysOfWeek, startsOn, endsOn, super.hashCode()); } @Override public String toString() { StringBuilder sb = new StringBuilder(); - sb.append("class AlarmRuleSpecificTimeSchedule {\n"); + sb.append("class SpecificTimeSchedule {\n"); sb.append(" ").append(toIndentedString(super.toString())).append("\n"); + sb.append(" timezone: ").append(toIndentedString(timezone)).append("\n"); sb.append(" daysOfWeek: ").append(toIndentedString(daysOfWeek)).append("\n"); - sb.append(" endsOn: ").append(toIndentedString(endsOn)).append("\n"); sb.append(" startsOn: ").append(toIndentedString(startsOn)).append("\n"); - sb.append(" timezone: ").append(toIndentedString(timezone)).append("\n"); + sb.append(" endsOn: ").append(toIndentedString(endsOn)).append("\n"); sb.append("}"); return sb.toString(); } @@ -267,6 +267,11 @@ public String toUrlQueryString(String prefix) { joiner.add(String.format(java.util.Locale.ROOT, "%stype%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getType())))); } + // add `timezone` to the URL query string + if (getTimezone() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%stimezone%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getTimezone())))); + } + // add `daysOfWeek` to the URL query string if (getDaysOfWeek() != null) { int i = 0; @@ -278,19 +283,14 @@ public String toUrlQueryString(String prefix) { i++; } - // add `endsOn` to the URL query string - if (getEndsOn() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%sendsOn%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getEndsOn())))); - } - // add `startsOn` to the URL query string if (getStartsOn() != null) { joiner.add(String.format(java.util.Locale.ROOT, "%sstartsOn%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getStartsOn())))); } - // add `timezone` to the URL query string - if (getTimezone() != null) { - joiner.add(String.format(java.util.Locale.ROOT, "%stimezone%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getTimezone())))); + // add `endsOn` to the URL query string + if (getEndsOn() != null) { + joiner.add(String.format(java.util.Locale.ROOT, "%sendsOn%s=%s", prefix, suffix, ApiClient.urlEncode(ApiClient.valueToString(getEndsOn())))); } return joiner.toString(); @@ -298,8 +298,8 @@ public String toUrlQueryString(String prefix) { static { // Initialize and register the discriminator mappings. Map> mappings = new HashMap>(); - mappings.put("AlarmRuleSpecificTimeSchedule", AlarmRuleSpecificTimeSchedule.class); - JSON.registerDiscriminator(AlarmRuleSpecificTimeSchedule.class, "type", mappings); + mappings.put("SpecificTimeSchedule", SpecificTimeSchedule.class); + JSON.registerDiscriminator(SpecificTimeSchedule.class, "type", mappings); } } diff --git a/pe/src/main/java/org/thingsboard/client/model/TableSortDirection.java b/pe/src/main/java/org/thingsboard/client/model/TableSortDirection.java new file mode 100644 index 00000000..5ac4a9c1 --- /dev/null +++ b/pe/src/main/java/org/thingsboard/client/model/TableSortDirection.java @@ -0,0 +1,80 @@ +/** + * Copyright © 2026-2026 ThingsBoard, Inc. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ +package org.thingsboard.client.model; + +import java.net.URLEncoder; +import java.nio.charset.StandardCharsets; +import java.util.StringJoiner; +import java.util.Objects; +import java.util.Map; +import java.util.HashMap; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; + + +import com.fasterxml.jackson.annotation.JsonCreator; +import com.fasterxml.jackson.annotation.JsonValue; + +/** + * Gets or Sets TableSortDirection + */ +public enum TableSortDirection { + + ASC("ASC"), + + DESC("DESC"); + + private String value; + + TableSortDirection(String value) { + this.value = value; + } + + @JsonValue + public String getValue() { + return value; + } + + @Override + public String toString() { + return String.valueOf(value); + } + + @JsonCreator + public static TableSortDirection fromValue(String value) { + for (TableSortDirection b : TableSortDirection.values()) { + if (b.value.equals(value)) { + return b; + } + } + throw new IllegalArgumentException("Unexpected value '" + value + "'"); + } + + /** + * Convert the instance into URL query string. + * + * @param prefix prefix of the query string + * @return URL query string + */ + public String toUrlQueryString(String prefix) { + if (prefix == null) { + prefix = ""; + } + + return String.format(java.util.Locale.ROOT, "%s=%s", prefix, this.toString()); + } + +} + diff --git a/pe/src/main/java/org/thingsboard/client/model/TableSortOrder.java b/pe/src/main/java/org/thingsboard/client/model/TableSortOrder.java index 7650c765..bc8412cd 100644 --- a/pe/src/main/java/org/thingsboard/client/model/TableSortOrder.java +++ b/pe/src/main/java/org/thingsboard/client/model/TableSortOrder.java @@ -29,7 +29,7 @@ import com.fasterxml.jackson.annotation.JsonTypeName; import com.fasterxml.jackson.annotation.JsonValue; import java.util.Arrays; -import org.thingsboard.client.model.Direction; +import org.thingsboard.client.model.TableSortDirection; import com.fasterxml.jackson.annotation.JsonPropertyOrder; @@ -49,7 +49,7 @@ public class TableSortOrder { public static final String JSON_PROPERTY_DIRECTION = "direction"; @Nullable - private Direction direction; + private TableSortDirection direction; public TableSortOrder() { } @@ -78,7 +78,7 @@ public void setColumn(@Nullable String column) { } - public TableSortOrder direction(@Nullable Direction direction) { + public TableSortOrder direction(@Nullable TableSortDirection direction) { this.direction = direction; return this; } @@ -90,14 +90,14 @@ public TableSortOrder direction(@Nullable Direction direction) { @Nullable @JsonProperty(value = JSON_PROPERTY_DIRECTION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public Direction getDirection() { + public TableSortDirection getDirection() { return direction; } @JsonProperty(value = JSON_PROPERTY_DIRECTION, required = false) @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS) - public void setDirection(@Nullable Direction direction) { + public void setDirection(@Nullable TableSortDirection direction) { this.direction = direction; }