Package io.streamnative.oxia.proto
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 valueProtobuf type
io.streamnative.oxia.proto.PutRequest- See Also:
-
Nested Class Summary
Nested ClassesNested 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
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanClient identifier used to track the client that last modified an ephemeral record.com.google.protobuf.ByteStringClient identifier used to track the client that last modified an ephemeral record.static PutRequeststatic final com.google.protobuf.Descriptors.DescriptorlongAn optional expected version_id.getKey()The keycom.google.protobuf.ByteStringThe keycom.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.ByteStringIf a partition key is present, it supersedes the regular record key in determining the routing of a record to a particular shard.getSecondaryIndexes(int index) repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;intrepeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;getSecondaryIndexesOrBuilder(int index) repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;List<? extends SecondaryIndexOrBuilder>repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;longgetSequenceKeyDelta(int index) If one or more sequence key are specified.intIf one or more sequence key are specified.If one or more sequence key are specified.intlongOptional.com.google.protobuf.ByteStringgetValue()The valuebooleanClient identifier used to track the client that last modified an ephemeral record.booleanAn optional expected version_id.inthashCode()booleanIf a partition key is present, it supersedes the regular record key in determining the routing of a record to a particular shard.booleanOptional.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanstatic PutRequest.Builderstatic PutRequest.BuildernewBuilder(PutRequest prototype) protected PutRequest.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static PutRequestparseDelimitedFrom(InputStream input) static PutRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PutRequestparseFrom(byte[] data) static PutRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PutRequestparseFrom(com.google.protobuf.ByteString data) static PutRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PutRequestparseFrom(com.google.protobuf.CodedInputStream input) static PutRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PutRequestparseFrom(InputStream input) static PutRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static PutRequestparseFrom(ByteBuffer data) static PutRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<PutRequest>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods 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
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3
-
getKey
The key
string key = 1;- Specified by:
getKeyin interfacePutRequestOrBuilder- Returns:
- The key.
-
getKeyBytes
public com.google.protobuf.ByteString getKeyBytes()The key
string key = 1;- Specified by:
getKeyBytesin interfacePutRequestOrBuilder- Returns:
- The bytes for key.
-
getValue
public com.google.protobuf.ByteString getValue()The value
bytes value = 2;- Specified by:
getValuein interfacePutRequestOrBuilder- 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:
hasExpectedVersionIdin interfacePutRequestOrBuilder- 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:
getExpectedVersionIdin interfacePutRequestOrBuilder- 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:
hasSessionIdin interfacePutRequestOrBuilder- 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:
getSessionIdin interfacePutRequestOrBuilder- 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:
hasClientIdentityin interfacePutRequestOrBuilder- Returns:
- Whether the clientIdentity field is set.
-
getClientIdentity
Client identifier used to track the client that last modified an ephemeral record.
optional string client_identity = 5;- Specified by:
getClientIdentityin interfacePutRequestOrBuilder- 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:
getClientIdentityBytesin interfacePutRequestOrBuilder- 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:
hasPartitionKeyin interfacePutRequestOrBuilder- Returns:
- Whether the partitionKey field is set.
-
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:
getPartitionKeyin interfacePutRequestOrBuilder- 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:
getPartitionKeyBytesin interfacePutRequestOrBuilder- Returns:
- The bytes for partitionKey.
-
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:
getSequenceKeyDeltaListin interfacePutRequestOrBuilder- 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:
getSequenceKeyDeltaCountin interfacePutRequestOrBuilder- 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:
getSequenceKeyDeltain interfacePutRequestOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The sequenceKeyDelta at the given index.
-
getSecondaryIndexesList
repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;- Specified by:
getSecondaryIndexesListin interfacePutRequestOrBuilder
-
getSecondaryIndexesOrBuilderList
repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;- Specified by:
getSecondaryIndexesOrBuilderListin interfacePutRequestOrBuilder
-
getSecondaryIndexesCount
public int getSecondaryIndexesCount()repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;- Specified by:
getSecondaryIndexesCountin interfacePutRequestOrBuilder
-
getSecondaryIndexes
repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;- Specified by:
getSecondaryIndexesin interfacePutRequestOrBuilder
-
getSecondaryIndexesOrBuilder
repeated .io.streamnative.oxia.proto.SecondaryIndex secondary_indexes = 8;- Specified by:
getSecondaryIndexesOrBuilderin interfacePutRequestOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static PutRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static PutRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static PutRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected PutRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-