This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 2255e807fb Docs sync done from apache/pulsar(#5604dd5)
2255e807fb is described below
commit 2255e807fbf949eb6acfdaa935681c4a92c56844
Author: Pulsar Site Updater <[email protected]>
AuthorDate: Wed Apr 20 06:03:09 2022 +0000
Docs sync done from apache/pulsar(#5604dd5)
---
site2/docs/developing-binary-protocol.md | 25 ++++++++++++++--------
site2/docs/security-oauth2.md | 14 ++++++++++++
site2/docs/txn-use.md | 14 ++++++++----
.../docs/developing-binary-protocol.md | 25 ++++++++++++++--------
site2/website-next/docs/security-oauth2.md | 17 +++++++++++++++
site2/website-next/docs/txn-use.md | 13 +++++++----
.../developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.2.1/developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.3.0/developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.3.1/developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.3.2/developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.4.1/developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.4.2/developing-binary-protocol.md | 25 ++++++++++++++--------
.../version-2.5.0/developing-binary-protocol.md | 25 ++++++++++++++--------
14 files changed, 210 insertions(+), 98 deletions(-)
diff --git a/site2/docs/developing-binary-protocol.md
b/site2/docs/developing-binary-protocol.md
index e6c14c60b6..482dcc804a 100644
--- a/site2/docs/developing-binary-protocol.md
+++ b/site2/docs/developing-binary-protocol.md
@@ -361,7 +361,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -406,12 +406,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -446,9 +453,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -460,8 +467,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -504,7 +511,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -566,7 +573,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git a/site2/docs/security-oauth2.md b/site2/docs/security-oauth2.md
index 7bb12ee720..654bd5c8e9 100644
--- a/site2/docs/security-oauth2.md
+++ b/site2/docs/security-oauth2.md
@@ -195,6 +195,20 @@ This example shows how to configure OAuth2 authentication
in Node.js client.
```
> Note: The support for OAuth2 authentication is only available in Node.js
> client 1.6.2 and later versions.
+## Broker configuration
+To enable OAuth2 authentication in brokers, add the following parameters to
the `broker.conf` or `standalone.conf` file.
+```properties
+# Configuration to enable authentication
+authenticationEnabled=true
+authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderToken
+tokenPublicKey=/path/to/publicKey
+# Authentication settings of the broker itself. Used when the broker connects
to other brokers,
+# either in same or other clusters
+brokerClientAuthenticationPlugin=org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2
+brokerClientAuthenticationParameters={"privateKey":"/path/to/privateKey",\
+
"audience":"https://dev-kt-aa9ne.us.auth0.com/api/v2/","issuerUrl":"https://dev-kt-aa9ne.us.auth0.com"}
+```
+
## CLI configuration
This section describes how to use Pulsar CLI tools to connect a cluster
through OAuth2 authentication plugin.
diff --git a/site2/docs/txn-use.md b/site2/docs/txn-use.md
index 3e52bad368..52a10dfbbc 100644
--- a/site2/docs/txn-use.md
+++ b/site2/docs/txn-use.md
@@ -20,21 +20,27 @@ This section provides an example of how to use the
transaction API to send and r
2. Enable transaction.
- Change the configuration in the `broker.conf` file.
+ Change the configuration in the `broker.conf` or `standalone.conf` file.
```
+ //mandatory configuration, used to enable transaction coordinator
transactionCoordinatorEnabled=true
+
+ //mandtory configuration, used to create systemTopic used for transaction
buffer snapshot
systemTopicEnabled=true
+
```
- If you want to enable batch messages in transactions, follow the steps
below.
-
- Set `acknowledgmentAtBatchIndexLevelEnabled` to `true` in the
`broker.conf` or `standalone.conf` file.
+ * If you want to acknowledge batch messages in transactions, set
`acknowledgmentAtBatchIndexLevelEnabled` to `true` in the `broker.conf` or
`standalone.conf` file.
```
acknowledgmentAtBatchIndexLevelEnabled=true
```
+ * If you want to guarantee exactly-once semantics, you need to enable
[message deduplication](cookbooks-deduplication.md).
+ You can enable message deduplication at the broker level, the namespace
level, or the topic level according to your needs.
+
+
3. Initialize transaction coordinator metadata.
The transaction coordinator can leverage the advantages of partitioned
topics (such as load balance).
diff --git a/site2/website-next/docs/developing-binary-protocol.md
b/site2/website-next/docs/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
--- a/site2/website-next/docs/developing-binary-protocol.md
+++ b/site2/website-next/docs/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git a/site2/website-next/docs/security-oauth2.md
b/site2/website-next/docs/security-oauth2.md
index 7545742bf6..20408bd238 100644
--- a/site2/website-next/docs/security-oauth2.md
+++ b/site2/website-next/docs/security-oauth2.md
@@ -215,6 +215,23 @@ This example shows how to configure OAuth2 authentication
in Node.js client.
> Note: The support for OAuth2 authentication is only available in Node.js
> client 1.6.2 and later versions.
+## Broker configuration
+To enable OAuth2 authentication in brokers, add the following parameters to
the `broker.conf` or `standalone.conf` file.
+
+```properties
+
+# Configuration to enable authentication
+authenticationEnabled=true
+authenticationProviders=org.apache.pulsar.broker.authentication.AuthenticationProviderToken
+tokenPublicKey=/path/to/publicKey
+# Authentication settings of the broker itself. Used when the broker connects
to other brokers,
+# either in same or other clusters
+brokerClientAuthenticationPlugin=org.apache.pulsar.client.impl.auth.oauth2.AuthenticationOAuth2
+brokerClientAuthenticationParameters={"privateKey":"/path/to/privateKey",\
+
"audience":"https://dev-kt-aa9ne.us.auth0.com/api/v2/","issuerUrl":"https://dev-kt-aa9ne.us.auth0.com"}
+
+```
+
## CLI configuration
This section describes how to use Pulsar CLI tools to connect a cluster
through OAuth2 authentication plugin.
diff --git a/site2/website-next/docs/txn-use.md
b/site2/website-next/docs/txn-use.md
index 539bd95a46..19b11dd38c 100644
--- a/site2/website-next/docs/txn-use.md
+++ b/site2/website-next/docs/txn-use.md
@@ -20,18 +20,19 @@ This section provides an example of how to use the
transaction API to send and r
2. Enable transaction.
- Change the configuration in the `broker.conf` file.
+ Change the configuration in the `broker.conf` or `standalone.conf` file.
```
+ //mandatory configuration, used to enable transaction coordinator
transactionCoordinatorEnabled=true
+
+ //mandtory configuration, used to create systemTopic used for transaction
buffer snapshot
systemTopicEnabled=true
```
- If you want to enable batch messages in transactions, follow the steps
below.
-
- Set `acknowledgmentAtBatchIndexLevelEnabled` to `true` in the `broker.conf`
or `standalone.conf` file.
+ * If you want to acknowledge batch messages in transactions, set
`acknowledgmentAtBatchIndexLevelEnabled` to `true` in the `broker.conf` or
`standalone.conf` file.
```
@@ -39,6 +40,10 @@ This section provides an example of how to use the
transaction API to send and r
```
+ * If you want to guarantee exactly-once semantics, you need to enable
[message deduplication](cookbooks-deduplication).
+ You can enable message deduplication at the broker level, the namespace
level, or the topic level according to your needs.
+
+
3. Initialize transaction coordinator metadata.
The transaction coordinator can leverage the advantages of partitioned
topics (such as load balance).
diff --git
a/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.1.1-incubating/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.2.1/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.3.0/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.3.1/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.3.2/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.4.1/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.4.2/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
diff --git
a/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
b/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
index 61f15d5a89..c28723ed27 100644
---
a/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
+++
b/site2/website-next/versioned_docs/version-2.5.0/developing-binary-protocol.md
@@ -375,7 +375,7 @@ message CommandFlow {
```
Parameters:
-* `consumer_id` → Id of an already established consumer
+* `consumer_id` → ID of an already established consumer
* `messagePermits` → Number of additional permits to grant to the broker for
pushing more messages
@@ -423,12 +423,19 @@ message CommandAck {
```
Parameters:
- * `consumer_id` → Id of an already established consumer
+ * `consumer_id` → ID of an already established consumer
* `ack_type` → Type of acknowledgment: `Individual` or `Cumulative`
- * `message_id` → Id of the message to acknowledge
+ * `message_id` → ID of the message to acknowledge
* `validation_error` → *(optional)* Indicates that the consumer has discarded
the messages due to: `UncompressedSizeCorruption`,
`DecompressionError`, `ChecksumMismatch`, `BatchDeSerializeError`
+ * `properties` -> *(optional)* Reserved configuration items
+ * `txnid_most_bits` -> *(optional)* Same as TC ID, `txnid_most_bits` and
`txnid_least_bits`
+ uniquely identify a transaction.
+ * `txnid_least_bits` -> *(optional)* The ID of the transaction opened in a TC,
+ `txnid_most_bits` and `txnid_least_bits`uniquely identify a transaction.
+ * `request_id` -> *(optional)* ID for handling response and timeout.
+
##### Command CloseConsumer
@@ -463,9 +470,9 @@ messages are coming from the consumer.
This command is sent by the client to retrieve Subscriber and Consumer level
stats from the broker.
Parameters:
- * `request_id` → Id of the request, used to correlate the request
+ * `request_id` → ID of the request, used to correlate the request
and the response.
- * `consumer_id` → Id of an already established consumer.
+ * `consumer_id` → ID of an already established consumer.
##### Command ConsumerStatsResponse
@@ -477,8 +484,8 @@ If the `error_code` or the `error_message` field is set it
indicates that the re
This command is sent by the client to unsubscribe the `consumer_id` from the
associated topic.
Parameters:
- * `request_id` → Id of the request.
- * `consumer_id` → Id of an already established consumer which needs to
unsubscribe.
+ * `request_id` → ID of the request.
+ * `consumer_id` → ID of an already established consumer which needs to
unsubscribe.
## Service discovery
@@ -522,7 +529,7 @@ message CommandLookupTopic {
Fields:
* `topic` → Topic name to lookup
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
* `authoritative` → Initial lookup request should use false. When following a
redirect response, client should pass the same value contained in the
response
@@ -590,7 +597,7 @@ message CommandPartitionedTopicMetadata {
Fields:
* `topic` → the topic for which to check the partitions metadata
- * `request_id` → Id of the request that will be passed with its response
+ * `request_id` → ID of the request that will be passed with its response
##### Command PartitionedTopicMetadataResponse
