From 410792d35cb1f320a6a9fcd59c733f59f1a08b26 Mon Sep 17 00:00:00 2001 From: mazhen Date: Tue, 27 Apr 2021 01:17:37 +0800 Subject: [PATCH] [Doc] Update client-libraries-java.md (#10325) * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md * Update client-libraries-java.md --- site2/docs/client-libraries-java.md | 2 +- .../versioned_docs/version-2.5.0/client-libraries-java.md | 2 +- .../versioned_docs/version-2.5.1/client-libraries-java.md | 2 +- .../versioned_docs/version-2.5.2/client-libraries-java.md | 2 +- .../versioned_docs/version-2.6.0/client-libraries-java.md | 2 +- .../versioned_docs/version-2.6.1/client-libraries-java.md | 2 +- .../versioned_docs/version-2.6.2/client-libraries-java.md | 2 +- .../versioned_docs/version-2.6.3/client-libraries-java.md | 2 +- .../versioned_docs/version-2.7.0/client-libraries-java.md | 2 +- .../versioned_docs/version-2.7.1/client-libraries-java.md | 2 +- .../versioned_docs/version-2.7.2/client-libraries-java.md | 2 +- 11 files changed, 11 insertions(+), 11 deletions(-) diff --git a/site2/docs/client-libraries-java.md b/site2/docs/client-libraries-java.md index 5b8e4a1b79d18..27ec7e4f85c3b 100644 --- a/site2/docs/client-libraries-java.md +++ b/site2/docs/client-libraries-java.md @@ -675,7 +675,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String| `subscriptionName`|Subscription name|When there is a single topic, the default subscription name is `"reader-" + 10-digit UUID`. When there are multiple topics, the default subscription name is `"multiTopicsReader-" + 10-digit UUID`. String|`subscriptionRolePrefix`|Prefix of subscription role. |null diff --git a/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md index f57d1d9c732fe..8080da45590f2 100644 --- a/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.5.0/client-libraries-java.md @@ -642,7 +642,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md index 2d62dc36ae183..480dfbd54fe79 100644 --- a/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.5.1/client-libraries-java.md @@ -644,7 +644,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md index 99ee5a26a3212..d5a54d8d4689e 100644 --- a/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.5.2/client-libraries-java.md @@ -644,7 +644,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md index 21b098981629f..b40612ef6dada 100644 --- a/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.6.0/client-libraries-java.md @@ -675,7 +675,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md index 78e5cb9f506bf..c0c432a55e628 100644 --- a/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.6.1/client-libraries-java.md @@ -660,7 +660,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md index 42d38142abf72..c8a1b8ee866ea 100644 --- a/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.6.2/client-libraries-java.md @@ -660,7 +660,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md b/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md index cebf4b75d2820..c62189cc5cf17 100644 --- a/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.6.3/client-libraries-java.md @@ -660,7 +660,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md index 794d9d7858423..72db967dca90a 100644 --- a/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.7.0/client-libraries-java.md @@ -675,7 +675,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md index d6634fd1a8a40..b37fdde9954e9 100644 --- a/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.7.1/client-libraries-java.md @@ -675,7 +675,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL
    • diff --git a/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md b/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md index 9cee60a8cc03f..a5e2d107885a0 100644 --- a/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md +++ b/site2/website/versioned_docs/version-2.7.2/client-libraries-java.md @@ -675,7 +675,7 @@ When you create a reader, you can use the `loadConf` configuration. The followin String|`topicName`|Topic name. |None int|`receiverQueueSize`|Size of a consumer's receiver queue.

    For example, the number of messages that can be accumulated by a consumer before an application calls `Receive`.

    A value higher than the default value increases consumer throughput, though at the expense of more memory utilization.|1000 ReaderListener<T>|`readerListener`|A listener that is called for message received.|None -String|`readerName`|Read name.|null +String|`readerName`|Reader name.|null String|`subscriptionRolePrefix`|Prefix of subscription role. |null CryptoKeyReader|`cryptoKeyReader`|Interface that abstracts the access to a key store.|null ConsumerCryptoFailureAction|`cryptoFailureAction`|Consumer should take action when it receives a message that can not be decrypted.

  • **FAIL**: this is the default option to fail messages until crypto succeeds.

  • **DISCARD**: silently acknowledge and not deliver message to an application.

  • **CONSUME**: deliver encrypted messages to applications. It is the application's responsibility to decrypt the message.

    The message decompression fails.

    If messages contain batch messages, a client is not be able to retrieve individual messages in batch.

    Delivered encrypted message contains {@link EncryptionContext} which contains encryption and compression information in it using which application can decrypt consumed message payload.|ConsumerCryptoFailureAction.FAIL