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

Type: object

This schema does not accept additional properties.

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
  • The value must match this pattern: ^[^.]*$
  • Length: between 1 and 128
• serviceType required
  • Type of messaging service such as Kafka or Pulsar...
  • $ref: #/definitions/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/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • 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
• owner
  • Owner of this messaging service.
  • $ref: ../../type/entityReference.json
• href
  • Link to the resource corresponding to this messaging service.
  • $ref: ../../type/basic.json#/definitions/href
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

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: Monday, March 7, 2022