Skip to content

Argument.md

Latest commit

 

History

History
70 lines (49 loc) · 2.97 KB

Argument.md

File metadata and controls

70 lines (49 loc) · 2.97 KB

Argument

tb_ce_client.models.Argument

Properties

Name Type Description Notes
ref_entity_id EntityId [optional]
ref_dynamic_source_configuration CfArgumentDynamicSourceConfiguration [optional]
ref_entity_key ReferencedEntityKey [optional]
default_value str [optional]
limit int [optional]
time_window int [optional]

Referenced Types

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

CfArgumentDynamicSourceConfiguration

Name Type Description Notes
type str

CurrentOwnerDynamicSourceConfiguration (extends CfArgumentDynamicSourceConfiguration, type=CURRENT_OWNER)

See CfArgumentDynamicSourceConfiguration for properties.

RelationPathQueryDynamicSourceConfiguration (extends CfArgumentDynamicSourceConfiguration, type=RELATION_PATH_QUERY)

Name Type Description Notes
levels List[RelationPathLevel] [optional]

ReferencedEntityKey

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

EntityType (enum)

TENANT | CUSTOMER | USER | DASHBOARD | ASSET | DEVICE | ALARM | RULE_CHAIN | RULE_NODE | ENTITY_VIEW | … (36 values total)

ArgumentType (enum)

TS_LATEST | ATTRIBUTE | TS_ROLLING

AttributeScope (enum)

CLIENT_SCOPE | SERVER_SCOPE | SHARED_SCOPE

RelationPathLevel

Name Type Description Notes
direction EntitySearchDirection
relation_type str

EntitySearchDirection (enum)

FROM | TO

Conventions

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