Skip to content

KAFKA-19699: improve the documentation of RecordsToDelete #20527

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

Merged
merged 1 commit into from
Sep 17, 2025
Merged

KAFKA-19699: improve the documentation of RecordsToDelete #20527

Show file tree
Hide file tree
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
6 changes: 4 additions & 2 deletions clients/src/main/java/org/apache/kafka/clients/admin/RecordsToDelete.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,16 @@ private RecordsToDelete(long offset) {
/**
* Delete all the records before the given {@code offset}
*
* @param offset the offset before which all records will be deleted
* @param offset The offset before which all records will be deleted.
* Use {@code -1} to truncate to the high watermark.
*/
public static RecordsToDelete beforeOffset(long offset) {
return new RecordsToDelete(offset);
}

/**
* The offset before which all records will be deleted
* The offset before which all records will be deleted.
* Use {@code -1} to truncate to the high watermark.
*/
public long beforeOffset() {
return offset;
Expand Down
2 changes: 1 addition & 1 deletion clients/src/main/resources/common/message/DeleteRecordsRequest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
{ "name": "PartitionIndex", "type": "int32", "versions": "0+",
"about": "The partition index." },
{ "name": "Offset", "type": "int64", "versions": "0+",
"about": "The deletion offset." }
"about": "The deletion offset. -1 means that records should be truncated to the high watermark." }
]}
]},
{ "name": "TimeoutMs", "type": "int32", "versions": "0+",
Expand Down