GetComponentTypeResponse
¶
Source code in docs_src/capo_iottwinmaker/types/get_component_type_response.py
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[CompositeComponentTypesResponse]
This is an object that maps strings to compositeComponentTypes of the componentType. CompositeComponentType is referenced by componentTypeId.
creation_date_time
instance-attribute
¶
creation_date_time: Timestamp
The date and time when the component type was created.
description
instance-attribute
¶
description: NotRequired[Description]
The description of the component type.
extends_from
instance-attribute
¶
extends_from: NotRequired[ExtendsFrom]
The name of the parent component type that this component type extends.
functions
instance-attribute
¶
functions: NotRequired[FunctionsResponse]
An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
is_abstract
instance-attribute
¶
is_abstract: NotRequired[Boolean]
A Boolean value that specifies whether the component type is abstract.
is_schema_initialized
instance-attribute
¶
is_schema_initialized: NotRequired[Boolean]
A Boolean value that specifies whether the component type has a schema initializer and that the schema initializer has run.
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[PropertyDefinitionsResponse]
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[PropertyGroupsResponse]
The maximum number of results to return at one time. The default is 25.
Valid Range: Minimum value of 1. Maximum value of 250.
sync_source
instance-attribute
¶
sync_source: NotRequired[SyncSource]
The syncSource of the SyncJob, if this entity was created by a SyncJob.