Skip to content
Permalink
main
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
{
"$id": "https://open-metadata.org/schema/entity/services/messagingService.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Messaging Service",
"description": "This schema defines the Messaging Service entity, such as Kafka and Pulsar.",
"type": "object",
"definitions": {
"messagingServiceType": {
"description": "Type of messaging service - Kafka or Pulsar.",
"type": "string",
"enum": [
"Kafka",
"Pulsar"
],
"javaEnums": [
{
"name": "Kafka"
},
{
"name": "Pulsar"
}
]
},
"brokers": {
"description": "Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.",
"type": "array",
"items": {
"type": "string"
},
"default": null
}
},
"properties": {
"id": {
"description": "Unique identifier of this messaging service instance.",
"$ref": "../../type/basic.json#/definitions/uuid"
},
"name": {
"description": "Name that identifies this messaging service.",
"type": "string",
"minLength": 1,
"maxLength": 128
},
"serviceType": {
"description": "Type of messaging service such as Kafka or Pulsar...",
"$ref": "#/definitions/messagingServiceType"
},
"description": {
"description": "Description of a messaging service instance.",
"type": "string"
},
"displayName": {
"description": "Display Name that identifies this messaging service. It could be title or label from the source services.",
"type": "string"
},
"version" : {
"description": "Metadata version of the entity.",
"$ref": "../../type/entityHistory.json#/definitions/entityVersion"
},
"updatedAt" : {
"description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
"$ref": "../../type/basic.json#/definitions/timestamp"
},
"updatedBy" : {
"description": "User who made the update.",
"type": "string"
},
"brokers": {
"description": "Multiple bootstrap addresses for Kafka. Single proxy address for Pulsar.",
"$ref" : "#/definitions/brokers"
},
"schemaRegistry" : {
"description": "Schema registry URL.",
"type": "string",
"format": "uri"
},
"ingestionSchedule": {
"description": "Schedule for running metadata ingestion jobs.",
"$ref": "../../type/schedule.json"
},
"href": {
"description": "Link to the resource corresponding to this messaging service.",
"$ref": "../../type/basic.json#/definitions/href"
},
"changeDescription": {
"description" : "Change that lead to this version of the entity.",
"$ref": "../../type/entityHistory.json#/definitions/changeDescription"
},
"deleted" : {
"description": "When `true` indicates the entity has been soft deleted.",
"type" : "boolean",
"default": false
}
},
"required": [
"id",
"name",
"serviceType",
"brokers"
],
"additionalProperties": false
}