2021-08-26 13:33:44 +05:30
|
|
|
# Messaging Service
|
|
|
|
|
|
|
|
|
|
This schema defines the Messaging Service entity, such as Kafka and Pulsar.
|
|
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
**$id: **[**https://open-metadata.org/schema/entity/services/messagingService.json**](https://open-metadata.org/schema/entity/services/messagingService.json)
|
2021-08-26 13:33:44 +05:30
|
|
|
|
|
|
|
|
Type: `object`
|
|
|
|
|
|
|
|
|
|
## Properties
|
|
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
* **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`
|
|
|
|
|
* **displayName**
|
|
|
|
|
* Display Name that identifies this messaging service. It could be title or label from the source services.
|
|
|
|
|
* Type: `string`
|
|
|
|
|
* **version**
|
|
|
|
|
* Metadata version of the entity.
|
|
|
|
|
* $ref: [../../type/basic.json#/definitions/entityVersion](../types/basic.md#entityversion)
|
|
|
|
|
* **updatedAt**
|
|
|
|
|
* Last update time corresponding to the new version of the entity.
|
|
|
|
|
* $ref: [../../type/basic.json#/definitions/dateTime](../types/basic.md#datetime)
|
|
|
|
|
* **updatedBy**
|
|
|
|
|
* User who made the update.
|
|
|
|
|
* 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)
|
2021-08-26 13:33:44 +05:30
|
|
|
|
|
|
|
|
## Type definitions in this schema
|
|
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
### messagingServiceType
|
2021-09-19 08:43:31 +05:30
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
* Type of messaging service - Kafka or Pulsar.
|
|
|
|
|
* Type: `string`
|
|
|
|
|
* The value is restricted to the following:
|
|
|
|
|
1. _"Kafka"_
|
|
|
|
|
2. _"Pulsar"_
|
2021-08-26 13:33:44 +05:30
|
|
|
|
|
|
|
|
### brokers
|
|
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
* Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
|
|
|
|
|
* Type: `array`
|
|
|
|
|
* **Items**
|
|
|
|
|
* Type: `string`
|
2021-10-18 18:02:22 +05:30
|
|
|
|
2021-11-13 23:03:20 +05:30
|
|
|
_This document was updated on: Monday, October 18, 2021_
|
