Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 2.16 KB

File metadata and controls

33 lines (23 loc) · 2.16 KB

ComponentDescriptor

org.thingsboard.client.model.ComponentDescriptor

Properties

Name Type Description Notes
id ComponentDescriptorId JSON object with the descriptor Id. Specify existing descriptor id to update the descriptor. Referencing non-existing descriptor Id will cause error. Omit this field to create new descriptor. [optional]
createdTime Long Timestamp of the descriptor creation, in milliseconds [optional] [readonly]
type ComponentType Type of the Rule Node [optional] [readonly]
scope ComponentScope Scope of the Rule Node. Always set to 'TENANT', since no rule chains on the 'SYSTEM' level yet. [optional] [readonly]
clusteringMode ComponentClusteringMode Clustering mode of the RuleNode. This mode represents the ability to start Rule Node in multiple microservices. [optional] [readonly]
name String Name of the Rule Node. Taken from the @RuleNode annotation. [optional] [readonly]
clazz String Full name of the Java class that implements the Rule Engine Node interface. [optional] [readonly]
configurationDescriptor com.fasterxml.jackson.databind.JsonNode [optional]
configurationVersion Integer Rule node configuration version. By default, this value is 0. If the rule node is a versioned node, this value might be greater than 0. [optional] [readonly]
actions String Rule Node Actions. Deprecated. Always null. [optional] [readonly]
hasQueueName Boolean Indicates that the RuleNode supports queue name configuration. [optional] [readonly]
hasSecrets Boolean Indicates that the RuleNode configuration uses secrets placeholders. [optional] [readonly]

Conventions

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