CommandResultValue Class

The value field of a CommandResultActivity contains metadata related to a command result. An optional extensible data payload may be included if defined by the command activity name. The presence of an error field indicates that the original command failed to complete.

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Constructor

CommandResultValue(*, commandId: str, data: Any | None = None, error: Any | None = None, **extra_data: Any)

Keyword-Only Parameters

Name Description
commandId
Required
data
Default value: None
error
Default value: None

Attributes

command_id

ID of the command.

command_id: str

data

The data field containing optional parameters specific to this command activity, as defined by the name. The value of the data field is a complex type.

data: Any | None

error

The optional error, if the command result indicates a failure.

error: Any | None

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_config: ClassVar[ConfigDict] = {'alias_generator': AliasGenerator(alias=None, validation_alias=<staticmethod(<function CustomBaseModel.validation_alias_generator>)>, serialization_alias=<staticmethod(<function CustomBaseModel.serialization_alias_generator>)>), 'arbitrary_types_allowed': True, 'extra': 'allow', 'populate_by_name': True, 'serialize_by_alias': True, 'validate_by_alias': True, 'validate_by_name': True}