RobertIndie commented on a change in pull request #12099:
URL: https://github.com/apache/pulsar/pull/12099#discussion_r714581358
##########
File path: site2/docs/client-libraries-java.md
##########
@@ -171,25 +171,25 @@ stringProducer.send("My message");
### Configure producer
-If you instantiate a `Producer` object by specifying only a topic name as the
example above, use the default configuration for producer.
+If you instantiate a `Producer` object by specifying only a topic name as the
example above, the default configuration of producer is used.
If you create a producer, you can use the `loadConf` configuration. The
following parameters are available in `loadConf`.
-Type | Name| <div style="width:300px">Description</div>| Default
+Name| Type | <div style="width:300px">Description</div>| Default
|---|---|---|---
-String| `topicName`| Topic name| null|
-String|`producerName`|Producer name| null
-long|`sendTimeoutMs`|Message send timeout in ms.<br/><br/>If a message is not
acknowledged by a server before the `sendTimeout` expires, an error
occurs.|30000
-boolean|`blockIfQueueFull`|If it is set to `true`, when the outgoing message
queue is full, the `Send` and `SendAsync` methods of producer block, rather
than failing and throwing errors. <br/><br>If it is set to `false`, when the
outgoing message queue is full, the `Send` and `SendAsync` methods of producer
fail and `ProducerQueueIsFullError` exceptions occur.<br/><br/>The
`MaxPendingMessages` parameter determines the size of the outgoing message
queue.|false
-int|`maxPendingMessages`|The maximum size of a queue holding pending
messages.<br/><br/>For example, a message waiting to receive an acknowledgment
from a [broker](reference-terminology.md#broker). <br/><br/>By default, when
the queue is full, all calls to the `Send` and `SendAsync` methods fail
**unless** you set `BlockIfQueueFull` to `true`.|1000
-int|`maxPendingMessagesAcrossPartitions`|The maximum number of pending
messages across partitions. <br/><br/>Use the setting to lower the max pending
messages for each partition ({@link #setMaxPendingMessages(int)}) if the total
number exceeds the configured value.|50000
-MessageRoutingMode|`messageRoutingMode`|Message routing logic for producers on
[partitioned
topics](concepts-architecture-overview.md#partitioned-topics).<br/><br/> Apply
the logic only when setting no key on messages. <br/><br/>Available options are
as follows: <br/><br/><li>`pulsar.RoundRobinDistribution`: round
robin<br/><br/> <li>`pulsar.UseSinglePartition`: publish all messages to a
single partition<br/><br/><li>`pulsar.CustomPartition`: a custom partitioning
scheme|`pulsar.RoundRobinDistribution`
-HashingScheme|`hashingScheme`|Hashing function determining the partition where
you publish a particular message (**partitioned topics
only**).<br/><br/>Available options are as follows:<br/><br/><li>
`pulsar.JavaStringHash`: the equivalent of `String.hashCode()` in
Java<br/><br/><li> `pulsar.Murmur3_32Hash`: applies the
[Murmur3](https://en.wikipedia.org/wiki/MurmurHash) hashing
function<br/><br/><li>`pulsar.BoostHash`: applies the hashing function from
C++'s [Boost](https://www.boost.org/doc/libs/1_62_0/doc/html/hash.html) library
|`HashingScheme.JavaStringHash`
-ProducerCryptoFailureAction|`cryptoFailureAction`|Producer should take action
when encryption fails.<br/><br/><li>**FAIL**: if encryption fails, unencrypted
messages fail to send.</li><br/><li> **SEND**: if encryption fails, unencrypted
messages are sent. |`ProducerCryptoFailureAction.FAIL`
-long|`batchingMaxPublishDelayMicros`|Batching time period of sending
messages.|TimeUnit.MILLISECONDS.toMicros(1)
-int|batchingMaxMessages|The maximum number of messages permitted in a
batch.|1000
-boolean|`batchingEnabled`|Enable batching of messages. |true
-CompressionType|`compressionType`|Message data compression type used by a
producer. <br/><br/>Available
options:<li>[`LZ4`](https://github.com/lz4/lz4)<br/><li>[`ZLIB`](https://zlib.net/)<br/><li>[`ZSTD`](https://facebook.github.io/zstd/)<br/><li>[`SNAPPY`](https://google.github.io/snappy/)|
No compression
+`topicName`| string| Topic name| null|
+`producerName`| string|Producer name| null
+`sendTimeoutMs`| long|Message send timeout in ms.<br />If a message is not
acknowledged by a server before the `sendTimeout` expires, an error
occurs.|30000
+`blockIfQueueFull`|boolean|If it is set to `true`, when the outgoing message
queue is full, the `Send` and `SendAsync` methods of producer block, rather
than failing and throwing errors. <br />If it is set to `false`, when the
outgoing message queue is full, the `Send` and `SendAsync` methods of producer
fail and `ProducerQueueIsFullError` exceptions occur.<br /><br />The
`MaxPendingMessages` parameter determines the size of the outgoing message
queue.|false
+`maxPendingMessages`| int|The maximum size of a queue holding pending
messages.<br /><br />For example, a message waiting to receive an
acknowledgment from a [broker](reference-terminology.md#broker). <br /><br />By
default, when the queue is full, all calls to the `Send` and `SendAsync`
methods fail **unless** you set `BlockIfQueueFull` to `true`.|1000
+`maxPendingMessagesAcrossPartitions`|int|The maximum number of pending
messages across partitions. <br /><br />Use the setting to lower the max
pending messages for each partition ({@link #setMaxPendingMessages(int)}) if
the total number exceeds the configured value.|50000
+`messageRoutingMode`| MessageRoutingMode|Message routing logic for producers
on [partitioned
topics](concepts-architecture-overview.md#partitioned-topics).<br /> Apply the
logic only when setting no key on messages. <br />Available options are as
follows: <br /><li>`pulsar.RoundRobinDistribution`: round
robin</li><li>`pulsar.UseSinglePartition`: publish all messages to a single
partition</li><li>`pulsar.CustomPartition`: a custom partitioning
scheme|`pulsar.RoundRobinDistribution`</li>
+`hashingScheme`| HashingScheme|Hashing function determining the partition
where you publish a particular message (**partitioned topics only**).<br
/>Available options are as follows:<br /><li> `pulsar.JavastringHash`: the
equivalent of `string.hashCode()` in Java</li><li> `pulsar.Murmur3_32Hash`:
applies the [Murmur3](https://en.wikipedia.org/wiki/MurmurHash) hashing
function</li><li>`pulsar.BoostHash`: applies the hashing function from C++'s
[Boost](https://www.boost.org/doc/libs/1_62_0/doc/html/hash.html) library</li>
|`HashingScheme.JavastringHash`
+`cryptoFailureAction`| ProducerCryptoFailureAction|Producer should take action
when encryption fails.<br /><li>**FAIL**: if encryption fails, unencrypted
messages fail to send.</li><li> **SEND**: if encryption fails, unencrypted
messages are sent.</li> |`ProducerCryptoFailureAction.FAIL`
+`atchingMaxPublishDelayMicros`| long|Batching time period of sending
messages.|TimeUnit.MILLISECONDS.toMicros(1)
Review comment:
```suggestion
`batchingMaxPublishDelayMicros`| long|Batching time period of sending
messages.|TimeUnit.MILLISECONDS.toMicros(1)
```
--
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]
