The TOPIC_DETAILS collection holds the structural details of all topics that are enabled in current design projects or have otherwise been requested.
A TOPIC_DETAILS entry always has a corresponding TOPIC_RESOURCE entry and their name, nativeIdentifier, projectId and connectorId attributes always match.
{
"_id" : "",
"name" : "",
"nativeIdentifier" : "",
"projectId" : "",
"connectorId" : "",
"partitions" : [],
"keyType" : "",
"messageType" : "",
"readEnabled" : false,
"writeEnabled" : false,
"properties" : {},
"recordTypeDescriptor" : {}
}
Attribute |
Value |
Note |
_id |
A unique identifier for the topic resource. |
|
name |
The given name for the topic resource |
By default, it is the same as the nativeIdentifier |
nativeIdentifier |
The full native name of the topic |
|
projectId |
Reference to the design project (PROJECT_WIP entry) this collection belongs to. |
|
connectorId |
Reference to the connector (CONNECTOR entry) this collection is accessed through. |
|
partitions |
A list of the partition ids in the Topic (int array) |
|
keyType |
The selected (de)serialization type for the topic's keys |
|
messageType |
The selected (de)serialization type for the topic's messages |
|
readEnabled |
Whether reading from the Topic via DTS is enabled |
|
writeEnabled |
Whether writing to the Topic via DTS is enabled |
|
properties |
A map of properties specified for the Topic |
|
recordTypeDescriptor |
A full TypeResource describing the records that will be streamed for the Topic |
|
Published Project Usage
Objects of the TOPIC_DETAILS form will also be used to describe collections in the connectors of published projects.