Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: javadoc typo

...

Code Block
languagejava
titleAdminClient.java
    /**
     * <p>Commits offsets for the specified group.
     *
     * <p>This is a convenience method for {@link #commitOffsets#commitConsumerGroupOffsets(String, Map, CommitOffsetsOptions)} with default options.
     * See the overload for more details.
     *
     * @param groupId The group for which to commit offsets.
     * @param offsets A map of offsets by partition with associated metadata.
     * @return The CommitOffsetsResult.
     */
    public CommitOffsetsResult commitConsumerGroupOffsets(String groupId, Map<TopicPartition, OffsetAndMetadata> offsets) {
        return commitOffsets(groupId, offsets, new CommitOffsetsOptions());
    }

    /**
     * <p>Commits offsets for the specified group.
     *
     * <p>This operation is not transactional so it may succeed for some partition while fail for others.
     *
     * @param groupId The group for which to commit offsets.
     * @param offsets A map of offsets by partition with associated metadata.
     * @param options The options to use when committing the offsets.
     * @return The CommitOffsetsResult.
     */
    public abstract CommitOffsetsResult commitConsumerGroupOffsets(String groupId, Map<TopicPartition, OffsetAndMetadata> offsets, CommitOffsetsOptions options);

    /**
     * <p>List offset for the specified partitions.
     *
     * <p>This is a convenience method for {@link #listOffsets(Collection, ListOffsetsOptions)} which returns the
     * latest uncommitted offsets.
     *
     * @param topicPartitionOffsets The mapping from partition to the timestamp to look up.
     * @return The ListOffsetsResult.
     */
    public ListOffsetsResult listOffsets(Map<TopicPartition, Long> topicPartitionOffsets) {
        return listOffsets(topicPartitionOffsets, ListOffsetsOptions.latestUncommitted());
    }


    /**
     * <p>List offset for the specified partitions.
     *
     * @param topicPartitionOffsets The mapping from partition to the timestamp to look up.
     * @param options The options to use when retrieving the offsets
     * @return The ListOffsetsResult.
     */
    public abstract ListOffsetsResult listOffsets(Map<TopicPartition, Long> topicPartitionOffsets, ListOffsetsOptions options);

...