fiftyone.operators.message#

FiftyOne operator messages.

Copyright 2017-2025, Voxel51, Inc.
voxel51.com

Classes:

`MessageType`(value[, names, module, ...])	Message types.
`GeneratedMessage`([type, cls, body])	A message generated by an operator executed as a generator.
`MessageMetadata`([operation_type, ...])	Metadata for a store notification message.
`MessageData`(key, value, metadata)	Data structure for messages sent by the notification service.

class fiftyone.operators.message.MessageType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)#

Bases: Enum

Message types.

Attributes:

`SUCCESS`
`ERROR`

SUCCESS = 'success'#

ERROR = 'error'#

class fiftyone.operators.message.GeneratedMessage(type=MessageType.SUCCESS, cls=None, body=None)#

Bases: object

A message generated by an operator executed as a generator.

Methods:

`to_json`()
`to_json_line`()

to_json()#

to_json_line()#

class fiftyone.operators.message.MessageMetadata(operation_type: str | None = None, dataset_id: str | None = None, timestamp: str | None = None)#

Bases: object

Metadata for a store notification message.

Attributes:

`operation_type`
`dataset_id`
`timestamp`

operation_type: str | None = None#

dataset_id: str | None = None#

timestamp: str | None = None#

class fiftyone.operators.message.MessageData(key: str, value: Any, metadata: MessageMetadata)#

Bases: object

Data structure for messages sent by the notification service.

Attributes:

`key`
`value`
`metadata`

Methods:

`from_dict`(data)	Create a MessageData instance from a dictionary.
`from_json`(json_str)	Create a MessageData instance from a JSON string.
`to_dict`()	Convert the MessageData instance to a dictionary.
`to_json`()	Convert the MessageData instance to a JSON string.

key: str#

value: Any#

metadata: MessageMetadata#

classmethod from_dict(data: Dict[str, Any]) → MessageData#

Create a MessageData instance from a dictionary.

Parameters:: data – Dictionary containing message data
Returns:: MessageData instance

classmethod from_json(json_str: str) → MessageData#

Create a MessageData instance from a JSON string.

Parameters:: json_str – JSON string containing message data
Returns:: MessageData instance

to_dict() → Dict[str, Any]#

Convert the MessageData instance to a dictionary.

Returns:: Dictionary representation

to_json() → str#

Convert the MessageData instance to a JSON string.

Returns:: JSON string representation