Skip to content

CommandParameter

Source code in docs_src/capo_iot/types/command_parameter.py
class CommandParameter(TypedDict, closed=True):
    name: "capo_iot.types.command_parameter_name.CommandParameterName"
    """<p>The name of a specific parameter used in a command and command execution.</p>"""
    type: NotRequired["capo_iot.types.command_parameter_type.CommandParameterType"]
    """<p>The type of the command parameter.</p>"""
    value: NotRequired["capo_iot.types.command_parameter_value.CommandParameterValue"]
    """<p>Parameter value that overrides the default value, if set.</p>"""
    default_value: NotRequired[
        "capo_iot.types.command_parameter_value.CommandParameterValue"
    ]
    """<p>The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.</p>"""
    value_conditions: NotRequired[
        "capo_iot.types.command_parameter_value_condition_list.CommandParameterValueConditionList"
    ]
    """<p>The list of conditions that a command parameter value must satisfy to create a command execution.</p>"""
    description: NotRequired[
        "capo_iot.types.command_parameter_description.CommandParameterDescription"
    ]
    """<p>The description of the command parameter.</p>"""

default_value instance-attribute

default_value: NotRequired[CommandParameterValue]

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

description instance-attribute

description: NotRequired[CommandParameterDescription]

The description of the command parameter.

name instance-attribute

The name of a specific parameter used in a command and command execution.

type instance-attribute

type: NotRequired[CommandParameterType]

The type of the command parameter.

value instance-attribute

value: NotRequired[CommandParameterValue]

Parameter value that overrides the default value, if set.

value_conditions instance-attribute

value_conditions: NotRequired[CommandParameterValueConditionList]

The list of conditions that a command parameter value must satisfy to create a command execution.