This is an automated email from the ASF dual-hosted git repository. lhotari pushed a commit to branch main in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
commit f67ee8c9fb0df8e39152016de501a790b89e9221 Author: Lari Hotari <[email protected]> AuthorDate: Fri Apr 24 10:13:38 2026 +0300 Use @pulsar:javadoc:client@ and @pulsar:javadoc:admin@ in remaining locations --- client-libraries/consumers.md | 2 +- client-libraries/java-initialize.md | 2 +- client-libraries/java-use.md | 8 ++++---- client-libraries/java.md | 4 ++-- client-libraries/overview.md | 2 +- client-libraries/producers.md | 2 +- client-libraries/tableviews.md | 2 +- client-libraries/websocket.md | 14 +++++++------- static/reference/2.10.x/client/client-libraries-java.md | 4 ++-- static/reference/2.6.x/client/client-libraries-java.md | 4 ++-- static/reference/2.7.x/client/client-libraries-java.md | 4 ++-- static/reference/2.8.x/client/client-libraries-java.md | 4 ++-- static/reference/2.9.x/client/client-libraries-java.md | 4 ++-- 13 files changed, 28 insertions(+), 28 deletions(-) diff --git a/client-libraries/consumers.md b/client-libraries/consumers.md index f32a95b4e6f..dd57582de72 100644 --- a/client-libraries/consumers.md +++ b/client-libraries/consumers.md @@ -658,7 +658,7 @@ The following is an example. CompletableFuture<Message> asyncMessage = consumer.receiveAsync(); ``` - Async receive operations return a [Message](/api/client/org/apache/pulsar/client/api/Message) wrapped inside of a [`CompletableFuture`](http://www.baeldung.com/java-completablefuture). + Async receive operations return a [Message](@pulsar:javadoc:client@/org/apache/pulsar/client/api/Message) wrapped inside of a [`CompletableFuture`](http://www.baeldung.com/java-completablefuture). </TabItem> <TabItem value="Python"> diff --git a/client-libraries/java-initialize.md b/client-libraries/java-initialize.md index 70e9fa554d9..96ae5381542 100644 --- a/client-libraries/java-initialize.md +++ b/client-libraries/java-initialize.md @@ -6,7 +6,7 @@ description: Learn how to initialize Java client in Pulsar. --- -You can instantiate a [PulsarClient](/api/client/org/apache/pulsar/client/api/PulsarClient) object using just a URL for the target Pulsar [cluster](pathname:///docs/reference-terminology#cluster) like this: +You can instantiate a [PulsarClient](@pulsar:javadoc:client@/org/apache/pulsar/client/api/PulsarClient) object using just a URL for the target Pulsar [cluster](pathname:///docs/reference-terminology#cluster) like this: ```java PulsarClient client = PulsarClient.builder() diff --git a/client-libraries/java-use.md b/client-libraries/java-use.md index cd04b26c0d4..07ed45bcb95 100644 --- a/client-libraries/java-use.md +++ b/client-libraries/java-use.md @@ -7,7 +7,7 @@ description: Learn how to use Java client in Pulsar. ## Create a producer -Once you've instantiated a [PulsarClient](/api/client/org/apache/pulsar/client/api/PulsarClient) object, you can create a [Producer](/api/client/org/apache/pulsar/client/api/Producer) for a specific Pulsar [topic](pathname:///docs/reference-terminology#topic). +Once you've instantiated a [PulsarClient](@pulsar:javadoc:client@/org/apache/pulsar/client/api/PulsarClient) object, you can create a [Producer](@pulsar:javadoc:client@/org/apache/pulsar/client/api/Producer) for a specific Pulsar [topic](pathname:///docs/reference-terminology#topic). ```java Producer<byte[]> producer = client.newProducer() @@ -49,9 +49,9 @@ stringProducer.send("My message"); ## Create a consumer -In Pulsar, consumers subscribe to topics and handle messages that producers publish to those topics. You can instantiate a new [consumer](pathname:///docs/reference-terminology#consumer) by first instantiating a [PulsarClient](/api/client/org/apache/pulsar/client/api/PulsarClient) object and passing it a URL for a Pulsar broker (as [above](#client-configuration)). +In Pulsar, consumers subscribe to topics and handle messages that producers publish to those topics. You can instantiate a new [consumer](pathname:///docs/reference-terminology#consumer) by first instantiating a [PulsarClient](@pulsar:javadoc:client@/org/apache/pulsar/client/api/PulsarClient) object and passing it a URL for a Pulsar broker (as [above](#client-configuration)). -Once you've instantiated a [PulsarClient](/api/client/org/apache/pulsar/client/api/PulsarClient) object, you can create a [Consumer](/api/client/org/apache/pulsar/client/api/Consumer) by specifying a [topic](pathname:///docs/reference-terminology#topic) and a [subscription](pathname:///docs/concepts-messaging#subscription-types). +Once you've instantiated a [PulsarClient](@pulsar:javadoc:client@/org/apache/pulsar/client/api/PulsarClient) object, you can create a [Consumer](@pulsar:javadoc:client@/org/apache/pulsar/client/api/Consumer) by specifying a [topic](pathname:///docs/reference-terminology#topic) and a [subscription](pathname:///docs/concepts-messaging#subscription-types). ```java Consumer consumer = client.newConsumer() @@ -101,7 +101,7 @@ Consumer consumer = client.newConsumer() ## Create a reader -With the [reader interface](pathname:///docs/concepts-clients#reader-interface), Pulsar clients can "manually position" themselves within a topic and read all messages from a specified message onward. The Pulsar API for Java enables you to create [Reader](/api/client/org/apache/pulsar/client/api/Reader) objects by specifying a topic and a [MessageId](/api/client/org/apache/pulsar/client/api/MessageId). +With the [reader interface](pathname:///docs/concepts-clients#reader-interface), Pulsar clients can "manually position" themselves within a topic and read all messages from a specified message onward. The Pulsar API for Java enables you to create [Reader](@pulsar:javadoc:client@/org/apache/pulsar/client/api/Reader) objects by specifying a topic and a [MessageId](@pulsar:javadoc:client@/org/apache/pulsar/client/api/MessageId). The following is an example. diff --git a/client-libraries/java.md b/client-libraries/java.md index 5fa204c303d..a81d1b423c8 100644 --- a/client-libraries/java.md +++ b/client-libraries/java.md @@ -36,8 +36,8 @@ The following table outlines the API packages and reference docs for Pulsar Java Package | Description | Maven Artifact :-------|:------------|:-------------- -[`org.apache.pulsar.client.api`](/api/client) | Java client API. <br/> See [Client API overview](pathname:///docs/pulsar-api-overview#pulsar-client-apis) for more reference. | [org.apache.pulsar:pulsar-client:@pulsar:version:lts@](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C@pulsar:version:lts@%7Cjar) -[`org.apache.pulsar.client.admin`](/api/admin) | Java admin API. <br/> See [Admin API overview](pathname:///docs/admin-api-overview) for more reference. | [org.apache.pulsar:pulsar-client-admin:@pulsar:version:lts@](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client-admin%7C@pulsar:version:lts@%7Cjar) +[`org.apache.pulsar.client.api`](@pulsar:javadoc:client@) | Java client API. <br/> See [Client API overview](pathname:///docs/pulsar-api-overview#pulsar-client-apis) for more reference. | [org.apache.pulsar:pulsar-client:@pulsar:version:lts@](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C@pulsar:version:lts@%7Cjar) +[`org.apache.pulsar.client.admin`](@pulsar:javadoc:admin@admin) | Java admin API. <br/> See [Admin API overview](pathname:///docs/admin-api-overview) for more reference. | [org.apache.pulsar:pulsar-client-admin:@pulsar:version:lts@](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client-admin%7C@pulsar:version:lts@%7Cjar) `org.apache.pulsar.client.all` | Include both `pulsar-client` and `pulsar-client-admin`.<br /> Both `pulsar-client` and `pulsar-client-admin` are independently shaded packages. Consequently, the applications using both `pulsar-client` and `pulsar-client-admin` have redundant shaded classes. It would be troublesome if you introduce new dependencies but forget to update shading rules. <br /> In this case, you can use `pulsar-client-all`, which shades dependencies only one time and reduces [...] #### More reference diff --git a/client-libraries/overview.md b/client-libraries/overview.md index 90916e20b8b..656f248662a 100644 --- a/client-libraries/overview.md +++ b/client-libraries/overview.md @@ -12,7 +12,7 @@ Pulsar supports the following language-specific client libraries: | Language | User doc | API doc | Release notes | Code repo | |--------------|-----------------------|-------------------------------------------------------------------------|-------------------------------------------------------|------------------------------------------------------------------------------------------------------------------| -| Java | [User doc](java.md) | [API doc](/api/client/) | [Notes](pathname:///release-notes/client-java) | [github.com/apache/pulsar/tree/master/pulsar-client](https://github.com/apache/pulsar/tree/master/pulsar-client) | +| Java | [User doc](java.md) | [API doc](@pulsar:javadoc:client@/) | [Notes](pathname:///release-notes/client-java) | [github.com/apache/pulsar/tree/master/pulsar-client](https://github.com/apache/pulsar/tree/master/pulsar-client) | | Java (Reactive Streams) | [User doc](https://github.com/apache/pulsar-client-reactive/#reactive-client-for-apache-pulsar) | [API doc](https://javadoc.io/doc/org.apache.pulsar/pulsar-client-reactive-api) | [Notes](https://github.com/apache/pulsar-client-reactive/releases) | [github.com/apache/pulsar-client-reactive](https://github.com/apache/pulsar-client-reactive) | | C++ | [User doc](cpp.md) | [API doc](@pulsar:apidoc:cpp@) | [Notes](pathname:///release-notes/client-cpp) | [github.com/apache/pulsar-client-cpp](https://github.com/apache/pulsar-client-cpp) | | Python | [User doc](python.md) | [API doc](@pulsar:apidoc:python@) | [Notes](pathname:///release-notes/client-python) | [github.com/apache/pulsar-client-python](https://github.com/apache/pulsar-client-python) | diff --git a/client-libraries/producers.md b/client-libraries/producers.md index 2f65e8f2a71..e54fc8f31e9 100644 --- a/client-libraries/producers.md +++ b/client-libraries/producers.md @@ -411,7 +411,7 @@ The following is an example: values={[{"label":"Java","value":"Java"},{"label":"C++","value":"C++"},{"label":"Go","value":"Go"},{"label":"Python","value":"Python"}]}> <TabItem value="Java"> -To use a custom message router, you need to provide an implementation of the [MessageRouter](/api/client/org/apache/pulsar/client/api/MessageRouter) interface, which has just one `choosePartition` method: +To use a custom message router, you need to provide an implementation of the [MessageRouter](@pulsar:javadoc:client@/org/apache/pulsar/client/api/MessageRouter) interface, which has just one `choosePartition` method: ```java public interface MessageRouter extends Serializable { diff --git a/client-libraries/tableviews.md b/client-libraries/tableviews.md index b8a8df4eab0..5d6cbc2efd9 100644 --- a/client-libraries/tableviews.md +++ b/client-libraries/tableviews.md @@ -29,7 +29,7 @@ values={[{"label":"Java","value":"Java"},{"label":"C++","value":"C++"}]}> .create() ``` -You can use the available parameters in the `loadConf` configuration or the API [`TableViewBuilder`](/api/client/org/apache/pulsar/client/api/TableViewBuilder.html) to customize your TableView. +You can use the available parameters in the `loadConf` configuration or the API [`TableViewBuilder`](@pulsar:javadoc:client@/org/apache/pulsar/client/api/TableViewBuilder.html) to customize your TableView. | Name | Type| Required? | <div>Description</div> | Default |---|---|---|---|--- diff --git a/client-libraries/websocket.md b/client-libraries/websocket.md index c382ab300b3..18bcc1c3357 100644 --- a/client-libraries/websocket.md +++ b/client-libraries/websocket.md @@ -105,11 +105,11 @@ Key | Type | Required? | Explanation `batchingMaxMessages` | int | no | Maximum number of messages permitted in a batch (default: 1000) `maxPendingMessages` | int | no | Set the max size of the internal-queue holding the messages (default: 1000) `batchingMaxPublishDelay` | long | no | Time period within which the messages will be batched (default: 10ms) -`messageRoutingMode` | string | no | Message [routing mode](/api/client/index.html?org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html) for the partitioned producer: `SinglePartition`, `RoundRobinPartition` -`compressionType` | string | no | Compression [type](/api/client/index.html?org/apache/pulsar/client/api/CompressionType.html): `LZ4`, `ZLIB` +`messageRoutingMode` | string | no | Message [routing mode](@pulsar:javadoc:client@/index.html?org/apache/pulsar/client/api/ProducerConfiguration.MessageRoutingMode.html) for the partitioned producer: `SinglePartition`, `RoundRobinPartition` +`compressionType` | string | no | Compression [type](@pulsar:javadoc:client@/index.html?org/apache/pulsar/client/api/CompressionType.html): `LZ4`, `ZLIB` `producerName` | string | no | Specify the name for the producer. Pulsar will enforce only one producer with same name can be publishing on a topic `initialSequenceId` | long | no | Set the baseline for the sequence ids for messages published by the producer. -`hashingScheme` | string | no | [Hashing function](/api/client/org/apache/pulsar/client/api/ProducerConfiguration.HashingScheme.html) to use when publishing on a partitioned topic: `JavaStringHash`, `Murmur3_32Hash` +`hashingScheme` | string | no | [Hashing function](@pulsar:javadoc:client@/org/apache/pulsar/client/api/ProducerConfiguration.HashingScheme.html) to use when publishing on a partitioned topic: `JavaStringHash`, `Murmur3_32Hash` `token` | string | no | Authentication token, this is used for the browser javascript client `encryptionKeys` | string | no | Encryption key to encrypt published message only if encryption reader is configured using cryptoKeyReaderFactoryClassName config in websocket-configuration. @@ -173,12 +173,12 @@ ws://broker-service-url:8080/ws/v2/consumer/persistent/:tenant/:namespace/:topic Key | Type | Required? | Explanation :---|:-----|:----------|:----------- `ackTimeoutMillis` | long | no | Set the timeout for unacked messages (default: 0) -`subscriptionType` | string | no | [Subscription type](/api/client/index.html?org/apache/pulsar/client/api/SubscriptionType.html): `Exclusive`, `Failover`, `Shared`, `Key_Shared` +`subscriptionType` | string | no | [Subscription type](@pulsar:javadoc:client@/index.html?org/apache/pulsar/client/api/SubscriptionType.html): `Exclusive`, `Failover`, `Shared`, `Key_Shared` `receiverQueueSize` | int | no | Size of the consumer receive queue (default: 1000) `consumerName` | string | no | Consumer name -`priorityLevel` | int | no | Define a [priority](/api/client/org/apache/pulsar/client/api/ConsumerConfiguration.html#setPriorityLevel-int-) for the consumer -`maxRedeliverCount` | int | no | Define a [maxRedeliverCount](/api/client/org/apache/pulsar/client/api/ConsumerBuilder.html#deadLetterPolicy-org.apache.pulsar.client.api.DeadLetterPolicy-) for the consumer (default: 0). Activates [Dead Letter Topic](https://github.com/apache/pulsar/wiki/PIP-22%3A-Pulsar-Dead-Letter-Topic) feature. -`deadLetterTopic` | string | no | Define a [deadLetterTopic](/api/client/org/apache/pulsar/client/api/ConsumerBuilder.html#deadLetterPolicy-org.apache.pulsar.client.api.DeadLetterPolicy-) for the consumer (default: \{topic\}-\{subscription\}-DLQ). Activates [Dead Letter Topic](https://github.com/apache/pulsar/wiki/PIP-22%3A-Pulsar-Dead-Letter-Topic) feature. +`priorityLevel` | int | no | Define a [priority](@pulsar:javadoc:client@/org/apache/pulsar/client/api/ConsumerConfiguration.html#setPriorityLevel-int-) for the consumer +`maxRedeliverCount` | int | no | Define a [maxRedeliverCount](@pulsar:javadoc:client@/org/apache/pulsar/client/api/ConsumerBuilder.html#deadLetterPolicy-org.apache.pulsar.client.api.DeadLetterPolicy-) for the consumer (default: 0). Activates [Dead Letter Topic](https://github.com/apache/pulsar/wiki/PIP-22%3A-Pulsar-Dead-Letter-Topic) feature. +`deadLetterTopic` | string | no | Define a [deadLetterTopic](@pulsar:javadoc:client@/org/apache/pulsar/client/api/ConsumerBuilder.html#deadLetterPolicy-org.apache.pulsar.client.api.DeadLetterPolicy-) for the consumer (default: \{topic\}-\{subscription\}-DLQ). Activates [Dead Letter Topic](https://github.com/apache/pulsar/wiki/PIP-22%3A-Pulsar-Dead-Letter-Topic) feature. `pullMode` | boolean | no | Enable pull mode (default: false). See "Flow Control" below. `negativeAckRedeliveryDelay` | int | no | When a message is negatively acknowledged, the delay time before the message is redelivered (in milliseconds). The default value is 60000. `token` | string | no | Authentication token, this is used for the browser javascript client diff --git a/static/reference/2.10.x/client/client-libraries-java.md b/static/reference/2.10.x/client/client-libraries-java.md index 3f6ddeddb7c..f96857d08ee 100644 --- a/static/reference/2.10.x/client/client-libraries-java.md +++ b/static/reference/2.10.x/client/client-libraries-java.md @@ -9,8 +9,8 @@ Javadoc for the Pulsar client is divided into two domains by package as follows. Package | Description [...] :-----------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...] - [`org.apache.pulsar.client.api`](/api/client) | The producer and consumer API [...] - [`org.apache.pulsar.client.admin`](/api/admin) | The Java [admin API](admin-api-overview.md) [...] + [`org.apache.pulsar.client.api`](@pulsar:javadoc:client@) | The producer and consumer API [...] + [`org.apache.pulsar.client.admin`](@pulsar:javadoc:admin@admin) | The Java [admin API](admin-api-overview.md) [...] `org.apache.pulsar.client.all` | Include both `pulsar-client` and `pulsar-client-admin`<br /> Both `pulsar-client` and `pulsar-client-admin` are shaded packages and they shade dependencies independently. Consequently, the applications using both `pulsar-client` and `pulsar-client-admin` have redundant shaded classes. It would be troublesome if you introduce new dependencies but forget to update shading rules. <br /> In this case, you can use `pulsar-client-all`, which sh [...] This document focuses only on the client API for producing and consuming messages on Pulsar topics. For how to use the diff --git a/static/reference/2.6.x/client/client-libraries-java.md b/static/reference/2.6.x/client/client-libraries-java.md index d332c7f0584..c0b600bdff0 100644 --- a/static/reference/2.6.x/client/client-libraries-java.md +++ b/static/reference/2.6.x/client/client-libraries-java.md @@ -8,8 +8,8 @@ Javadoc for the Pulsar client is divided into two domains by package as follows. | Package | Description | Maven Artifact | |:-----------------------------------------------|:--------------------------------------------|:--------------------------------------------| -| [`org.apache.pulsar.client.api`](/api/client) | The producer and consumer API | org.apache.pulsar:pulsar-client:2.6.4 | -| [`org.apache.pulsar.client.admin`](/api/admin) | The Java [admin API](admin-api-overview.md) | org.apache.pulsar:pulsar-client-admin:2.6.4 | +| [`org.apache.pulsar.client.api`](@pulsar:javadoc:client@) | The producer and consumer API | org.apache.pulsar:pulsar-client:2.6.4 | +| [`org.apache.pulsar.client.admin`](@pulsar:javadoc:admin@admin) | The Java [admin API](admin-api-overview.md) | org.apache.pulsar:pulsar-client-admin:2.6.4 | This document focuses only on the client API for producing and consuming messages on Pulsar topics. For how to use the Java admin client, see [Pulsar admin interface](admin-api-overview.md). diff --git a/static/reference/2.7.x/client/client-libraries-java.md b/static/reference/2.7.x/client/client-libraries-java.md index 3fffbaa2319..34f4cb1f6ca 100644 --- a/static/reference/2.7.x/client/client-libraries-java.md +++ b/static/reference/2.7.x/client/client-libraries-java.md @@ -8,8 +8,8 @@ Javadoc for the Pulsar client is divided into two domains by package as follows. | Package | Description | Maven Artifact | |:-----------------------------------------------|:--------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [`org.apache.pulsar.client.api`](/api/client) | The producer and consumer API | [org.apache.pulsar:pulsar-client:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C{{pulsar:version}}%7Cjar) | -| [`org.apache.pulsar.client.admin`](/api/admin) | The Java [admin API](admin-api-overview.md) | [org.apache.pulsar:pulsar-client-admin:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client-admin%7C{{pulsar:version}}%7Cjar) | +| [`org.apache.pulsar.client.api`](@pulsar:javadoc:client@) | The producer and consumer API | [org.apache.pulsar:pulsar-client:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C{{pulsar:version}}%7Cjar) | +| [`org.apache.pulsar.client.admin`](@pulsar:javadoc:admin@admin) | The Java [admin API](admin-api-overview.md) | [org.apache.pulsar:pulsar-client-admin:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client-admin%7C{{pulsar:version}}%7Cjar) | This document focuses only on the client API for producing and consuming messages on Pulsar topics. For how to use the Java admin client, see [Pulsar admin interface](admin-api-overview.md). diff --git a/static/reference/2.8.x/client/client-libraries-java.md b/static/reference/2.8.x/client/client-libraries-java.md index c6bc85b897a..e28276231d0 100644 --- a/static/reference/2.8.x/client/client-libraries-java.md +++ b/static/reference/2.8.x/client/client-libraries-java.md @@ -8,8 +8,8 @@ Javadoc for the Pulsar client is divided into two domains by package as follows. Package | Description | Maven Artifact :-----------------------------------------------|:--------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- - [`org.apache.pulsar.client.api`](/api/client) | The producer and consumer API | [org.apache.pulsar:pulsar-client:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C{{pulsar:version}}%7Cjar) - [`org.apache.pulsar.client.admin`](/api/admin) | The Java [admin API](admin-api-overview.md) | [org.apache.pulsar:pulsar-client-admin:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client-admin%7C{{pulsar:version}}%7Cjar) + [`org.apache.pulsar.client.api`](@pulsar:javadoc:client@) | The producer and consumer API | [org.apache.pulsar:pulsar-client:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C{{pulsar:version}}%7Cjar) + [`org.apache.pulsar.client.admin`](@pulsar:javadoc:admin@admin) | The Java [admin API](admin-api-overview.md) | [org.apache.pulsar:pulsar-client-admin:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client-admin%7C{{pulsar:version}}%7Cjar) This document focuses only on the client API for producing and consuming messages on Pulsar topics. For how to use the Java admin client, see [Pulsar admin interface](admin-api-overview.md). diff --git a/static/reference/2.9.x/client/client-libraries-java.md b/static/reference/2.9.x/client/client-libraries-java.md index 74fc6541ad1..b41bb662787 100644 --- a/static/reference/2.9.x/client/client-libraries-java.md +++ b/static/reference/2.9.x/client/client-libraries-java.md @@ -8,8 +8,8 @@ Javadoc for the Pulsar client is divided into two domains by package as follows. Package | Description [...] :-----------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- [...] - [`org.apache.pulsar.client.api`](/api/client) | The producer and consumer API [...] - [`org.apache.pulsar.client.admin`](/api/admin) | The Java [admin API](admin-api-overview.md) [...] + [`org.apache.pulsar.client.api`](@pulsar:javadoc:client@) | The producer and consumer API [...] + [`org.apache.pulsar.client.admin`](@pulsar:javadoc:admin@admin) | The Java [admin API](admin-api-overview.md) [...] `org.apache.pulsar.client.all` | Include both `pulsar-client` and `pulsar-client-admin`<br /> Both `pulsar-client` and `pulsar-client-admin` are shaded packages and they shade dependencies independently. Consequently, the applications using both `pulsar-client` and `pulsar-client-admin` have redundant shaded classes. It would be troublesome if you introduce new dependencies but forget to update shading rules. <br /> In this case, you can use `pulsar-client-all`, which sh [...] This document focuses only on the client API for producing and consuming messages on Pulsar topics. For how to use the
