Skip to content

PropertySummary

Source code in docs_src/capo_iottwinmaker/types/property_summary.py
class PropertySummary(TypedDict, closed=True):
    definition: NotRequired[
        "capo_iottwinmaker.types.property_definition_response.PropertyDefinitionResponse"
    ]
    """<p>This is the schema for the property.</p>"""
    property_name: "capo_iottwinmaker.types.name.Name"
    """<p>This is the name of the property.</p>"""
    value: NotRequired["capo_iottwinmaker.types.data_value.DataValue"]
    """<p>This is the value for the property.</p>"""
    are_all_property_values_returned: NotRequired[
        "capo_iottwinmaker.types.boolean.Boolean"
    ]
    """<p>This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.</p>"""

are_all_property_values_returned instance-attribute

are_all_property_values_returned: NotRequired[Boolean]

This flag notes whether all values of a list or map type property are returned in the API response. The maximum number of values per property returned is 50.

definition instance-attribute

definition: NotRequired[PropertyDefinitionResponse]

This is the schema for the property.

property_name instance-attribute

property_name: Name

This is the name of the property.

value instance-attribute

value: NotRequired[DataValue]

This is the value for the property.