Skip to content

EntityPropertyReference

Source code in docs_src/capo_iottwinmaker/types/entity_property_reference.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
class EntityPropertyReference(TypedDict, closed=True):
    component_name: NotRequired["capo_iottwinmaker.types.name.Name"]
    """<p>The name of the component.</p>"""
    component_path: NotRequired["capo_iottwinmaker.types.component_path.ComponentPath"]
    """<p>This string specifies the path to the composite component, starting from the top-level component.</p>"""
    external_id_property: NotRequired[
        "capo_iottwinmaker.types.external_id_property.ExternalIdProperty"
    ]
    """<p>A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.</p>"""
    entity_id: NotRequired["capo_iottwinmaker.types.entity_id.EntityId"]
    """<p>The ID of the entity.</p>"""
    property_name: "capo_iottwinmaker.types.name.Name"
    """<p>The name of the property.</p>"""

component_name instance-attribute 

component_name: NotRequired[Name]

The name of the component.

component_path instance-attribute 

component_path: NotRequired[ComponentPath]

This string specifies the path to the composite component, starting from the top-level component.

entity_id instance-attribute 

entity_id: NotRequired[EntityId]

The ID of the entity.

external_id_property instance-attribute 

external_id_property: NotRequired[ExternalIdProperty]

A mapping of external IDs to property names. External IDs uniquely identify properties from external data stores.

property_name instance-attribute 

property_name: Name

The name of the property.