OpenMetadata/docs/openmetadata-apis/schemas/entities/messagingservice.md

# Messaging Service

This schema defines the Messaging Service entity, such as Kafka and Pulsar.

**$id:** [**https://open-metadata.org/schema/entity/services/messagingService.json**](https://open-metadata.org/schema/entity/services/messagingService.json)

Type: `object`

## Properties

* **id** `required`
  * Unique identifier of this messaging service instance.
  * $ref: [../../type/basic.json\#/definitions/uuid](../types/basic.md#uuid)
* **name** `required`
  * Name that identifies this messaging service.
  * Type: `string`
  * Length: between 1 and 64
* **serviceType** `required`
  * Type of messaging service such as Kafka or Pulsar...
  * $ref: [\#/definitions/messagingServiceType](messagingservice.md#messagingservicetype)
* **description**
  * Description of a messaging service instance.
  * Type: `string`
* **brokers** `required`
  * Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
  * $ref: [\#/definitions/brokers](messagingservice.md#brokers)
* **schemaRegistry**
  * Schema registry URL.
  * Type: `string`
  * String format must be a "uri"
* **ingestionSchedule**
  * Schedule for running metadata ingestion jobs.
  * $ref: [../../type/schedule.json](../types/schedule.md)
* **href**
  * Link to the resource corresponding to this messaging service.
  * $ref: [../../type/basic.json\#/definitions/href](../types/basic.md#href)

## Type definitions in this schema

### messagingServiceType

* Type of messaging service - Kafka or Pulsar.
* Type: `string`
* The value is restricted to the following: 
  1. _"Kafka"_
  2. _"Pulsar"_

### brokers

* Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
* Type: `array`
  * **Items**
  * Type: `string`

_This document was updated on: Thursday, August 26, 2021_