Constructor
new MessageBroker(input)
- Description:
- Constructor is passed a destructured object as param.
- Source:
Parameters:
Name |
Type |
Description |
input |
Object
|
Input object.
Properties
Name |
Type |
Description |
name |
string
|
|
client |
Object
|
Message Broker client |
configs |
Map
|
|
|
Methods
getClient() → {Object}
- Description:
- returns the message broker client.
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const kafka = new mdx.Utils.Kafka({brokers: ["kafka-broker-url"]}, kafkaConfigMap);
let messageBrokerClient = kafka.getClient();
Returns:
-
Type
-
Object
getConfigs() → {Map}
- Description:
- returns the message broker configs.
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const kafka = new mdx.Utils.Kafka({brokers: ["kafka-broker-url"]}, kafkaConfigMap);
let messageBrokerConfigs = kafka.getConfigs();
Returns:
-
Type
-
Map
getName() → {string}
- Description:
- returns the message broker name.
- Source:
Example
const mdx = require("@nvidia-mdx/web-api-core");
const kafka = new mdx.Utils.Kafka({brokers: ["kafka-broker-url"]}, kafkaConfigMap);
let messageBrokerName = kafka.getName();
Returns:
-
Type
-
string