ApsaraMQ for RocketMQ:メソッドとパラメーター

PullConsumer インターフェイス

public interface PullConsumer extends Admin {

    /**
     * 指定されたトピックのすべてのパーティションを返します。
     * このメソッドは、プルコンシューマーが起動した後にのみ呼び出してください。
     */
    Set<TopicPartition> topicPartitions(String topic);

    /**
     * パーティションをこのコンシューマーに手動で割り当てます。
     * 自動リバランスは実行されません。すべてのパーティションが
     * コンシューマー間でカバーされていることを確認してください。
     * このメソッドを再度呼び出すと、以前の割り当てが完全に置き換えられます。
     */
    void assign(Collection<TopicPartition> topicPartitions);

    /**
     * メッセージをポーリングします。最大 maxBatchMessageCount 個のメッセージを
     * 返し、指定されたタイムアウト（ミリ秒単位）までブロックします。
     */
    List<Message> poll(long timeout);

    /**
     * パーティションのコンシューマーオフセットを特定の位置にリセットします。
     * オフセットは、パーティションの最小および最大オフセットの範囲内である必要があります。
     * このメソッドは、コンシューマーが起動済みであり、対象パーティションが割り当て済みである場合にのみ呼び出してください。
     */
    void seek(TopicPartition topicPartition, long offset);

    /**
     * パーティションのコンシューマーオフセットを、利用可能な最も古いメッセージの位置にリセットします。
     * 対象パーティションが割り当て済みの起動済みコンシューマーが必要です。
     */
    void seekToBeginning(TopicPartition topicPartition);

    /**
     * パーティションのコンシューマーオフセットを、最新のメッセージの位置にリセットします。
     * 対象パーティションが割り当て済みの起動済みコンシューマーが必要です。
     */
    void seekToEnd(TopicPartition topicPartition);

    /**
     * 指定されたパーティションでのメッセージ消費を一時停止します。
     */
    void pause(Collection<TopicPartition> topicPartitions);

    /**
     * 以前に一時停止したパーティションでのメッセージ消費を再開します。
     */
    void resume(Collection<TopicPartition> topicPartitions);

    /**
     * 指定されたパーティション内で、与えられたタイムスタンプ以降（または該当する最初の位置）に格納された
     * 最初のメッセージのオフセットを返します。タイムスタンプは、メッセージがブローカーに格納された時刻を指し、
     * 送信時刻ではありません。
     */
    Long offsetForTimestamp(TopicPartition topicPartition, Long timestamp);

    /**
     * 指定されたパーティションの最新のコンシューマーオフセットを返します。
     */
    Long committed(TopicPartition topicPartition);

    /**
     * 現在のコンシューマーオフセットを同期的にコミットします。
     * オフセットはまずローカルクライアントに同期され、その後非同期でブローカーに書き込まれます。
     */
    void commitSync();

    /**
     * パーティション変更イベント用のリスナーインターフェイスです。
     */
    interface TopicPartitionChangeListener {
        /**
         * トピックのパーティションが変更されたときに呼び出されます（例：ブローカーのスケーリングにより
         * パーティション数が調整された場合）。
         */
        void onChanged(Set<TopicPartition> topicPartitions);
    }

    /**
     * トピックのパーティション数が変更されたときに発火するリスナーを登録します（例：ブローカーのスケーリングによる変更）。
     * デフォルトでは、コールバックの最大遅延は 5 秒です。
     */
    void registerTopicPartitionChangedListener(String topic,
            TopicPartitionChangeListener callback);
}