mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-07-24 01:40:00 +00:00
13be70e416
* updated documentation * addressing pyline findings * addressing pyline findings * doc update Co-authored-by: parthp2107 <parth@getcollate.io>
1.7 KiB
1.7 KiB
Messaging Service
This schema defines the Messaging Service entity, such as Kafka and Pulsar.
$id: 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
- 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
- description
- Description of a messaging service instance.
- Type:
string
- brokers
required- Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
- $ref: #/definitions/brokers
- schemaRegistry
- Schema registry URL.
- Type:
string - String format must be a "uri"
- ingestionSchedule
- Schedule for running metadata ingestion jobs.
- $ref: ../../type/schedule.json
- href
- Link to the resource corresponding to this messaging service.
- $ref: ../../type/basic.json#/definitions/href
Type definitions in this schema
messagingServiceType
- Type of messaging service - Kafka or Pulsar.
- Type:
string - The value is restricted to the following:
- "Kafka"
- "Pulsar"
brokers
- Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.
- Type:
array- Items
- Type:
string
This document was updated on: Thursday, September 16, 2021