<!-- # hard line break macro for HTML -->

# fiftyone.operators.message

FiftyOne operator messages.

Copyright 2017-2026, Voxel51, Inc.
<br/>
[voxel51.com](https://voxel51.com/)
<br/>
<br/>

**Classes:**

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

### *class* fiftyone.operators.message.MessageType(\*values)

Bases: `Enum`

Message types.

**Attributes:**

| [`SUCCESS`](#fiftyone.operators.message.MessageType.SUCCESS)   |    |
|----------------------------------------------------------------|----|
| [`ERROR`](#fiftyone.operators.message.MessageType.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`](#fiftyone.operators.message.GeneratedMessage.to_json)()           |    |
|-------------------------------------------------------------------------------|----|
| [`to_json_line`](#fiftyone.operators.message.GeneratedMessage.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`](#fiftyone.operators.message.MessageMetadata.operation_type)   |    |
|----------------------------------------------------------------------------------|----|
| [`dataset_id`](#fiftyone.operators.message.MessageMetadata.dataset_id)           |    |
| [`timestamp`](#fiftyone.operators.message.MessageMetadata.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](#fiftyone.operators.message.MessageMetadata))

Bases: `object`

Data structure for messages sent by the notification service.

**Attributes:**

| [`key`](#fiftyone.operators.message.MessageData.key)           |    |
|----------------------------------------------------------------|----|
| [`value`](#fiftyone.operators.message.MessageData.value)       |    |
| [`metadata`](#fiftyone.operators.message.MessageData.metadata) |    |

**Methods:**

| [`from_dict`](#fiftyone.operators.message.MessageData.from_dict)(data)     | Create a MessageData instance from a dictionary.   |
|----------------------------------------------------------------------------|----------------------------------------------------|
| [`from_json`](#fiftyone.operators.message.MessageData.from_json)(json_str) | Create a MessageData instance from a JSON string.  |
| [`to_dict`](#fiftyone.operators.message.MessageData.to_dict)()             | Convert the MessageData instance to a dictionary.  |
| [`to_json`](#fiftyone.operators.message.MessageData.to_json)()             | Convert the MessageData instance to a JSON string. |

#### key *: str*

#### value *: Any*

#### metadata *: [MessageMetadata](#fiftyone.operators.message.MessageMetadata)*

#### *classmethod* from_dict(data: Dict[str, Any]) → [MessageData](#fiftyone.operators.message.MessageData)

Create a MessageData instance from a dictionary.

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

#### *classmethod* from_json(json_str: str) → [MessageData](#fiftyone.operators.message.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