Skip to content

ComponentSummary

Source code in docs_src/capo_iottwinmaker/types/component_summary.py
class ComponentSummary(TypedDict, closed=True):
    component_name: "capo_iottwinmaker.types.name.Name"
    """<p>The name of the component.</p>"""
    component_type_id: "capo_iottwinmaker.types.component_type_id.ComponentTypeId"
    """<p>The ID of the component type.</p>"""
    defined_in: NotRequired["capo_iottwinmaker.types.string.String"]
    """<p>The name of the property definition set in the request.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the component request.</p>"""
    property_groups: NotRequired[
        "capo_iottwinmaker.types.component_property_group_responses.ComponentPropertyGroupResponses"
    ]
    """<p>The property groups.</p>"""
    status: "capo_iottwinmaker.types.status.Status"
    """<p>The status of the component type.</p>"""
    sync_source: NotRequired["capo_iottwinmaker.types.sync_source.SyncSource"]
    """<p>The <code>syncSource</code> of the sync job, if this entity was created by a sync job.</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>"""

component_name instance-attribute

component_name: 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.

component_type_id instance-attribute

component_type_id: ComponentTypeId

The ID of the component type.

defined_in instance-attribute

defined_in: NotRequired[String]

The name of the property definition set in the request.

description instance-attribute

description: NotRequired[Description]

The description of the component request.

property_groups instance-attribute

property_groups: NotRequired[ComponentPropertyGroupResponses]

The property groups.

status instance-attribute

status: Status

The status of the component type.

sync_source instance-attribute

sync_source: NotRequired[SyncSource]

The syncSource of the sync job, if this entity was created by a sync job.