クラス QueueBuilder

java.lang.ObjectSE
org.springframework.amqp.core.AbstractBuilder
org.springframework.amqp.core.QueueBuilder

public final class QueueBuilder extends AbstractBuilder
流れるような API を使用して Spring AMQP キューを構築します。
導入:
1.6
作成者:
Maciej Walkowiak, Gary Russell, Artem Bilan
  • ネストされたクラスの概要

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static enum
    キューリーダーを見つけます。
    static enum
    オーバーフロー引数値。
  • 方法の概要

    修飾子と型
    メソッド
    説明
    最終キューは自動削除されます。
    最終キューを構築します。
    デフォルトのキューではなく、classic 型のキューを宣言するように、queue 引数を設定します。
    期限切れまたは拒否されたメッセージをルーティングする配信不能交換を設定します。
    期限切れまたは拒否されたメッセージを配信不能交換にルーティングするときに使用するルーティングキーを設定します。
    deliveryLimit(int limit)
    配信制限を設定します。クォーラムキューにのみ適用されます。
    生成された一意の名前 spring.gen-<random> を持つ永続キューのビルダーを作成します。
    永続キューのビルダーを作成します。
    最終キューは排他的になります。
    expires(int expires)
    キューが削除される前に未使用のままでいられる時間を設定します。
    キューを遅延モードに設定し、できるだけ多くのメッセージをディスクに保持して、ブローカーの RAM 使用量を減らします。
    ノードのクラスター上でキューマスターを配置するノードを決定するマスターロケーターモードを設定します。
    maxLength(long count)
    ドロップを開始する前にキューで許可される (準備完了の) メッセージの数を設定します。
    maxLengthBytes(int bytes)
    ドロップを開始する前に、キューで許可される集約ボディの合計サイズを設定します。
    maxPriority(int maxPriority)
    キューがサポートする優先度レベルの場合、最大数を設定します。設定されていない場合、キューはメッセージの優先度をサポートしません。
    非永続 (一時) キューのビルダーを作成します。
    非永続 (一時) キューのビルダーを作成します。
    最大メッセージまたは最大メッセージサイズを超えたためにメッセージがドロップされた場合のオーバーフローモードを設定します。
    デフォルトのキューではなく、quorum 型のキューを宣言するようにキュー引数を設定します。
    "x-single-active-consumer" キュー引数を設定します。
    デフォルトのキューではなく、stream 型のキューを宣言するようにキュー引数を設定します。
    ttl(int ttl)
    メッセージの有効期限を設定します。有効期限が過ぎると、メッセージは破棄されるか、設定されている場合、デッドレター交換にルーティングされます。
    最終的なキューには、キューを宣言するために使用された引数が含まれます。
    最後のキューには、キューを宣言するために使用される引数が含まれます。

    クラス org.springframework.amqp.core.AbstractBuilder から継承されたメソッド

    getArguments, getOrCreateArguments

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
  • 方法の詳細

    • durable

      public static QueueBuilder durable()
      生成された一意の名前 spring.gen-<random> を持つ永続キューのビルダーを作成します。
      戻り値:
      QueueBuilder インスタンス。
    • nonDurable

      public static QueueBuilder nonDurable()
      非永続 (一時) キューのビルダーを作成します。
      戻り値:
      QueueBuilder インスタンス。
    • durable

      public static QueueBuilder durable(StringSE name)
      永続キューのビルダーを作成します。
      パラメーター:
      name - キューの名前。
      戻り値:
      QueueBuilder インスタンス。
    • nonDurable

      public static QueueBuilder nonDurable(StringSE name)
      非永続 (一時) キューのビルダーを作成します。
      パラメーター:
      name - キューの名前。
      戻り値:
      QueueBuilder インスタンス。
    • exclusive

      public QueueBuilder exclusive()
      最終キューは排他的になります。
      戻り値:
      QueueBuilder インスタンス。
    • autoDelete

      public QueueBuilder autoDelete()
      最終キューは自動削除されます。
      戻り値:
      QueueBuilder インスタンス。
    • withArgument

      public QueueBuilder withArgument(StringSE key, ObjectSE value)
      最終的なキューには、キューを宣言するために使用された引数が含まれます。
      パラメーター:
      key - 引数名
      value - 引数値
      戻り値:
      QueueBuilder インスタンス。
    • withArguments

      public QueueBuilder withArguments(MapSE<StringSE,ObjectSE> arguments)
      最後のキューには、キューを宣言するために使用される引数が含まれます。
      パラメーター:
      arguments - 引数マップ
      戻り値:
      QueueBuilder インスタンス。
    • ttl

      public QueueBuilder ttl(int ttl)
      メッセージの有効期限を設定します。有効期限が過ぎると、メッセージは破棄されるか、設定されている場合、デッドレター交換にルーティングされます。
      パラメーター:
      ttl - 存続時間 (ミリ秒)。
      戻り値:
      ビルダー。
      導入:
      2.2
      関連事項:
    • expires

      public QueueBuilder expires(int expires)
      キューが削除される前に未使用のままでいられる時間を設定します。
      パラメーター:
      expires - 有効期限 (ミリ秒)。
      戻り値:
      ビルダー。
      導入:
      2.2
    • maxLength

      public QueueBuilder maxLength(long count)
      ドロップを開始する前にキューで許可される (準備完了の) メッセージの数を設定します。
      パラメーター:
      count - 許容される (準備完了の) メッセージの数。
      戻り値:
      ビルダー。
      導入:
      3.1
      関連事項:
    • maxLengthBytes

      public QueueBuilder maxLengthBytes(int bytes)
      ドロップを開始する前に、キューで許可される集約ボディの合計サイズを設定します。
      パラメーター:
      bytes - 総集合体サイズ。
      戻り値:
      ビルダー。
      導入:
      2.2
    • overflow

      public QueueBuilder overflow(QueueBuilder.Overflow overflow)
      最大メッセージまたは最大メッセージサイズを超えたためにメッセージがドロップされた場合のオーバーフローモードを設定します。
      パラメーター:
      overflow - QueueBuilder.Overflow.dropHead または QueueBuilder.Overflow.rejectPublish
      戻り値:
      ビルダー。
      導入:
      2.2
    • deadLetterExchange

      public QueueBuilder deadLetterExchange(StringSE dlx)
      期限切れまたは拒否されたメッセージをルーティングする配信不能交換を設定します。
      パラメーター:
      dlx - デッドレター交換。
      戻り値:
      ビルダー。
      導入:
      2.2
      関連事項:
    • deadLetterRoutingKey

      public QueueBuilder deadLetterRoutingKey(StringSE dlrk)
      期限切れまたは拒否されたメッセージを配信不能交換にルーティングするときに使用するルーティングキーを設定します。
      パラメーター:
      dlrk - 配信不能ルーティングキー。
      戻り値:
      ビルダー。
      導入:
      2.2
      関連事項:
    • maxPriority

      public QueueBuilder maxPriority(int maxPriority)
      キューがサポートする優先度レベルの場合、最大数を設定します。設定されていない場合、キューはメッセージの優先度をサポートしません。
      パラメーター:
      maxPriority - 最大の優先度。
      戻り値:
      ビルダー。
      導入:
      2.2
    • lazy

      public QueueBuilder lazy()
      キューを遅延モードに設定し、できるだけ多くのメッセージをディスクに保持して、ブローカーの RAM 使用量を減らします。設定されていない場合、キューはメッセージをできるだけ速く配信するためにメモリ内キャッシュを保持します。
      戻り値:
      ビルダー。
      導入:
      2.2
    • leaderLocator

      public QueueBuilder leaderLocator(QueueBuilder.LeaderLocator locator)
      ノードのクラスター上でキューマスターを配置するノードを決定するマスターロケーターモードを設定します。
      パラメーター:
      locator - QueueBuilder.LeaderLocator
      戻り値:
      ビルダー。
      導入:
      2.2
    • singleActiveConsumer

      public QueueBuilder singleActiveConsumer()
      "x-single-active-consumer" キュー引数を設定します。
      戻り値:
      ビルダー。
      導入:
      2.2.2
    • classic

      public QueueBuilder classic()
      デフォルトのキューではなく、classic 型のキューを宣言するように、queue 引数を設定します。
      戻り値:
      ビルダー。
      導入:
      3.2.10
    • quorum

      public QueueBuilder quorum()
      デフォルトのキューではなく、quorum 型のキューを宣言するようにキュー引数を設定します。
      戻り値:
      ビルダー。
      導入:
      2.2.2
    • stream

      public QueueBuilder stream()
      デフォルトのキューではなく、stream 型のキューを宣言するようにキュー引数を設定します。
      戻り値:
      ビルダー。
      導入:
      2.4
    • deliveryLimit

      public QueueBuilder deliveryLimit(int limit)
      配信制限を設定します。クォーラムキューにのみ適用されます。
      パラメーター:
      limit - 限界。
      戻り値:
      ビルダー。
      導入:
      2.2.2
      関連事項:
    • build

      public Queue build()
      最終キューを構築します。
      戻り値:
      Queue インスタンス。