Skip to content

CustomProperty

Source code in docs_src/capo_iotfleetwise/types/custom_property.py 
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
class CustomProperty(TypedDict, closed=True):
    fully_qualified_name: "capo_iotfleetwise.types.string.string"
    """<p>The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be <code>ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS</code>.</p>"""
    data_type: "capo_iotfleetwise.types.node_data_type.NodeDataType"
    """<p>The data type for the custom property. </p>"""
    data_encoding: NotRequired[
        "capo_iotfleetwise.types.node_data_encoding.NodeDataEncoding"
    ]
    """<p>Indicates whether the property is binary data.</p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>A brief description of the custom property.</p>"""
    deprecation_message: NotRequired["capo_iotfleetwise.types.message.message"]
    """<p>The deprecation message for the node or the branch that was moved or deleted.</p>"""
    comment: NotRequired["capo_iotfleetwise.types.message.message"]
    """<p>A comment in addition to the description.</p>"""
    struct_fully_qualified_name: NotRequired[
        "capo_iotfleetwise.types.node_path.NodePath"
    ]
    """<p>The fully qualified name of the struct node for the custom property if the data type of the custom property is <code>Struct</code> or <code>StructArray</code>. </p>"""

comment instance-attribute 

comment: NotRequired[message]

A comment in addition to the description.

data_encoding instance-attribute 

data_encoding: NotRequired[NodeDataEncoding]

Indicates whether the property is binary data.

data_type instance-attribute 

data_type: NodeDataType

The data type for the custom property.

deprecation_message instance-attribute 

deprecation_message: NotRequired[message]

The deprecation message for the node or the branch that was moved or deleted.

description instance-attribute 

description: NotRequired[description]

A brief description of the custom property.

fully_qualified_name instance-attribute 

fully_qualified_name: string

The fully qualified name of the custom property. For example, the fully qualified name of a custom property might be ComplexDataTypes.VehicleDataTypes.SVMCamera.FPS.

struct_fully_qualified_name instance-attribute 

struct_fully_qualified_name: NotRequired[NodePath]

The fully qualified name of the struct node for the custom property if the data type of the custom property is Struct or StructArray.