ApsaraMQ for RocketMQ:Methods and parameters

Interface PullConsumer

public interface PullConsumer extends Admin {

    /**
     * Returns all partitions for the specified topic.
     * Call this method only after the pull consumer has started.
     */
    Set<TopicPartition> topicPartitions(String topic);

    /**
     * Manually assigns partitions to this consumer. Automatic rebalancing
     * is not performed -- make sure all partitions are covered across
     * your consumers. Calling this method again replaces the previous
     * assignment entirely.
     */
    void assign(Collection<TopicPartition> topicPartitions);

    /**
     * Polls for messages. Returns up to maxBatchMessageCount messages,
     * blocking for at most the specified timeout (in milliseconds).
     */
    List<Message> poll(long timeout);

    /**
     * Resets the consumer offset of a partition to a specific position.
     * The offset must be between the partition's minimum and maximum
     * offset. Call this method only after the consumer has started and
     * has been assigned the target partition.
     */
    void seek(TopicPartition topicPartition, long offset);

    /**
     * Resets the consumer offset of a partition to the earliest available
     * message. Requires a started consumer assigned to the target
     * partition.
     */
    void seekToBeginning(TopicPartition topicPartition);

    /**
     * Resets the consumer offset of a partition to the latest message.
     * Requires a started consumer assigned to the target partition.
     */
    void seekToEnd(TopicPartition topicPartition);

    /**
     * Pauses message consumption on the specified partitions.
     */
    void pause(Collection<TopicPartition> topicPartitions);

    /**
     * Resumes message consumption on previously paused partitions.
     */
    void resume(Collection<TopicPartition> topicPartitions);

    /**
     * Returns the offset of the first message stored at or after the
     * given timestamp in the specified partition. The timestamp refers
     * to when the broker stored the message, not when it was sent.
     */
    Long offsetForTimestamp(TopicPartition topicPartition, Long timestamp);

    /**
     * Returns the latest consumer offset for the specified partition.
     */
    Long committed(TopicPartition topicPartition);

    /**
     * Commits the current consumer offsets synchronously. Offsets are
     * first synced to the local client, then written to the broker
     * asynchronously.
     */
    void commitSync();

    /**
     * Listener interface for partition change events.
     */
    interface TopicPartitionChangeListener {
        /**
         * Called when the partitions of a topic change -- for example,
         * after broker scaling adjusts the partition count.
         */
        void onChanged(Set<TopicPartition> topicPartitions);
    }

    /**
     * Registers a listener that fires when the partition count for a
     * topic changes (for example, due to broker scaling). By default,
     * the maximum callback delay is 5 seconds.
     */
    void registerTopicPartitionChangedListener(String topic,
            TopicPartitionChangeListener callback);
}