Package io.streamnative.oxia.client.api

Interface GetOption

All Known Implementing Classes:
OptionComparisonType, OptionPartitionKey
public sealed interface GetOption permits OptionComparisonType, OptionPartitionKey

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final GetOption
    ComparisonCeiling
    ComparisonCeiling option will make the get operation to search for the record whose key is the lowest key >= to the supplied key.
    static final GetOption
    ComparisonEqual
    ComparisonEqual sets the Get() operation to compare the stored key for equality.
    static final GetOption
    ComparisonFloor
    ComparisonFloor option will make the get operation to search for the record whose key is the highest key <= to the supplied key.
    static final GetOption
    ComparisonHigher
    ComparisonHigher option will make the get operation to search for the record whose key is strictly > to the supplied key.
    static final GetOption
    ComparisonLower
    ComparisonLower option will make the get operation to search for the record whose key is strictly < to the supplied key.

  • Method Summary

    Static Methods
    Modifier and Type
    Method
    Description
    static GetOption
    PartitionKey(@NonNull String partitionKey)
    PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.

  • Field Details

    • ComparisonEqual

      static final GetOption ComparisonEqual
      ComparisonEqual sets the Get() operation to compare the stored key for equality.

    • ComparisonFloor

      static final GetOption ComparisonFloor
      ComparisonFloor option will make the get operation to search for the record whose key is the highest key <= to the supplied key.

    • ComparisonCeiling

      static final GetOption ComparisonCeiling
      ComparisonCeiling option will make the get operation to search for the record whose key is the lowest key >= to the supplied key.

    • ComparisonLower

      static final GetOption ComparisonLower
      ComparisonLower option will make the get operation to search for the record whose key is strictly < to the supplied key.

    • ComparisonHigher

      static final GetOption ComparisonHigher
      ComparisonHigher option will make the get operation to search for the record whose key is strictly > to the supplied key.

  • Method Details

    • PartitionKey

      static GetOption PartitionKey(@NonNull @NonNull String partitionKey)
      PartitionKey overrides the partition routing with the specified `partitionKey` instead of the regular record key.

      Records with the same partitionKey will always be guaranteed to be co-located in the same Oxia shard.

      Parameters:
      partitionKey - the partition key to use