Skip to content

Attribute

Source code in docs_src/capo_iotfleetwise/types/attribute.py
class Attribute(TypedDict, closed=True):
    fully_qualified_name: "capo_iotfleetwise.types.string.string"
    """<p>The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be <code>Vehicle.Body.Engine.Type</code>.</p>"""
    data_type: "capo_iotfleetwise.types.node_data_type.NodeDataType"
    """<p>The specified data type of the attribute. </p>"""
    description: NotRequired["capo_iotfleetwise.types.description.description"]
    """<p>A brief description of the attribute.</p>"""
    unit: NotRequired["capo_iotfleetwise.types.string.string"]
    """<p>The scientific unit for the attribute.</p>"""
    allowed_values: NotRequired["capo_iotfleetwise.types.list_of_strings.listOfStrings"]
    """<p>A list of possible values an attribute can be assigned.</p>"""
    min: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The specified possible minimum value of the attribute.</p>"""
    max: NotRequired["capo_iotfleetwise.types.double.double"]
    """<p>The specified possible maximum value of the attribute.</p>"""
    assigned_value: NotRequired["capo_iotfleetwise.types.string.string"]
    """<p>A specified value for the attribute.</p>"""
    default_value: NotRequired["capo_iotfleetwise.types.string.string"]
    """<p>The default value of the attribute.</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>"""

allowed_values instance-attribute

allowed_values: NotRequired[listOfStrings]

A list of possible values an attribute can be assigned.

assigned_value instance-attribute

assigned_value: NotRequired[string]

A specified value for the attribute.

comment instance-attribute

comment: NotRequired[message]

A comment in addition to the description.

data_type instance-attribute

data_type: NodeDataType

The specified data type of the attribute.

default_value instance-attribute

default_value: NotRequired[string]

The default value of the attribute.

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 attribute.

fully_qualified_name instance-attribute

fully_qualified_name: string

The fully qualified name of the attribute. For example, the fully qualified name of an attribute might be Vehicle.Body.Engine.Type.

max instance-attribute

max: NotRequired[double]

The specified possible maximum value of the attribute.

min instance-attribute

min: NotRequired[double]

The specified possible minimum value of the attribute.

unit instance-attribute

unit: NotRequired[string]

The scientific unit for the attribute.