Skip to content

PropertyDefinitionResponse

Source code in docs_src/capo_iottwinmaker/types/property_definition_response.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class PropertyDefinitionResponse(TypedDict, closed=True):
    data_type: "capo_iottwinmaker.types.data_type.DataType"
    """<p>An object that contains information about the data type.</p>"""
    is_time_series: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property consists of time series data.</p>"""
    is_required_in_entity: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property is required in an entity.</p>"""
    is_external_id: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property ID comes from an external data store.</p>"""
    is_stored_externally: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property is stored externally.</p>"""
    is_imported: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property definition is imported from an external data store.</p>"""
    is_final: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property definition can be updated.</p>"""
    is_inherited: "capo_iottwinmaker.types.boolean.Boolean"
    """<p>A Boolean value that specifies whether the property definition is inherited from a parent entity.</p>"""
    default_value: NotRequired["capo_iottwinmaker.types.data_value.DataValue"]
    """<p>An object that contains the default value.</p>"""
    configuration: NotRequired["capo_iottwinmaker.types.configuration.Configuration"]
    """<p>A mapping that specifies configuration information about the property.</p>"""
    display_name: NotRequired[
        "capo_iottwinmaker.types.property_display_name.PropertyDisplayName"
    ]
    """<p>A friendly name for the property.</p>"""

configuration instance-attribute 

configuration: NotRequired[Configuration]

A mapping that specifies configuration information about the property.

data_type instance-attribute 

data_type: DataType

An object that contains information about the data type.

default_value instance-attribute 

default_value: NotRequired[DataValue]

An object that contains the default value.

display_name instance-attribute 

display_name: NotRequired[PropertyDisplayName]

A friendly name for the property.

is_external_id instance-attribute 

is_external_id: Boolean

A Boolean value that specifies whether the property ID comes from an external data store.

is_final instance-attribute 

is_final: Boolean

A Boolean value that specifies whether the property definition can be updated.

is_imported instance-attribute 

is_imported: Boolean

A Boolean value that specifies whether the property definition is imported from an external data store.

is_inherited instance-attribute 

is_inherited: Boolean

A Boolean value that specifies whether the property definition is inherited from a parent entity.

is_required_in_entity instance-attribute 

is_required_in_entity: Boolean

A Boolean value that specifies whether the property is required in an entity.

is_stored_externally instance-attribute 

is_stored_externally: Boolean

A Boolean value that specifies whether the property is stored externally.

is_time_series instance-attribute 

is_time_series: Boolean

A Boolean value that specifies whether the property consists of time series data.