Skip to content

UpdateComponentTypeRequest

Source code in docs_src/capo_iottwinmaker/types/update_component_type_request.py
class UpdateComponentTypeRequest(TypedDict, closed=True):
    workspace_id: "capo_iottwinmaker.types.id.Id"
    """<p>The ID of the workspace.</p>"""
    is_singleton: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether an entity can have more than one component of this type.</p>"""
    component_type_id: "capo_iottwinmaker.types.component_type_id.ComponentTypeId"
    """<p>The ID of the component type.</p>"""
    description: NotRequired["capo_iottwinmaker.types.description.Description"]
    """<p>The description of the component type.</p>"""
    property_definitions: NotRequired[
        "capo_iottwinmaker.types.property_definitions_request.PropertyDefinitionsRequest"
    ]
    """<p>An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.</p>"""
    extends_from: NotRequired["capo_iottwinmaker.types.extends_from.ExtendsFrom"]
    """<p>Specifies the component type that this component type extends.</p>"""
    functions: NotRequired["capo_iottwinmaker.types.functions_request.FunctionsRequest"]
    """<p>An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.</p>"""
    property_groups: NotRequired[
        "capo_iottwinmaker.types.property_groups_request.PropertyGroupsRequest"
    ]
    """<p>The property groups.</p>"""
    component_type_name: NotRequired[
        "capo_iottwinmaker.types.component_type_name.ComponentTypeName"
    ]
    """<p>The component type name.</p>"""
    composite_component_types: NotRequired[
        "capo_iottwinmaker.types.composite_component_types_request.CompositeComponentTypesRequest"
    ]
    """<p>This is an object that maps strings to <code>compositeComponentTypes</code> of the <code>componentType</code>. <code>CompositeComponentType</code> is referenced by <code>componentTypeId</code>.</p>"""

component_type_id instance-attribute

component_type_id: ComponentTypeId

The ID of the component type.

component_type_name instance-attribute

component_type_name: NotRequired[ComponentTypeName]

The component type name.

composite_component_types instance-attribute

composite_component_types: NotRequired[CompositeComponentTypesRequest]

This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.

description instance-attribute

description: NotRequired[Description]

The description of the component type.

extends_from instance-attribute

extends_from: NotRequired[ExtendsFrom]

Specifies the component type that this component type extends.

functions instance-attribute

functions: NotRequired[FunctionsRequest]

An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.

is_singleton instance-attribute

is_singleton: NotRequired[Boolean]

A Boolean value that specifies whether an entity can have more than one component of this type.

property_definitions instance-attribute

property_definitions: NotRequired[PropertyDefinitionsRequest]

An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.

property_groups instance-attribute

property_groups: NotRequired[PropertyGroupsRequest]

The property groups.

workspace_id instance-attribute

workspace_id: Id

The ID of the workspace.