Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
- "lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
- "status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "brSource": "somestring",
+ "brTarget": "somestring",
+ "mmAgentName": "somestring",
+ "topicCount": 1
}
**400**
Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`BrTopic <d_d71baea9d8e4e59bc395ef51f45dff1b>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
- "lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
- "status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "brSource": "somestring",
+ "brTarget": "somestring",
+ "mmAgentName": "somestring",
+ "topicCount": 1
}
**400**
Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "subnet": "somestring"
}
**400**
successful operation
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "subnet": "somestring"
}
**204**
Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "subnet": "somestring"
}
**400**
Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "subnet": "somestring"
}
**400**
Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "subnet": "somestring"
}
**400**
Success
-Type: :ref:`Dmaap <d_4ea0e7758a1f8502222793e4a13b04f7>`
+Type: :ref:`DcaeLocation <d_47d80e451933beb623fcf5257867cbcb>`
**Example:**
.. code-block:: javascript
{
- "accessKeyOwner": "somestring",
- "bridgeAdminTopic": "somestring",
- "dmaapName": "somestring",
- "drProvUrl": "somestring",
+ "central": true,
+ "clli": "somestring",
+ "dcaeLayer": "somestring",
+ "dcaeLocationName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "loggingUrl": "somestring",
- "nodeKey": "somestring",
+ "local": true,
+ "openStackAvailabilityZone": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "topicNsRoot": "somestring",
- "version": "somestring"
+ "subnet": "somestring"
}
**400**
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
"hostName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"status": "EMPTY",
- "statusValid": true,
"version": "somestring"
}
"hostName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"status": "EMPTY",
- "statusValid": true,
"version": "somestring"
}
"hostName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"status": "EMPTY",
- "statusValid": true,
"version": "somestring"
}
"hostName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"status": "EMPTY",
- "statusValid": true,
"version": "somestring"
}
"hostName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"status": "EMPTY",
- "statusValid": true,
"version": "somestring"
}
"hostName": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"status": "EMPTY",
- "statusValid": true,
"version": "somestring"
}
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
"feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
}
**400**
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
},
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
],
"status": "EMPTY",
- "statusValid": true,
"subs": [
{
"bytes": [
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
"logURL": "somestring",
"owner": "somestring",
"status": "EMPTY",
- "statusValid": true,
"subId": "somestring",
"suspended": true,
"use100": true,
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
"feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
}
**400**
"lastMod": "2015-01-01T15:00:00.000Z",
"pubId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"username": "somestring",
"userpwd": "somestring"
}
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
"feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
- "status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
- }
-
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "status": "EMPTY",
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
+ }
+
**400**
^^^^^^^
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Feed <d_289ad39619725df26c9ff382d4c97c75>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
+ "asprClassification": "somestring",
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "feedDescription": "somestring",
"feedId": "somestring",
+ "feedName": "somestring",
+ "feedVersion": "somestring",
+ "formatUuid": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "publishURL": "somestring",
+ "pubs": [
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "dcaeLocationName": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "pubId": "somestring",
+ "status": "EMPTY",
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subs": [
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ },
+ {
+ "bytes": [
+ "somestring",
+ "somestring"
+ ],
+ "dcaeLocationName": "somestring",
+ "deliveryURL": "somestring",
+ "feedId": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "logURL": "somestring",
+ "owner": "somestring",
+ "status": "EMPTY",
+ "subId": "somestring",
+ "suspended": true,
+ "use100": true,
+ "username": "somestring",
+ "userpwd": "somestring"
+ }
+ ],
+ "subscribeURL": "somestring",
+ "suspended": true
}
**400**
"loggingUrl": "somestring",
"nodeKey": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicNsRoot": "somestring",
"version": "somestring"
}
Summary
+++++++
-return MR_Client details
+Associate an MR_Client object to a Topic
Description
+++++++++++
.. raw:: html
- Create a `MR_Client` object.
+ Create a `MR_Client` object.The `dcaeLocation` attribute is used to match an `MR_Cluster` object with the same value, with the intent of localizing message traffic. In legacy implementation, the `clientRole` is granted appropriate permission in AAF. Newer implementions may instead specify an AAF Identity, which will be added to the appropriate `Topic` role.
Request
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
**Example:**
.. code-block:: javascript
{
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "topicURL": "somestring"
}
**400**
Summary
+++++++
-return MR_Client details
+Delete an MR_Client object
Description
+++++++++++
"somestring",
"somestring"
],
+ "clientIdentity": "somestring",
"clientRole": "somestring",
"dcaeLocationName": "somestring",
"fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicURL": "somestring"
}
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
**Example:**
.. code-block:: javascript
{
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "topicURL": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
**Example:**
.. code-block:: javascript
{
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "topicURL": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
**Example:**
.. code-block:: javascript
{
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "topicURL": "somestring"
}
**400**
Summary
+++++++
-return MR_Client details
+Update an MR_Client object
Description
+++++++++++
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>`
**Example:**
.. code-block:: javascript
{
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "topicURL": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
**Example:**
{
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqdn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
}
**400**
"replicationGroup": "somestring",
"sourceReplicationPort": "somestring",
"status": "EMPTY",
- "statusValid": true,
"targetReplicationPort": "somestring",
"topicPort": "somestring",
"topicProtocol": "somestring"
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
**Example:**
{
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqdn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
**Example:**
{
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqdn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
**Example:**
{
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqdn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`MR_Cluster <d_eec7176a0080debe1b19c2dad2e97c24>`
**Example:**
{
"dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "fqdn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "replicationGroup": "somestring",
+ "sourceReplicationPort": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "targetReplicationPort": "somestring",
+ "topicPort": "somestring",
+ "topicProtocol": "somestring"
}
**400**
Summary
+++++++
-return Topic details
+Create a Topic object
Description
+++++++++++
.. raw:: html
- Create `Topic` object.
+ Create `Topic` object.For convenience, the message body may populate the `clients` array, in which case each entry will be added as an `MR_Client`. Beginning in ONAP Dublin Release, dbcapi will create two AAF Roles by default, one each for the publisher and subscriber per topic. MR_Clients can then specify an AAF Identity to be added to the appropriate default Role, avoiding the need to create Role(s) in advance.
Parameters
++++++++++
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
}
**400**
.. code-block:: javascript
{
- "bytes": [
- "somestring",
- "somestring"
- ],
"clients": [
{
"action": [
"somestring",
"somestring"
],
+ "clientIdentity": "somestring",
"clientRole": "somestring",
"dcaeLocationName": "somestring",
"fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicURL": "somestring"
},
{
"somestring",
"somestring"
],
+ "clientIdentity": "somestring",
"clientRole": "somestring",
"dcaeLocationName": "somestring",
"fqtn": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
"mrClientId": "somestring",
"status": "EMPTY",
- "statusValid": true,
"topicURL": "somestring"
}
],
"fqtnStyle": "FQTN_NOT_SPECIFIED",
"globalMrURL": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "numClients": 1,
"owner": "somestring",
"partitionCount": "somestring",
+ "publisherRole": "somestring",
"replicationCase": "REPLICATION_NOT_SPECIFIED",
"replicationCount": "somestring",
"status": "EMPTY",
- "statusValid": true,
+ "subscriberRole": "somestring",
"tnxEnabled": "somestring",
"topicDescription": "somestring",
"topicName": "somestring",
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
}
**400**
Success
-Type: :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>`
+Type: :ref:`Topic <d_2e99841971da81b9d240071b86bf168d>`
**Example:**
.. code-block:: javascript
{
- "dcaeLocationName": "somestring",
- "feedId": "somestring",
+ "clients": [
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ },
+ {
+ "action": [
+ "somestring",
+ "somestring"
+ ],
+ "clientIdentity": "somestring",
+ "clientRole": "somestring",
+ "dcaeLocationName": "somestring",
+ "fqtn": "somestring",
+ "lastMod": "2015-01-01T15:00:00.000Z",
+ "mrClientId": "somestring",
+ "status": "EMPTY",
+ "topicURL": "somestring"
+ }
+ ],
+ "formatUuid": "somestring",
+ "fqtn": "somestring",
+ "fqtnStyle": "FQTN_NOT_SPECIFIED",
+ "globalMrURL": "somestring",
"lastMod": "2015-01-01T15:00:00.000Z",
- "pubId": "somestring",
+ "owner": "somestring",
+ "partitionCount": "somestring",
+ "publisherRole": "somestring",
+ "replicationCase": "REPLICATION_NOT_SPECIFIED",
+ "replicationCount": "somestring",
"status": "EMPTY",
- "statusValid": true,
- "username": "somestring",
- "userpwd": "somestring"
+ "subscriberRole": "somestring",
+ "tnxEnabled": "somestring",
+ "topicDescription": "somestring",
+ "topicName": "somestring",
+ "version": "somestring"
}
**400**
dcaeLocationName | No | string | | |
fqdn | No | string | | |
hostName | No | string | | |
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
version | No | string | | |
.. _d_e926d3fa8701e0cc9c8ed1761b3255cd:
dcaeLocationName | No | string | | |
feedId | No | string | | |
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
pubId | No | string | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
username | No | string | | |
userpwd | No | string | | |
dcaeLocationName | No | string | | |
deliveryURL | No | string | | |
feedId | No | string | | |
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
logURL | No | string | | |
owner | No | string | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
subId | No | string | | |
suspended | No | boolean | | |
use100 | No | boolean | | |
clli | No | string | | |
dcaeLayer | No | string | | |
dcaeLocationName | No | string | | |
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
local | No | boolean | | |
openStackAvailabilityZone | No | string | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
subnet | No | string | | |
.. _d_4ea0e7758a1f8502222793e4a13b04f7:
bridgeAdminTopic | No | string | | |
dmaapName | No | string | | |
drProvUrl | No | string | | |
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
loggingUrl | No | string | | |
nodeKey | No | string | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
topicNsRoot | No | string | | |
version | No | string | | |
feedName | No | string | | |
feedVersion | No | string | | |
formatUuid | No | string | | |
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
logURL | No | string | | |
owner | No | string | | |
publishURL | No | string | | |
pubs | No | array of :ref:`DR_Pub <d_e926d3fa8701e0cc9c8ed1761b3255cd>` | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
subs | No | array of :ref:`DR_Sub <d_48cf328d246f41e1d11a09251b042f02>` | | |
subscribeURL | No | string | | |
suspended | No | boolean | | |
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- action | No | array of string | | |
- clientRole | No | string | | |
- dcaeLocationName | No | string | | |
- fqtn | No | string | | |
- lastMod | No | string | date-time | |
- mrClientId | No | string | | |
+ action | No | array of string | | | one or more actions from the set ('pub', 'sub', 'view') for which this client needs Permission
+ clientIdentity | No | string | | | an AAF identity to be associated to an appropriate topic Role
+ clientRole | No | string | | | an AAF Role to be granted an appropriate Permission. If specified, takes precedence over clientIdentity, for backwards compatibility.
+ dcaeLocationName | No | string | | | a tag indicating a logical deployment site
+ fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ mrClientId | No | string | | | a unique identifier generated by dbcapi for this client
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
- topicURL | No | string | | |
+ topicURL | No | string | | | the URL for a MR instance - typically in the same dcaeLocation - that this client should use to access the topic
.. _d_eec7176a0080debe1b19c2dad2e97c24:
replicationGroup | No | string | | |
sourceReplicationPort | No | string | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
targetReplicationPort | No | string | | |
topicPort | No | string | | |
topicProtocol | No | string | | |
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- lastMod | No | string | date-time | |
+ lastMod | No | string | date-time | | datestamp for last update to this object
mmName | No | string | | |
sourceCluster | No | string | | |
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
targetCluster | No | string | | |
topicCount | No | integer | int32 | |
topics | No | array of string | | |
:header: "Name", "Required", "Type", "Format", "Properties", "Description"
:widths: 20, 10, 15, 15, 30, 25
- bytes | No | array of string | | |
- clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | |
- formatUuid | No | string | | |
- fqtn | No | string | | |
- fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} |
- globalMrURL | No | string | | |
- lastMod | No | string | date-time | |
- numClients | No | integer | int32 | |
- owner | No | string | | |
- partitionCount | No | string | | |
- replicationCase | No | string | | {'enum': ['REPLICATION_NOT_SPECIFIED', 'REPLICATION_NONE', 'REPLICATION_EDGE_TO_CENTRAL', 'REPLICATION_EDGE_TO_CENTRAL_TO_GLOBAL', 'REPLICATION_CENTRAL_TO_EDGE', 'REPLICATION_CENTRAL_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_CENTRAL', 'REPLICATION_GLOBAL_TO_CENTRAL_TO_EDGE', 'REPLICATION_EDGE_TO_FQDN', 'REPLICATION_FQDN_TO_EDGE', 'REPLICATION_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN', 'REPLICATION_EDGE_TO_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN_TO_EDGE']} |
- replicationCount | No | string | | |
+ clients | No | array of :ref:`MR_Client <d_56ff81dc98986e27074d9be2731e3f4c>` | | | an array of `MR_Client` objects associated to this `Topic`
+ formatUuid | No | string | | | a reference to an identifier that describes a data format used for this `Topic`
+ fqtn | No | string | | | Fully Qualified Topic Name constructed by dbcapi, following the rules for `fqtnStyle`
+ fqtnStyle | No | string | | {'enum': ['FQTN_NOT_SPECIFIED', 'FQTN_LEGACY_FORMAT', 'FQTN_PROJECTID_FORMAT', 'FQTN_PROJECTID_VERSION_FORMAT']} | the construction rule for the `fqtn` field
+ globalMrURL | No | string | | | the URL of an outside MR instance
+ lastMod | No | string | date-time | | datestamp for last update to this object
+ owner | No | string | | | a label used to identify who requested this `Topic` to be provisioned. In the future this may be an AAF Identity.
+ partitionCount | No | string | | | the kafka attribute for specifying the number of partitions
+ publisherRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to publish to this `Topic`
+ replicationCase | No | string | | {'enum': ['REPLICATION_NOT_SPECIFIED', 'REPLICATION_NONE', 'REPLICATION_EDGE_TO_CENTRAL', 'REPLICATION_EDGE_TO_CENTRAL_TO_GLOBAL', 'REPLICATION_CENTRAL_TO_EDGE', 'REPLICATION_CENTRAL_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_CENTRAL', 'REPLICATION_GLOBAL_TO_CENTRAL_TO_EDGE', 'REPLICATION_EDGE_TO_FQDN', 'REPLICATION_FQDN_TO_EDGE', 'REPLICATION_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN', 'REPLICATION_EDGE_TO_FQDN_TO_GLOBAL', 'REPLICATION_GLOBAL_TO_FQDN_TO_EDGE']} | An indicator for how this `Topic` should be replicated when there are more than one `MR_Cluster` instances
+ replicationCount | No | string | | | the kafka attribute for specifying replication within an `MR_Cluster` instance
status | No | string | | {'enum': ['EMPTY', 'NEW', 'STAGED', 'VALID', 'INVALID', 'DELETED']} |
- statusValid | No | boolean | | |
+ subscriberRole | No | string | | | a value generated by dbcapi, this AAF Role has permission to subscribe to this `Topic`
tnxEnabled | No | string | | |
- topicDescription | No | string | | |
- topicName | No | string | | |
- version | No | string | | |
+ topicDescription | No | string | | | a description of what this Topic is used for
+ topicName | No | string | | | the short name used by humans, and utilized to construct the `FQTN`
+ version | No | string | | | a hook for any versioning needed for managing a `Topic` over time