パッケージ org.springframework.data.redis.core

インターフェース StreamOperations<K,HK,HV>

すべてのスーパーインターフェース:
HashMapperProvider<HK,HV>
public interface StreamOperations<K,HK,HV> extends HashMapperProvider<HK,HV>
Redis ストリーム固有の操作。
導入:
2.2
作成者:
Mark Paluch, Christoph Strobl, Dengliming, Marcin Zielinski, John Blum

  • メソッドの詳細

    • acknowledge

      @Nullable LongSE acknowledge(K key, StringSE group, StringSE... recordIds)
      1 つ以上のレコードを処理済みとして確認します。
      パラメーター:
      key - ストリームキー。
      group - コンシューマーグループの名前。
      recordIds - 確認するレコード ID。
      戻り値:
      確認済みレコードの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • acknowledge

      @Nullable default LongSE acknowledge(K key, StringSE group, RecordId... recordIds)
      1 つ以上のレコードを処理済みとして確認します。
      パラメーター:
      key - ストリームキー。
      group - コンシューマーグループの名前。
      recordIds - 確認するレコード ID。
      戻り値:
      確認済みレコードの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • acknowledge

      default LongSE acknowledge(StringSE group, Record<K,?> record)
      指定されたレコードを処理済みとして確認します。
      パラメーター:
      group - コンシューマーグループの名前。
      record - 確認する Record。
      戻り値:
      確認済みレコードの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • add

      @Nullable default RecordId add(K key, MapSE<? extends HK,? extends HV> content)
      ストリーム key にレコードを追加します。
      パラメーター:
      key - ストリームキー。
      content - コンテンツをマップとして記録します。
      戻り値:
      レコード ID。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • add

      @Nullable default RecordId add(MapRecord<K,? extends HK,? extends HV> record)
      フィールドと値のペアを保持する MapSE によるレコードをストリームに追加します。
      パラメーター:
      record - 追加するレコード。
      戻り値:
      レコード ID。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • add

      @Nullable RecordId add(Record<K,?> record)
      指定された値によるレコードをストリームに追加します。値はハッシュとしてマップされ、直列化されます。
      パラメーター:
      record - null であってはなりません。
      戻り値:
      レコード ID。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • claim

      default ListSE<MapRecord<K,HK,HV>> claim(K key, StringSE consumerGroup, StringSE newOwner, DurationSE minIdleTime, RecordId... recordIds)
      新しい所有者がコマンド引数として指定されたコンシューマーになるように、保留中のメッセージの所有権を変更します。メッセージは、そのアイドル時間 (ミリ秒) が、XCLAIM の呼び出し時に指定された特定の minimum idle timeSE よりも大きい場合にのみ要求されます。
      パラメーター:
      key - 蒸気への key。
      consumerGroup - コンシューマーグループの nameSE。
      newOwner - メッセージを要求するコンシューマーの nameSE。
      minIdleTime - メッセージを要求するには minimum idle timeSE が必要です。
      recordIds - 主張する record IDs。
      戻り値:
      主張された MapRecords の ListSE。
      関連事項:

    • claim

      ListSE<MapRecord<K,HK,HV>> claim(K key, StringSE consumerGroup, StringSE newOwner, RedisStreamCommands.XClaimOptions xClaimOptions)
      新しい所有者がコマンド引数として指定されたコンシューマーになるように、保留中のメッセージの所有権を変更します。メッセージは、そのアイドル時間 (ミリ秒) が、XCLAIM の呼び出し時に指定された特定の minimum idle timeSE よりも大きい場合にのみ要求されます。
      パラメーター:
      key - 蒸気への key。
      consumerGroup - コンシューマーグループの nameSE。
      newOwner - メッセージを要求するコンシューマーの nameSE。
      xClaimOptions - CLAIM 呼び出しの追加パラメーター。
      戻り値:
      主張された MapRecords の ListSE。
      関連事項:

    • delete

      @Nullable default LongSE delete(K key, StringSE... recordIds)
      指定されたレコードをストリームから削除します。削除されたレコードの数を返します。特定の ID が存在しない場合に渡される ID の数とは異なる場合があります。
      パラメーター:
      key - ストリームキー。
      recordIds - ストリームレコード ID。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • delete

      @Nullable default LongSE delete(Record<K,?> record)
      指定された Record をストリームから削除します。
      パラメーター:
      record - null であってはなりません。
      戻り値:
      Mono は、削除されたレコードの数を出力します。

    • delete

      @Nullable LongSE delete(K key, RecordId... recordIds)
      指定されたレコードをストリームから削除します。削除されたレコードの数を返します。特定の ID が存在しない場合に渡される ID の数とは異なる場合があります。
      パラメーター:
      key - ストリームキー。
      recordIds - ストリームレコード ID。
      戻り値:
      Mono は、削除されたレコードの数を出力します。
      関連事項:

    • createGroup

      default StringSE createGroup(K key, StringSE group)
      latest offset でコンシューマーグループを作成します。ストリームがまだ存在しない場合、このコマンドはストリームを作成します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      戻り値:
      成功すれば OK。パイプライン / トランザクションで使用される場合は null。

    • createGroup

      @Nullable StringSE createGroup(K key, ReadOffset readOffset, StringSE group)
      コンシューマーグループを作成します。ストリームがまだ存在しない場合、このコマンドはストリームを作成します。
      パラメーター:
      key - ストリームが保存されているキー。
      readOffset - 適用する ReadOffset
      group - コンシューマーグループの名前。
      戻り値:
      成功すれば OK。パイプライン / トランザクションで使用される場合は null。

    • deleteConsumer

      @Nullable BooleanSE deleteConsumer(K key, Consumer consumer)
      コンシューマーグループからコンシューマーを削除します。
      パラメーター:
      key - ストリームキー。
      consumer - グループ名とコンシューマーキーで識別されるコンシューマー。
      戻り値:
      成功した場合は true。パイプライン / トランザクションで使用される場合は null。

    • destroyGroup

      @Nullable BooleanSE destroyGroup(K key, StringSE group)
      コンシューマーグループを破棄します。
      パラメーター:
      key - ストリームキー。
      group - コンシューマーグループの名前。
      戻り値:
      成功した場合は true。パイプライン / トランザクションで使用される場合は null。

    • consumers

      StreamInfo.XInfoConsumers consumers(K key, StringSE group)
      指定されたキーに格納されているストリームの特定のコンシューマーグループ内のすべてのコンシューマーに関する情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      group - コンシューマーグループの名前。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • groups

      StreamInfo.XInfoGroups groups(K key)
      指定されたキーに格納されているストリームに関連付けられているコンシューマーグループに関する情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • info

      StreamInfo.XInfoStream info(K key)
      指定されたキーに保存されているストリームに関する一般情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。
      戻り値:
      パイプライン / トランザクションで使用される場合は null。
      導入:
      2.3

    • pending

      @Nullable PendingMessagesSummary pending(K key, StringSE group)
      特定のコンシューマーグループの PendingMessagesSummary を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      group - コンシューマーグループの名前。null であってはなりません。
      戻り値:
      指定されたコンシューマーグループ内の保留中のメッセージの要約、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • pending

      default PendingMessages pending(K key, Consumer consumer)
      特定の Consumer のすべての保留中のメッセージに関する詳細情報を取得しました。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      consumer - PendingMessages をフェッチするコンシューマー。null であってはなりません。
      戻り値:
      指定された Consumer の保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • pending

      PendingMessages pending(K key, StringSE group, Range<?> range, long count)
      コンシューマーグループ内の特定の Range の保留中の messages に関する詳細情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      group - コンシューマーグループの名前。null であってはなりません。
      range - 検索するメッセージ ID の範囲。null であってはなりません。
      count - 結果の数を制限します。
      戻り値:
      指定されたコンシューマーグループの保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • pending

      PendingMessages pending(K key, Consumer consumer, Range<?> range, long count)
      コンシューマーグループ内の特定の Range および Consumer の保留中の messages に関する詳細情報を取得します。
      パラメーター:
      key - ストリームが保存されているキー。null であってはなりません。
      consumer - Consumer の名前。null であってはなりません。
      range - 検索するメッセージ ID の範囲。null であってはなりません。
      count - 結果の数を制限します。
      戻り値:
      指定された Consumer の保留中のメッセージ、またはパイプライン / トランザクションで使用される場合は null。
      導入:
      2.3
      関連事項:

    • size

      @Nullable LongSE size(K key)
      ストリームの長さを取得します。
      パラメーター:
      key - ストリームキー。
      戻り値:
      ストリームの長さ。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • range

      @Nullable default ListSE<MapRecord<K,HK,HV>> range(K key, Range<StringSE> range)
      特定の Range 内のストリームからレコードを読み取ります。
      パラメーター:
      key - ストリームキー。
      range - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • range

      @Nullable ListSE<MapRecord<K,HK,HV>> range(K key, Range<StringSE> range, Limit limit)
      Limit を適用して、特定の Range 内のストリームからレコードを読み取ります。
      パラメーター:
      key - ストリームキー。
      range - null であってはなりません。
      limit - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • range

      default <V> ListSE<ObjectRecord<K,V>> range(ClassSE<V> targetType, K key, Range<StringSE> range)
      特定の Range 内のストリームからすべてのレコードを ObjectRecord として読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      key - ストリームキー。
      range - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • range

      default <V> ListSE<ObjectRecord<K,V>> range(ClassSE<V> targetType, K key, Range<StringSE> range, Limit limit)
      Limit を ObjectRecord として適用して、特定の Range 内のストリームからレコードを読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      key - ストリームキー。
      range - null であってはなりません。
      limit - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable default ListSE<MapRecord<K,HK,HV>> read(StreamOffset<K>... streams)
      1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      default <V> ListSE<ObjectRecord<K,V>> read(ClassSE<V> targetType, StreamOffset<K>... streams)
      1 つ以上の StreamOffset からのレコードを ObjectRecord として読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable ListSE<MapRecord<K,HK,HV>> read(StreamReadOptions readOptions, StreamOffset<K>... streams)
      1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      readOptions - 引数を読み取ります。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable default <V> ListSE<ObjectRecord<K,V>> read(ClassSE<V> targetType, StreamReadOptions readOptions, StreamOffset<K>... streams)
      1 つ以上の StreamOffset からのレコードを ObjectRecord として読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      readOptions - 引数を読み取ります。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable default ListSE<MapRecord<K,HK,HV>> read(Consumer consumer, StreamOffset<K>... streams)
      コンシューマーグループを使用して、1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      consumer - コンシューマー / グループ。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable default <V> ListSE<ObjectRecord<K,V>> read(ClassSE<V> targetType, Consumer consumer, StreamOffset<K>... streams)
      コンシューマーグループを ObjectRecord として使用して、1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      consumer - コンシューマー / グループ。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable ListSE<MapRecord<K,HK,HV>> read(Consumer consumer, StreamReadOptions readOptions, StreamOffset<K>... streams)
      コンシューマーグループを使用して、1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      consumer - コンシューマー / グループ。
      readOptions - 引数を読み取ります。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • read

      @Nullable default <V> ListSE<ObjectRecord<K,V>> read(ClassSE<V> targetType, Consumer consumer, StreamReadOptions readOptions, StreamOffset<K>... streams)
      コンシューマーグループを ObjectRecord として使用して、1 つ以上の StreamOffset からレコードを読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      consumer - コンシューマー / グループ。
      readOptions - 引数を読み取ります。
      streams - 読み取るストリーム。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • reverseRange

      @Nullable default ListSE<MapRecord<K,HK,HV>> reverseRange(K key, Range<StringSE> range)
      特定の Range 内のストリームからレコードを逆の順序で読み取ります。
      パラメーター:
      key - ストリームキー。
      range - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • reverseRange

      @Nullable ListSE<MapRecord<K,HK,HV>> reverseRange(K key, Range<StringSE> range, Limit limit)
      Limit を逆の順序で適用して、特定の Range 内のストリームからレコードを読み取ります。
      パラメーター:
      key - ストリームキー。
      range - null であってはなりません。
      limit - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • reverseRange

      default <V> ListSE<ObjectRecord<K,V>> reverseRange(ClassSE<V> targetType, K key, Range<StringSE> range)
      特定の Range 内のストリームから、ObjectRecord と逆の順序でレコードを読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      key - ストリームキー。
      range - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • reverseRange

      default <V> ListSE<ObjectRecord<K,V>> reverseRange(ClassSE<V> targetType, K key, Range<StringSE> range, Limit limit)
      ObjectRecord とは逆の順序で Limit を適用して、特定の Range 内のストリームからレコードを読み取ります。
      パラメーター:
      targetType - ペイロードのターゲット型。
      key - ストリームキー。
      range - null であってはなりません。
      limit - null であってはなりません。
      戻り値:
      結果のストリームのメンバーをリストします。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • trim

      @Nullable LongSE trim(K key, long count)
      ストリームを count 要素にトリミングします。
      パラメーター:
      key - ストリームキー。
      count - ストリームの長さ。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      関連事項:

    • trim

      @Nullable LongSE trim(K key, long count, boolean approximateTrimming)
      ストリームを count 要素にトリミングします。
      パラメーター:
      key - ストリームキー。
      count - ストリームの長さ。
      approximateTrimming - パフォーマンスを最大化するには、おおよその方法でトリミングを実行する必要があります。
      戻り値:
      削除されたエントリの数。パイプライン / トランザクションで使用される場合は null。
      導入:
      2.4
      関連事項:

    • getHashMapper

      <V> HashMapper<V,HK,HV> getHashMapper(ClassSE<V> targetType)
      特定の型の HashMapper を取得します。
      次で指定:
      インターフェース HashMapperProvider<K,HK> の getHashMapper 
      型パラメーター:
      V -
      パラメーター:
      targetType - null であってはなりません。
      戻り値:
      特定の型に適した HashMapper。

    • map

      default <V> ObjectRecord<K,V> map(MapRecord<K,HK,HV> record, ClassSE<V> targetType)
      レコードを MapRecord から ObjectRecord にマップします。
      パラメーター:
      record - マップするストリームレコード。
      targetType - ペイロードのターゲット型。
      戻り値:
      マップされた ObjectRecord
      導入:
      2.x

    • map

      @Nullable default <V> ListSE<ObjectRecord<K,V>> map(@Nullable ListSE<MapRecord<K,HK,HV>> records, ClassSE<V> targetType)
      レコードを MapRecord から ObjectRecord にマップします。
      パラメーター:
      records - マップするストリームレコード。
      targetType - ペイロードのターゲット型。
      戻り値:
      マップされた object records
      導入:
      2.x

    • deserializeRecord

      MapRecord<K,HK,HV> deserializeRecord(ByteRecord record)
      構成されたシリアライザーを使用して ByteRecord を MapRecord に逆直列化します。
      パラメーター:
      record - マップするストリームレコード。
      戻り値:
      デシリアライズされた MapRecord。
      導入:
      2.x