OpenMetadata
Search…
Topic
This schema defines the Topic entity. A topic is a feed into which message are published to by publishers and read from by consumers in a messaging service.
Type: object

Properties

  • id required
  • name required
  • fullyQualifiedName
    • Name that uniquely identifies a topic in the format 'messagingServiceName.topicName'.
    • Type: string
  • displayName
    • Display Name that identifies this topic. It could be title or label from the source services.
    • Type: string
  • description
    • Description of the topic instance.
    • Type: string
  • version
  • updatedAt
  • updatedBy
    • User who made the update.
    • Type: string
  • service required
  • partitions required
    • Number of partitions into which the topic is divided.
    • Type: integer
    • Range: ≥ 1
  • schemaText
    • Schema used for message serialization. Optional as some topics may not have associated schemas.
    • Type: string
  • schemaType
  • cleanupPolicies
  • retentionTime
    • Retention time in milliseconds. For Kafka - retention.ms configuration.
    • Type: number
  • replicationFactor
    • Replication Factor in integer (more than 1).
    • Type: integer
  • maximumMessageSize
    • Maximum message size in bytes. For Kafka - max.message.bytes configuration.
    • Type: integer
  • minimumInSyncReplicas
    • Minimum number replicas in sync to control durability. For Kafka - min.insync.replicas configuration.
    • Type: integer
  • retentionSize
    • Maximum size of a partition in bytes before old data is discarded. For Kafka - retention.bytes configuration.
    • Type: number
    • Default: "-1"
  • owner
  • tags
  • href
  • changeDescription

Type definitions in this schema

topicName

  • Name that identifies a topic.
  • Type: string
  • The value must match this pattern: ^[^.]*$
  • Length: between 1 and 64

schemaType

  • Schema type used for the message.
  • The value is restricted to the following:
    1. 1.
      "Avro"
    2. 2.
      "Protobuf"
    3. 3.
      "JSON"
    4. 4.
      "Other"

cleanupPolicy

  • Topic clean up policy. For Kafka - cleanup.policy configuration.
  • The value is restricted to the following:
    1. 1.
      "delete"
    2. 2.
      "compact"
This document was updated on: Monday, November 15, 2021
Last modified 10d ago