Class PutRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.streamnative.oxia.proto.PutRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, PutRequestOrBuilder, Serializable

public final class PutRequest extends com.google.protobuf.GeneratedMessageV3 implements PutRequestOrBuilder

 A put request. Persists the specified key and value
 
Protobuf type io.streamnative.oxia.proto.PutRequest
See Also:
  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    A put request.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     
    static final int
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
     
    Client identifier used to track the client that last modified an ephemeral record.
    com.google.protobuf.ByteString
    Client identifier used to track the client that last modified an ephemeral record.
    static PutRequest
     
     
    static final com.google.protobuf.Descriptors.Descriptor
     
    long
    An optional expected version_id.
    The key
    com.google.protobuf.ByteString
    The key
    com.google.protobuf.Parser<PutRequest>
     
    If a partition key is present, it supersedes the regular record key in determining the routing of a record to a particular shard.
    com.google.protobuf.ByteString
    If a partition key is present, it supersedes the regular record key in determining the routing of a record to a particular shard.
    repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
    int
    repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
    repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
    repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
    repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
    long
    If one or more sequence key are specified.
    int
    If one or more sequence key are specified.
    If one or more sequence key are specified.
    int
     
    long
    Optional.
    com.google.protobuf.ByteString
    The value
    boolean
    Client identifier used to track the client that last modified an ephemeral record.
    boolean
    An optional expected version_id.
    int
     
    boolean
    If a partition key is present, it supersedes the regular record key in determining the routing of a record to a particular shard.
    boolean
    Optional.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
     
    final boolean
     
     
     
     
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static PutRequest
     
    static PutRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PutRequest
    parseFrom(byte[] data)
     
    static PutRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PutRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static PutRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PutRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static PutRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PutRequest
     
    static PutRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static PutRequest
     
    static PutRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<PutRequest>
     
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
  • Field Details

    • KEY_FIELD_NUMBER

      public static final int KEY_FIELD_NUMBER
      See Also:
    • VALUE_FIELD_NUMBER

      public static final int VALUE_FIELD_NUMBER
      See Also:
    • EXPECTED_VERSION_ID_FIELD_NUMBER

      public static final int EXPECTED_VERSION_ID_FIELD_NUMBER
      See Also:
    • SESSION_ID_FIELD_NUMBER

      public static final int SESSION_ID_FIELD_NUMBER
      See Also:
    • CLIENT_IDENTITY_FIELD_NUMBER

      public static final int CLIENT_IDENTITY_FIELD_NUMBER
      See Also:
    • PARTITION_KEY_FIELD_NUMBER

      public static final int PARTITION_KEY_FIELD_NUMBER
      See Also:
    • SEQUENCE_KEY_DELTA_FIELD_NUMBER

      public static final int SEQUENCE_KEY_DELTA_FIELD_NUMBER
      See Also:
    • SECONDARY_INDEXES_FIELD_NUMBER

      public static final int SECONDARY_INDEXES_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3
    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
    • getKey

      public String getKey()
       The key
       
      string key = 1;
      Specified by:
      getKey in interface PutRequestOrBuilder
      Returns:
      The key.
    • getKeyBytes

      public com.google.protobuf.ByteString getKeyBytes()
       The key
       
      string key = 1;
      Specified by:
      getKeyBytes in interface PutRequestOrBuilder
      Returns:
      The bytes for key.
    • getValue

      public com.google.protobuf.ByteString getValue()
       The value
       
      bytes value = 2;
      Specified by:
      getValue in interface PutRequestOrBuilder
      Returns:
      The value.
    • hasExpectedVersionId

      public boolean hasExpectedVersionId()
       An optional expected version_id. The put will fail if the server's current version_id
       does not match
       
      optional int64 expected_version_id = 3;
      Specified by:
      hasExpectedVersionId in interface PutRequestOrBuilder
      Returns:
      Whether the expectedVersionId field is set.
    • getExpectedVersionId

      public long getExpectedVersionId()
       An optional expected version_id. The put will fail if the server's current version_id
       does not match
       
      optional int64 expected_version_id = 3;
      Specified by:
      getExpectedVersionId in interface PutRequestOrBuilder
      Returns:
      The expectedVersionId.
    • hasSessionId

      public boolean hasSessionId()
       Optional. Associate the new record with the session (i.e. ephemeral record).
       When the session expires or is explicitly closed, the record will be automatically
       removed
       
      optional int64 session_id = 4;
      Specified by:
      hasSessionId in interface PutRequestOrBuilder
      Returns:
      Whether the sessionId field is set.
    • getSessionId

      public long getSessionId()
       Optional. Associate the new record with the session (i.e. ephemeral record).
       When the session expires or is explicitly closed, the record will be automatically
       removed
       
      optional int64 session_id = 4;
      Specified by:
      getSessionId in interface PutRequestOrBuilder
      Returns:
      The sessionId.
    • hasClientIdentity

      public boolean hasClientIdentity()
       Client identifier used to track the client that last modified an
       ephemeral record.
       
      optional string client_identity = 5;
      Specified by:
      hasClientIdentity in interface PutRequestOrBuilder
      Returns:
      Whether the clientIdentity field is set.
    • getClientIdentity

      public String getClientIdentity()
       Client identifier used to track the client that last modified an
       ephemeral record.
       
      optional string client_identity = 5;
      Specified by:
      getClientIdentity in interface PutRequestOrBuilder
      Returns:
      The clientIdentity.
    • getClientIdentityBytes

      public com.google.protobuf.ByteString getClientIdentityBytes()
       Client identifier used to track the client that last modified an
       ephemeral record.
       
      optional string client_identity = 5;
      Specified by:
      getClientIdentityBytes in interface PutRequestOrBuilder
      Returns:
      The bytes for clientIdentity.
    • hasPartitionKey

      public boolean hasPartitionKey()
       If a partition key is present, it supersedes the regular record key in determining the routing of
       a record to a particular shard. It is passed to the server because it needs to be persisted as
       part of the record. We would need the partition_key if we're going to do a split of the shards.
       
      optional string partition_key = 6;
      Specified by:
      hasPartitionKey in interface PutRequestOrBuilder
      Returns:
      Whether the partitionKey field is set.
    • getPartitionKey

      public String getPartitionKey()
       If a partition key is present, it supersedes the regular record key in determining the routing of
       a record to a particular shard. It is passed to the server because it needs to be persisted as
       part of the record. We would need the partition_key if we're going to do a split of the shards.
       
      optional string partition_key = 6;
      Specified by:
      getPartitionKey in interface PutRequestOrBuilder
      Returns:
      The partitionKey.
    • getPartitionKeyBytes

      public com.google.protobuf.ByteString getPartitionKeyBytes()
       If a partition key is present, it supersedes the regular record key in determining the routing of
       a record to a particular shard. It is passed to the server because it needs to be persisted as
       part of the record. We would need the partition_key if we're going to do a split of the shards.
       
      optional string partition_key = 6;
      Specified by:
      getPartitionKeyBytes in interface PutRequestOrBuilder
      Returns:
      The bytes for partitionKey.
    • getSequenceKeyDeltaList

      public List<Long> getSequenceKeyDeltaList()
       If one or more sequence key are specified. The key will get added suffixes
       based on adding the delta to the current highest key with the same prefix
       
      repeated uint64 sequence_key_delta = 7;
      Specified by:
      getSequenceKeyDeltaList in interface PutRequestOrBuilder
      Returns:
      A list containing the sequenceKeyDelta.
    • getSequenceKeyDeltaCount

      public int getSequenceKeyDeltaCount()
       If one or more sequence key are specified. The key will get added suffixes
       based on adding the delta to the current highest key with the same prefix
       
      repeated uint64 sequence_key_delta = 7;
      Specified by:
      getSequenceKeyDeltaCount in interface PutRequestOrBuilder
      Returns:
      The count of sequenceKeyDelta.
    • getSequenceKeyDelta

      public long getSequenceKeyDelta(int index)
       If one or more sequence key are specified. The key will get added suffixes
       based on adding the delta to the current highest key with the same prefix
       
      repeated uint64 sequence_key_delta = 7;
      Specified by:
      getSequenceKeyDelta in interface PutRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The sequenceKeyDelta at the given index.
    • getSecondaryIndexesList

      public List<SecondaryIndex> getSecondaryIndexesList()
      repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
      Specified by:
      getSecondaryIndexesList in interface PutRequestOrBuilder
    • getSecondaryIndexesOrBuilderList

      public List<? extends SecondaryIndexOrBuilder> getSecondaryIndexesOrBuilderList()
      repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
      Specified by:
      getSecondaryIndexesOrBuilderList in interface PutRequestOrBuilder
    • getSecondaryIndexesCount

      public int getSecondaryIndexesCount()
      repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
      Specified by:
      getSecondaryIndexesCount in interface PutRequestOrBuilder
    • getSecondaryIndexes

      public SecondaryIndex getSecondaryIndexes(int index)
      repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
      Specified by:
      getSecondaryIndexes in interface PutRequestOrBuilder
    • getSecondaryIndexesOrBuilder

      public SecondaryIndexOrBuilder getSecondaryIndexesOrBuilder(int index)
      repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;
      Specified by:
      getSecondaryIndexesOrBuilder in interface PutRequestOrBuilder
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static PutRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PutRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PutRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PutRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PutRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PutRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static PutRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PutRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PutRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static PutRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PutRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static PutRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public PutRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static PutRequest.Builder newBuilder()
    • newBuilder

      public static PutRequest.Builder newBuilder(PutRequest prototype)
    • toBuilder

      public PutRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected PutRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstance

      public static PutRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<PutRequest> parser()
    • getParserForType

      public com.google.protobuf.Parser<PutRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3
    • getDefaultInstanceForType

      public PutRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder