MarvinCai commented on a change in pull request #12810:
URL: https://github.com/apache/pulsar/pull/12810#discussion_r749140325
##########
File path: site2/docs/client-libraries-websocket.md
##########
@@ -180,22 +180,59 @@ Server will push messages on the WebSocket session:
```json
{
- "messageId": "CAAQAw==",
- "payload": "SGVsbG8gV29ybGQ=",
- "properties": {"key1": "value1", "key2": "value2"},
- "publishTime": "2016-08-30 16:45:57.785",
- "redeliveryCount": 4
+ "messageId": "CAMQADAA",
+ "payload": "hvXcJvHW7kOSrUn17P2q71RA5SdiXwZBqw==",
+ "properties": {},
+ "publishTime": "2021-10-29T16:01:38.967-07:00",
+ "redeliveryCount": 0,
+ "encryptionContext": {
+ "keys": {
+ "client-rsa.pem": {
+ "keyValue":
"jEuwS+PeUzmCo7IfLNxqoj4h7txbLjCQjkwpaw5AWJfZ2xoIdMkOuWDkOsqgFmWwxiecakS6GOZHs94x3sxzKHQx9Oe1jpwBg2e7L4fd26pp+WmAiLm/ArZJo6JotTeFSvKO3u/yQtGTZojDDQxiqFOQ1ZbMdtMZA8DpSMuq+Zx7PqLo43UdW1+krjQfE5WD+y+qE3LJQfwyVDnXxoRtqWLpVsAROlN2LxaMbaftv5HckoejJoB4xpf/dPOUqhnRstwQHf6klKT5iNhjsY4usACt78uILT0pEPd14h8wEBidBz/vAlC/zVMEqiDVzgNS7dqEYS4iHbf7cnWVCn3Hxw==",
+ "metadata": {}
+ }
+ },
+ "param": "Tfu1PxVm6S9D3+Hk",
+ "compressionType": "NONE",
+ "uncompressedMessageSize": 0,
+ "batchSize": {
+ "empty": false,
+ "present": true
+ }
+ }
}
```
-Key | Type | Required? | Explanation
-:---|:-----|:----------|:-----------
-`messageId` | string | yes | Message ID
-`payload` | string | yes | Base-64 encoded payload
-`publishTime` | string | yes | Publish timestamp
-`redeliveryCount` | number | yes | Number of times this message was already
delivered
-`properties` | key-value pairs | no | Application-defined properties
-`key` | string | no | Original routing key set by producer
+Below are the parameters in the WebSocket session.
+
+- General parameters
+
+ Key | Type | Required? | Explanation
+ :---|:-----|:----------|:-----------
+ `messageId` | string | yes | Message ID
+ `payload` | string | yes | Base-64 encoded payload
+ `publishTime` | string | yes | Publish timestamp
+ `redeliveryCount` | number | yes | Number of times this message was
already delivered
+ `properties` | key-value pairs | no | Application-defined properties
+ `key` | string | no | Original routing key set by producer
+ `encryptionContext` | EncryptionContext | no | Encryption context that
consumers can use to decrypt received messages
+ `param` | string | no | Initialization vector for cipher (Base64 encoding)
+ `batchSize` | string | no | Number of entries in a message (if it it a
batch message)
Review comment:
```suggestion
`batchSize` | string | no | Number of entries in a message (if it is a
batch message)
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
