Skip to content

[improve][site] Doc changes to support peekMessages with Offset in admin-api-topics #840

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[improve][site] Doc changes to support peekMessages with Offset in admin-api-topics #840

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
22 changes: 22 additions & 0 deletions versioned_docs/version-2.11.x/admin-api-topics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,28 @@ admin.topics().peekMessages(topic, subName, numMessages);

</TabItem>

</Tabs>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems you targeted 2.11.x file, but your PIP implementation is targeted at master which is 3.2, no?

````
### Peek messages with Offset

You can also start to peek number of messages for a specific subscription of a given topic from a particular offset position in the following ways.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

start?
Maybe
You can peek a number of messages, for a specific subscription of a topic, from a given offset position, in the following ways:


````mdx-code-block
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add not just java?

<Tabs groupId="api-choice"
defaultValue="Java"
values={[{"label":"Java","value":"Java"}]}>

<TabItem value="Java">

```java
String topic = "persistent://my-tenant/my-namespace/my-topic";
String subName = "my-subscription";
int numMessages = 5;
int offset = 10;
admin.topics().peekMessages(topic, subName, offset, numMessages);
```

</TabItem>
</Tabs>
````

Expand Down