This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 6ab5035 [docs] [ISSUE 11526] Update the description of `topic`
(#12375)
6ab5035 is described below
commit 6ab50353cdab2cc45ebc0e4072719a4651ef1202
Author: sijia-w <[email protected]>
AuthorDate: Mon Oct 18 10:10:35 2021 +0200
[docs] [ISSUE 11526] Update the description of `topic` (#12375)
* update versioned docs
* add changes
* correct an error
---
site2/docs/client-libraries-node.md | 4 ++--
site2/website-next/docs/client-libraries-node.md | 2 +-
.../versioned_docs/version-2.7.3/client-libraries-node.md | 4 ++--
.../versioned_docs/version-2.8.0/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.5.0/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.5.1/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.5.2/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.6.0/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.6.1/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.6.2/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.6.3/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.6.4/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.7.0/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.7.1/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.7.2/client-libraries-node.md | 4 ++--
site2/website/versioned_docs/version-2.7.3/client-libraries-node.md | 2 +-
site2/website/versioned_docs/version-2.8.0/client-libraries-node.md | 2 +-
site2/website/versioned_docs/version-2.8.1/client-libraries-node.md | 2 +-
site2/website/versioned_docs/version-2.8.2/client-libraries-node.md | 4 ++--
19 files changed, 34 insertions(+), 34 deletions(-)
diff --git a/site2/docs/client-libraries-node.md
b/site2/docs/client-libraries-node.md
index 78a6b31..a0c4b9d 100644
--- a/site2/docs/client-libraries-node.md
+++ b/site2/docs/client-libraries-node.md
@@ -107,7 +107,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -137,7 +137,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar automatically generates a globally unique name. If you choose to
explicitly assign a name, it needs to be unique across *all* Pulsar clusters,
otherwise the creation operation throws an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer waits
for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error is thrown. If you set
`sendTimeoutMs` to -1, the timeout is set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git a/site2/website-next/docs/client-libraries-node.md
b/site2/website-next/docs/client-libraries-node.md
index 794cb72..d16a484 100644
--- a/site2/website-next/docs/client-libraries-node.md
+++ b/site2/website-next/docs/client-libraries-node.md
@@ -156,7 +156,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar automatically generates a globally unique name. If you choose to
explicitly assign a name, it needs to be unique across *all* Pulsar clusters,
otherwise the creation operation throws an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer waits
for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error is thrown. If you set
`sendTimeoutMs` to -1, the timeout is set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website-next/versioned_docs/version-2.7.3/client-libraries-node.md
b/site2/website-next/versioned_docs/version-2.7.3/client-libraries-node.md
index 3ba0057..9b8ecd4 100644
--- a/site2/website-next/versioned_docs/version-2.7.3/client-libraries-node.md
+++ b/site2/website-next/versioned_docs/version-2.7.3/client-libraries-node.md
@@ -124,7 +124,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -153,7 +153,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website-next/versioned_docs/version-2.8.0/client-libraries-node.md
b/site2/website-next/versioned_docs/version-2.8.0/client-libraries-node.md
index 83fb78d..b1ef130 100644
--- a/site2/website-next/versioned_docs/version-2.8.0/client-libraries-node.md
+++ b/site2/website-next/versioned_docs/version-2.8.0/client-libraries-node.md
@@ -126,7 +126,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -157,7 +157,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar automatically generates a globally unique name. If you choose to
explicitly assign a name, it needs to be unique across *all* Pulsar clusters,
otherwise the creation operation throws an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer waits
for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error is thrown. If you set
`sendTimeoutMs` to -1, the timeout is set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.5.0/client-libraries-node.md
b/site2/website/versioned_docs/version-2.5.0/client-libraries-node.md
index 2e9c039..40f1f1c 100644
--- a/site2/website/versioned_docs/version-2.5.0/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.5.0/client-libraries-node.md
@@ -101,7 +101,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -129,7 +129,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.5.1/client-libraries-node.md
b/site2/website/versioned_docs/version-2.5.1/client-libraries-node.md
index 2d10ce4..1ba8cbf 100644
--- a/site2/website/versioned_docs/version-2.5.1/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.5.1/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.5.2/client-libraries-node.md
b/site2/website/versioned_docs/version-2.5.2/client-libraries-node.md
index 2ceae50..0ee2c9e 100644
--- a/site2/website/versioned_docs/version-2.5.2/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.5.2/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.6.0/client-libraries-node.md
b/site2/website/versioned_docs/version-2.6.0/client-libraries-node.md
index d7f0ca2..55c4c26 100644
--- a/site2/website/versioned_docs/version-2.6.0/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.6.0/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.6.1/client-libraries-node.md
b/site2/website/versioned_docs/version-2.6.1/client-libraries-node.md
index 2d15f6e..08f9d2a 100644
--- a/site2/website/versioned_docs/version-2.6.1/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.6.1/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.6.2/client-libraries-node.md
b/site2/website/versioned_docs/version-2.6.2/client-libraries-node.md
index fee4b27..b4bcc87 100644
--- a/site2/website/versioned_docs/version-2.6.2/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.6.2/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.6.3/client-libraries-node.md
b/site2/website/versioned_docs/version-2.6.3/client-libraries-node.md
index b7d0409..0b44e94 100644
--- a/site2/website/versioned_docs/version-2.6.3/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.6.3/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.6.4/client-libraries-node.md
b/site2/website/versioned_docs/version-2.6.4/client-libraries-node.md
index 4bc21ea..aed8028 100644
--- a/site2/website/versioned_docs/version-2.6.4/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.6.4/client-libraries-node.md
@@ -103,7 +103,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -131,7 +131,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.7.0/client-libraries-node.md
b/site2/website/versioned_docs/version-2.7.0/client-libraries-node.md
index 324ee54..f508c4a 100644
--- a/site2/website/versioned_docs/version-2.7.0/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.7.0/client-libraries-node.md
@@ -106,7 +106,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -134,7 +134,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.7.1/client-libraries-node.md
b/site2/website/versioned_docs/version-2.7.1/client-libraries-node.md
index e8c4b95..c1708a1 100644
--- a/site2/website/versioned_docs/version-2.7.1/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.7.1/client-libraries-node.md
@@ -106,7 +106,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -134,7 +134,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.7.2/client-libraries-node.md
b/site2/website/versioned_docs/version-2.7.2/client-libraries-node.md
index 3b1137b..a067139 100644
--- a/site2/website/versioned_docs/version-2.7.2/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.7.2/client-libraries-node.md
@@ -106,7 +106,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -134,7 +134,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.7.3/client-libraries-node.md
b/site2/website/versioned_docs/version-2.7.3/client-libraries-node.md
index dde8a32..1d36814 100644
--- a/site2/website/versioned_docs/version-2.7.3/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.7.3/client-libraries-node.md
@@ -134,7 +134,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer will publish messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar will automatically generate a globally unique name. If you choose
to explicitly assign a name, it will need to be unique across *all* Pulsar
clusters, otherwise the creation operation will throw an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer will
wait for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error will be thrown. If you set
`sendTimeoutMs` to -1, the timeout will be set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.8.0/client-libraries-node.md
b/site2/website/versioned_docs/version-2.8.0/client-libraries-node.md
index 65997c1..b994071 100644
--- a/site2/website/versioned_docs/version-2.8.0/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.8.0/client-libraries-node.md
@@ -138,7 +138,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar automatically generates a globally unique name. If you choose to
explicitly assign a name, it needs to be unique across *all* Pulsar clusters,
otherwise the creation operation throws an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer waits
for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error is thrown. If you set
`sendTimeoutMs` to -1, the timeout is set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.8.1/client-libraries-node.md
b/site2/website/versioned_docs/version-2.8.1/client-libraries-node.md
index ff41c2f..03c828f 100644
--- a/site2/website/versioned_docs/version-2.8.1/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.8.1/client-libraries-node.md
@@ -138,7 +138,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar automatically generates a globally unique name. If you choose to
explicitly assign a name, it needs to be unique across *all* Pulsar clusters,
otherwise the creation operation throws an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer waits
for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error is thrown. If you set
`sendTimeoutMs` to -1, the timeout is set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
diff --git
a/site2/website/versioned_docs/version-2.8.2/client-libraries-node.md
b/site2/website/versioned_docs/version-2.8.2/client-libraries-node.md
index 62ebe4e..a5072fa 100644
--- a/site2/website/versioned_docs/version-2.8.2/client-libraries-node.md
+++ b/site2/website/versioned_docs/version-2.8.2/client-libraries-node.md
@@ -108,7 +108,7 @@ Here is an example:
```JavaScript
const producer = await client.createProducer({
- topic: 'my-topic',
+ topic: 'my-topic', // or 'my-tenant/my-namespace/my-topic' to specify
topic's tenant and namespace
});
await producer.send({
@@ -138,7 +138,7 @@ Pulsar Node.js producers have the following methods
available:
| Parameter | Description | Default |
| :-------- | :---------- | :------ |
-| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. | |
+| `topic` | The Pulsar [topic](reference-terminology.md#topic) to which the
producer publishes messages. The topic format is `<topic-name>` or
`<tenant-name>/<namespace-name>/<topic-name>`. For example,
`sample/ns1/my-topic`. | |
| `producerName` | A name for the producer. If you do not explicitly assign a
name, Pulsar automatically generates a globally unique name. If you choose to
explicitly assign a name, it needs to be unique across *all* Pulsar clusters,
otherwise the creation operation throws an error. | |
| `sendTimeoutMs` | When publishing a message to a topic, the producer waits
for an acknowledgment from the responsible Pulsar
[broker](reference-terminology.md#broker). If a message is not acknowledged
within the threshold set by this parameter, an error is thrown. If you set
`sendTimeoutMs` to -1, the timeout is set to infinity (and thus removed).
Removing the send timeout is recommended when using Pulsar's [message
de-duplication](cookbooks-deduplication.md) feature. | 30000 |
| `initialSequenceId` | The initial sequence ID of the message. When producer
send message, add sequence ID to message. The ID is increased each time to
send. | |
