Skip to content

PropertyDefinitionRequest

Source code in docs_src/capo_iottwinmaker/types/property_definition_request.py 
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class PropertyDefinitionRequest(TypedDict, closed=True):
    data_type: NotRequired["capo_iottwinmaker.types.data_type.DataType"]
    """<p>An object that contains information about the data type.</p>"""
    is_required_in_entity: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether the property is required.</p>"""
    is_external_id: NotRequired["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: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether the property is stored externally.</p>"""
    is_time_series: NotRequired["capo_iottwinmaker.types.boolean.Boolean"]
    """<p>A Boolean value that specifies whether the property consists of time series data.</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. Use this field to specify information that you read from and write to an external source.</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. Use this field to specify information that you read from and write to an external source.

data_type instance-attribute 

data_type: NotRequired[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: NotRequired[Boolean]

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

is_required_in_entity instance-attribute 

is_required_in_entity: NotRequired[Boolean]

A Boolean value that specifies whether the property is required.

is_stored_externally instance-attribute 

is_stored_externally: NotRequired[Boolean]

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

is_time_series instance-attribute 

is_time_series: NotRequired[Boolean]

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