Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[improve][doc] Improve the description of acknowledgment timeout in Java docs and REST API links #16746

Merged
merged 14 commits into from
Aug 31, 2022
Merged

[improve][doc] Improve the description of acknowledgment timeout in Java docs and REST API links #16746

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
351362a
REST API links
momo-jun Jul 21, 2022
39c37df
Fix REST API links for 2.7.3 and 2.7.4
momo-jun Jul 21, 2022
a9b0731
Improve the description of acknowledgment timeout in Java docs
momo-jun Jul 21, 2022
3423cc9
Fix REST API links for 2.7.0, 2.7.1 and 2.7.2
momo-jun Jul 22, 2022
1c71926
add a new lookup REST API entry and update related two API links
momo-jun Aug 9, 2022
a1aef7f
Merge branch 'master' into doc-fix-w29-2022
momo-jun Aug 9, 2022
493d8ac
sync to 2.7.x
momo-jun Aug 9, 2022
a344df3
Merge branch 'master' into doc-fix-w29-2022
momo-jun Aug 10, 2022
b95f508
remove trailing space
momo-jun Aug 12, 2022
2f983be
replace '' with ``
momo-jun Aug 12, 2022
e2390e6
unify the wording for default value
momo-jun Aug 17, 2022
82248be
Merge branch 'master' into doc-fix-w29-2022
momo-jun Aug 19, 2022
54661d9
Merge branch 'master' into doc-fix-w29-2022
momo-jun Aug 19, 2022
29c24a1
Merge branch 'master' into doc-fix-w29-2022
momo-jun Aug 31, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions pulsar-client-api/src/main/java/org/apache/pulsar/client/api/ConsumerBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,9 +181,11 @@ public interface ConsumerBuilder<T> extends Cloneable {
* Set the timeout for unacked messages, truncated to the nearest millisecond. The timeout needs to be greater than
* 1 second.
*
* <p>By default, the acknowledge timeout is disabled and that means that messages delivered to a
* consumer is not re-delivered unless the consumer crashes. Since 2.3.0, when a dead letter policy
* is specified, and no ackTimeoutMillis is specified, the ack timeout is set to 30 seconds.
* <p>By default, the acknowledge timeout is disabled (set to `0`, which means infinite).
* When a consumer with an infinite acknowledgment timeout terminates, any unacknowledged
* messages that it receives are re-delivered to another consumer.
* Since 2.3.0, when a dead letter policy is specified and no ackTimeoutMillis is specified,
* the ack timeout is set to 30 seconds.
*
* <p>When enabling ack timeout, if a message is not acknowledged within the specified timeout
* it is re-delivered to the consumer (possibly to a different consumer in case of
Expand Down
2 changes: 1 addition & 1 deletion site2/docs/admin-api-topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1105,7 +1105,7 @@ $ pulsar-admin topics lookup \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/lookup/v2/topic/:topic_domain/:tenant/:namespace/:topic|operation/lookupTopicAsync?version=@pulsar:version_number@}
{@inject: endpoint|GET|/lookup/v2/topic/:topic-domain/:tenant/:namespace/:topic|operation/lookupTopicAsync?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down
4 changes: 2 additions & 2 deletions site2/docs/io-use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -764,7 +764,7 @@ For the latest and complete information, see [Pulsar admin docs](/tools/pulsar-a
</TabItem>
<TabItem value="REST API">

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=@pulsar:version_number@}
Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace|operation/listSources?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -823,7 +823,7 @@ For the latest and complete information, see [Pulsar admin docs](/tools/pulsar-a
</TabItem>
<TabItem value="REST API">

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=@pulsar:version_number@}
Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace|operation/listSinks?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down
1 change: 1 addition & 0 deletions site2/docs/reference-rest-api-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,5 @@ Pulsar provides a variety of REST APIs that enable you to interact with Pulsar t
| [Sinks](/sink-rest-api/?version=master) | REST APIs for sink-specific operations.|
| [Packages](/packages-rest-api/?version=master) | REST APIs for package-specific operations. A package can be a group of functions, sources, and sinks.|
| [Transactions](/transactions-rest-api/?version=master) | REST APIs for transaction-specific operations.|
| [Lookup](/lookup-rest-api/?version=master) | REST APIs for lookup-specific operations, such as getting the owner broker of a topic, getting the namespace bundle that a topic belongs to, and so on.|

2 changes: 1 addition & 1 deletion site2/website/versioned_docs/version-2.10.0/admin-api-namespaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ $ pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff test-tenan
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/{bundle}/split|operation/splitNamespaceBundle?version=@pulsar:version_number@}
{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/:bundle/split|operation/splitNamespaceBundle?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down
4 changes: 2 additions & 2 deletions site2/website/versioned_docs/version-2.10.0/io-use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,7 @@ For the latest and complete information, see [Pulsar admin docs](/tools/pulsar-a
</TabItem>
<TabItem value="REST API">

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=@pulsar:version_number@}
Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace|operation/listSources?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -825,7 +825,7 @@ For the latest and complete information, see [Pulsar admin docs](/tools/pulsar-a
</TabItem>
<TabItem value="REST API">

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=@pulsar:version_number@}
Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace|operation/listSinks?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down
2 changes: 1 addition & 1 deletion site2/website/versioned_docs/version-2.10.1/admin-api-namespaces.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -554,7 +554,7 @@ $ pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff test-tenan
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/{bundle}/split|operation/splitNamespaceBundle?version=@pulsar:version_number@}
{@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/:bundle/split|operation/splitNamespaceBundle?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down
4 changes: 2 additions & 2 deletions site2/website/versioned_docs/version-2.10.1/io-use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -766,7 +766,7 @@ For the latest and complete information, see [Pulsar admin docs](/tools/pulsar-a
</TabItem>
<TabItem value="REST API">

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace/|operation/listSources?version=@pulsar:version_number@}
Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sources/:tenant/:namespace|operation/listSources?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -825,7 +825,7 @@ For the latest and complete information, see [Pulsar admin docs](/tools/pulsar-a
</TabItem>
<TabItem value="REST API">

Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace/|operation/listSinks?version=@pulsar:version_number@}
Send a `GET` request to this endpoint: {@inject: endpoint|GET|/admin/v3/sinks/:tenant/:namespace|operation/listSinks?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down
34 changes: 17 additions & 17 deletions site2/website/versioned_docs/version-2.7.0/admin-api-functions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ $ pulsar-admin functions create \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName|operation/registerFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -115,7 +115,7 @@ $ pulsar-admin functions update \
</TabItem>
<TabItem value="REST Admin API">

{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
{@inject: endpoint|PUT|/admin/v3/functions/:tenant/:namespace/:functionName|operation/updateFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -165,7 +165,7 @@ $ pulsar-admin functions start \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/start|operation/startFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -207,7 +207,7 @@ $ pulsar-admin functions start \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/start|operation/startFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java">
Expand Down Expand Up @@ -250,7 +250,7 @@ $ pulsar-admin functions stop \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stop|operation/stopFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -292,7 +292,7 @@ $ pulsar-admin functions stop \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/stop|operation/stopFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -335,7 +335,7 @@ $ pulsar-admin functions restart \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/restart|operation/restartFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -377,7 +377,7 @@ $ pulsar-admin functions restart \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/restart|operation/restartFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -418,7 +418,7 @@ $ pulsar-admin functions list \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace|operation/listFunctions?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -460,7 +460,7 @@ $ pulsar-admin functions delete \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
{@inject: endpoint|DELETE|/admin/v3/functions/:tenant/:namespace/:functionName|operation/deregisterFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -502,7 +502,7 @@ $ pulsar-admin functions get \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName|operation/getFunctionInfo?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -586,7 +586,7 @@ $ pulsar-admin functions status \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/status|operation/getFunctionInstanceStatus?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -628,7 +628,7 @@ $ pulsar-admin functions stats \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/:instanceId/stats|operation/getFunctionInstanceStats?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -670,7 +670,7 @@ $ pulsar-admin functions stats \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/stats|operation/getFunctionStats?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -715,7 +715,7 @@ $ pulsar-admin functions trigger \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/trigger|operation/triggerFunction?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -758,7 +758,7 @@ $ pulsar-admin functions putstate \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=@pulsar:version_number@}
{@inject: endpoint|POST|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/putFunctionState?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin API">
Expand Down Expand Up @@ -803,7 +803,7 @@ $ pulsar-admin functions querystate \
</TabItem>
<TabItem value="REST API">

{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key?version=@pulsar:version_number@}
{@inject: endpoint|GET|/admin/v3/functions/:tenant/:namespace/:functionName/state/:key|operation/getFunctionState?version=@pulsar:version_number@}

</TabItem>
<TabItem value="Java Admin CLI">
Expand Down
Loading