ComponentResponse ¶

class ComponentResponse(TypedDict, closed=True):
    component_name: NotRequired["capo_iottwinmaker.types.name.Name"]
    """<p>The name of the component.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the component type.</p>"""
    component_type_id: NotRequired[
        "capo_iottwinmaker.types.component_type_id.ComponentTypeId"
    ]
    """<p>The ID of the component type.</p>"""
    status: NotRequired["capo_iottwinmaker.types.status.Status"]
    """<p>The status 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>"""
    properties: NotRequired[
        "capo_iottwinmaker.types.property_responses.PropertyResponses"
    ]
    """<p>An object that maps strings to the properties to set in the component type. Each string in the mapping must be unique to this object.</p>"""
    property_groups: NotRequired[
        "capo_iottwinmaker.types.component_property_group_responses.ComponentPropertyGroupResponses"
    ]
    """<p>The property groups.</p>"""
    sync_source: NotRequired["capo_iottwinmaker.types.sync_source.SyncSource"]
    """<p>The syncSource of the sync job, if this entity was created by a sync job.</p>"""
    are_all_properties_returned: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>This flag notes whether all properties of the component are returned in the API response. The maximum number of properties returned is 800.</p>"""
    composite_components: NotRequired[
        "capo_iottwinmaker.types.composite_component_response.CompositeComponentResponse"
    ]
    """<p>This lists objects that contain information about the <code>compositeComponents</code>.</p>"""
    are_all_composite_components_returned: NotRequired[
        "capo_iottwinmaker.types.boolean.Boolean"
    ]
    """<p>This flag notes whether all <code>compositeComponents</code> are returned in the API response.</p>"""