public static final class Kvrpcpb.Context extends com.google.protobuf.GeneratedMessageV3 implements Kvrpcpb.ContextOrBuilder
Miscellaneous metadata attached to most requests.Protobuf type
kvrpcpb.Context| Modifier and Type | Class and Description |
|---|---|
static class |
Kvrpcpb.Context.Builder
Miscellaneous metadata attached to most requests.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
API_VERSION_FIELD_NUMBER |
static int |
APPLIED_INDEX_FIELD_NUMBER |
static int |
COMMITTED_LOCKS_FIELD_NUMBER |
static int |
DISK_FULL_OPT_FIELD_NUMBER |
static int |
IS_RETRY_REQUEST_FIELD_NUMBER |
static int |
ISOLATION_LEVEL_FIELD_NUMBER |
static int |
MAX_EXECUTION_DURATION_MS_FIELD_NUMBER |
static int |
NOT_FILL_CACHE_FIELD_NUMBER |
static int |
PEER_FIELD_NUMBER |
static int |
PRIORITY_FIELD_NUMBER |
static int |
RECORD_SCAN_STAT_FIELD_NUMBER |
static int |
RECORD_TIME_STAT_FIELD_NUMBER |
static int |
REGION_EPOCH_FIELD_NUMBER |
static int |
REGION_ID_FIELD_NUMBER |
static int |
REPLICA_READ_FIELD_NUMBER |
static int |
RESOLVED_LOCKS_FIELD_NUMBER |
static int |
RESOURCE_GROUP_TAG_FIELD_NUMBER |
static int |
STALE_READ_FIELD_NUMBER |
static int |
SYNC_LOG_FIELD_NUMBER |
static int |
TASK_ID_FIELD_NUMBER |
static int |
TERM_FIELD_NUMBER |
static int |
TRACE_CONTEXT_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
Kvrpcpb.APIVersion |
getApiVersion()
API version implies the encode of the key and value.
|
int |
getApiVersionValue()
API version implies the encode of the key and value.
|
long |
getAppliedIndex()
After a region applies to `applied_index`, we can get a
snapshot for the region even if the peer is a follower.
|
long |
getCommittedLocks(int index)
Read request should read through locks belonging to these transactions because these
transactions are committed and theirs commit_ts <= read request's start_ts.
|
int |
getCommittedLocksCount()
Read request should read through locks belonging to these transactions because these
transactions are committed and theirs commit_ts <= read request's start_ts.
|
List<Long> |
getCommittedLocksList()
Read request should read through locks belonging to these transactions because these
transactions are committed and theirs commit_ts <= read request's start_ts.
|
static Kvrpcpb.Context |
getDefaultInstance() |
Kvrpcpb.Context |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
Kvrpcpb.DiskFullOpt |
getDiskFullOpt()
Used to tell TiKV whether operations are allowed or not on different disk usages.
|
int |
getDiskFullOptValue()
Used to tell TiKV whether operations are allowed or not on different disk usages.
|
Kvrpcpb.IsolationLevel |
getIsolationLevel()
.kvrpcpb.IsolationLevel isolation_level = 7; |
int |
getIsolationLevelValue()
.kvrpcpb.IsolationLevel isolation_level = 7; |
boolean |
getIsRetryRequest()
Indicates the request is a retry request and the same request may have been sent before.
|
long |
getMaxExecutionDurationMs()
uint64 max_execution_duration_ms = 14; |
boolean |
getNotFillCache()
bool not_fill_cache = 8; |
com.google.protobuf.Parser<Kvrpcpb.Context> |
getParserForType() |
Metapb.Peer |
getPeer()
.metapb.Peer peer = 3; |
Metapb.PeerOrBuilder |
getPeerOrBuilder()
.metapb.Peer peer = 3; |
Kvrpcpb.CommandPri |
getPriority()
.kvrpcpb.CommandPri priority = 6; |
int |
getPriorityValue()
.kvrpcpb.CommandPri priority = 6; |
boolean |
getRecordScanStat()
True means RocksDB scan statistics should be recorded and returned.
|
boolean |
getRecordTimeStat()
True means execution time statistics should be recorded and returned.
|
Metapb.RegionEpoch |
getRegionEpoch()
.metapb.RegionEpoch region_epoch = 2; |
Metapb.RegionEpochOrBuilder |
getRegionEpochOrBuilder()
.metapb.RegionEpoch region_epoch = 2; |
long |
getRegionId()
uint64 region_id = 1; |
boolean |
getReplicaRead()
bool replica_read = 12; |
long |
getResolvedLocks(int index)
Read requests can ignore locks belonging to these transactions because either
these transactions are rolled back or theirs commit_ts > read request's start_ts.
|
int |
getResolvedLocksCount()
Read requests can ignore locks belonging to these transactions because either
these transactions are rolled back or theirs commit_ts > read request's start_ts.
|
List<Long> |
getResolvedLocksList()
Read requests can ignore locks belonging to these transactions because either
these transactions are rolled back or theirs commit_ts > read request's start_ts.
|
com.google.protobuf.ByteString |
getResourceGroupTag()
Any additional serialized information about the request.
|
int |
getSerializedSize() |
boolean |
getStaleRead()
Not required to read the most up-to-date data, replicas with `safe_ts` >= `start_ts`
can handle read request directly
|
boolean |
getSyncLog()
bool sync_log = 9; |
long |
getTaskId()
A hint for TiKV to schedule tasks more fairly.
|
long |
getTerm()
uint64 term = 5; |
Tracepb.TraceContext |
getTraceContext()
The informantion to trace a request sent to TiKV.
|
Tracepb.TraceContextOrBuilder |
getTraceContextOrBuilder()
The informantion to trace a request sent to TiKV.
|
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
int |
hashCode() |
boolean |
hasPeer()
.metapb.Peer peer = 3; |
boolean |
hasRegionEpoch()
.metapb.RegionEpoch region_epoch = 2; |
boolean |
hasTraceContext()
The informantion to trace a request sent to TiKV.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static Kvrpcpb.Context.Builder |
newBuilder() |
static Kvrpcpb.Context.Builder |
newBuilder(Kvrpcpb.Context prototype) |
Kvrpcpb.Context.Builder |
newBuilderForType() |
protected Kvrpcpb.Context.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Kvrpcpb.Context |
parseDelimitedFrom(InputStream input) |
static Kvrpcpb.Context |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Kvrpcpb.Context |
parseFrom(byte[] data) |
static Kvrpcpb.Context |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Kvrpcpb.Context |
parseFrom(ByteBuffer data) |
static Kvrpcpb.Context |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Kvrpcpb.Context |
parseFrom(com.google.protobuf.ByteString data) |
static Kvrpcpb.Context |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Kvrpcpb.Context |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Kvrpcpb.Context |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Kvrpcpb.Context |
parseFrom(InputStream input) |
static Kvrpcpb.Context |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Kvrpcpb.Context> |
parser() |
Kvrpcpb.Context.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, 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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int REGION_ID_FIELD_NUMBER
public static final int REGION_EPOCH_FIELD_NUMBER
public static final int PEER_FIELD_NUMBER
public static final int TERM_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
public static final int ISOLATION_LEVEL_FIELD_NUMBER
public static final int NOT_FILL_CACHE_FIELD_NUMBER
public static final int SYNC_LOG_FIELD_NUMBER
public static final int RECORD_TIME_STAT_FIELD_NUMBER
public static final int RECORD_SCAN_STAT_FIELD_NUMBER
public static final int REPLICA_READ_FIELD_NUMBER
public static final int RESOLVED_LOCKS_FIELD_NUMBER
public static final int MAX_EXECUTION_DURATION_MS_FIELD_NUMBER
public static final int APPLIED_INDEX_FIELD_NUMBER
public static final int TASK_ID_FIELD_NUMBER
public static final int STALE_READ_FIELD_NUMBER
public static final int RESOURCE_GROUP_TAG_FIELD_NUMBER
public static final int DISK_FULL_OPT_FIELD_NUMBER
public static final int IS_RETRY_REQUEST_FIELD_NUMBER
public static final int API_VERSION_FIELD_NUMBER
public static final int COMMITTED_LOCKS_FIELD_NUMBER
public static final int TRACE_CONTEXT_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields in interface com.google.protobuf.MessageOrBuildergetUnknownFields in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public long getRegionId()
uint64 region_id = 1;getRegionId in interface Kvrpcpb.ContextOrBuilderpublic boolean hasRegionEpoch()
.metapb.RegionEpoch region_epoch = 2;hasRegionEpoch in interface Kvrpcpb.ContextOrBuilderpublic Metapb.RegionEpoch getRegionEpoch()
.metapb.RegionEpoch region_epoch = 2;getRegionEpoch in interface Kvrpcpb.ContextOrBuilderpublic Metapb.RegionEpochOrBuilder getRegionEpochOrBuilder()
.metapb.RegionEpoch region_epoch = 2;getRegionEpochOrBuilder in interface Kvrpcpb.ContextOrBuilderpublic boolean hasPeer()
.metapb.Peer peer = 3;hasPeer in interface Kvrpcpb.ContextOrBuilderpublic Metapb.Peer getPeer()
.metapb.Peer peer = 3;getPeer in interface Kvrpcpb.ContextOrBuilderpublic Metapb.PeerOrBuilder getPeerOrBuilder()
.metapb.Peer peer = 3;getPeerOrBuilder in interface Kvrpcpb.ContextOrBuilderpublic long getTerm()
uint64 term = 5;getTerm in interface Kvrpcpb.ContextOrBuilderpublic int getPriorityValue()
.kvrpcpb.CommandPri priority = 6;getPriorityValue in interface Kvrpcpb.ContextOrBuilderpublic Kvrpcpb.CommandPri getPriority()
.kvrpcpb.CommandPri priority = 6;getPriority in interface Kvrpcpb.ContextOrBuilderpublic int getIsolationLevelValue()
.kvrpcpb.IsolationLevel isolation_level = 7;getIsolationLevelValue in interface Kvrpcpb.ContextOrBuilderpublic Kvrpcpb.IsolationLevel getIsolationLevel()
.kvrpcpb.IsolationLevel isolation_level = 7;getIsolationLevel in interface Kvrpcpb.ContextOrBuilderpublic boolean getNotFillCache()
bool not_fill_cache = 8;getNotFillCache in interface Kvrpcpb.ContextOrBuilderpublic boolean getSyncLog()
bool sync_log = 9;getSyncLog in interface Kvrpcpb.ContextOrBuilderpublic boolean getRecordTimeStat()
True means execution time statistics should be recorded and returned.
bool record_time_stat = 10;getRecordTimeStat in interface Kvrpcpb.ContextOrBuilderpublic boolean getRecordScanStat()
True means RocksDB scan statistics should be recorded and returned.
bool record_scan_stat = 11;getRecordScanStat in interface Kvrpcpb.ContextOrBuilderpublic boolean getReplicaRead()
bool replica_read = 12;getReplicaRead in interface Kvrpcpb.ContextOrBuilderpublic List<Long> getResolvedLocksList()
Read requests can ignore locks belonging to these transactions because either these transactions are rolled back or theirs commit_ts > read request's start_ts.
repeated uint64 resolved_locks = 13;getResolvedLocksList in interface Kvrpcpb.ContextOrBuilderpublic int getResolvedLocksCount()
Read requests can ignore locks belonging to these transactions because either these transactions are rolled back or theirs commit_ts > read request's start_ts.
repeated uint64 resolved_locks = 13;getResolvedLocksCount in interface Kvrpcpb.ContextOrBuilderpublic long getResolvedLocks(int index)
Read requests can ignore locks belonging to these transactions because either these transactions are rolled back or theirs commit_ts > read request's start_ts.
repeated uint64 resolved_locks = 13;getResolvedLocks in interface Kvrpcpb.ContextOrBuilderindex - The index of the element to return.public long getMaxExecutionDurationMs()
uint64 max_execution_duration_ms = 14;getMaxExecutionDurationMs in interface Kvrpcpb.ContextOrBuilderpublic long getAppliedIndex()
After a region applies to `applied_index`, we can get a snapshot for the region even if the peer is a follower.
uint64 applied_index = 15;getAppliedIndex in interface Kvrpcpb.ContextOrBuilderpublic long getTaskId()
A hint for TiKV to schedule tasks more fairly. Query with same task ID may share same priority and resource quota.
uint64 task_id = 16;getTaskId in interface Kvrpcpb.ContextOrBuilderpublic boolean getStaleRead()
Not required to read the most up-to-date data, replicas with `safe_ts` >= `start_ts` can handle read request directly
bool stale_read = 17;getStaleRead in interface Kvrpcpb.ContextOrBuilderpublic com.google.protobuf.ByteString getResourceGroupTag()
Any additional serialized information about the request.
bytes resource_group_tag = 18;getResourceGroupTag in interface Kvrpcpb.ContextOrBuilderpublic int getDiskFullOptValue()
Used to tell TiKV whether operations are allowed or not on different disk usages.
.kvrpcpb.DiskFullOpt disk_full_opt = 19;getDiskFullOptValue in interface Kvrpcpb.ContextOrBuilderpublic Kvrpcpb.DiskFullOpt getDiskFullOpt()
Used to tell TiKV whether operations are allowed or not on different disk usages.
.kvrpcpb.DiskFullOpt disk_full_opt = 19;getDiskFullOpt in interface Kvrpcpb.ContextOrBuilderpublic boolean getIsRetryRequest()
Indicates the request is a retry request and the same request may have been sent before.
bool is_retry_request = 20;getIsRetryRequest in interface Kvrpcpb.ContextOrBuilderpublic int getApiVersionValue()
API version implies the encode of the key and value.
.kvrpcpb.APIVersion api_version = 21;getApiVersionValue in interface Kvrpcpb.ContextOrBuilderpublic Kvrpcpb.APIVersion getApiVersion()
API version implies the encode of the key and value.
.kvrpcpb.APIVersion api_version = 21;getApiVersion in interface Kvrpcpb.ContextOrBuilderpublic List<Long> getCommittedLocksList()
Read request should read through locks belonging to these transactions because these transactions are committed and theirs commit_ts <= read request's start_ts.
repeated uint64 committed_locks = 22;getCommittedLocksList in interface Kvrpcpb.ContextOrBuilderpublic int getCommittedLocksCount()
Read request should read through locks belonging to these transactions because these transactions are committed and theirs commit_ts <= read request's start_ts.
repeated uint64 committed_locks = 22;getCommittedLocksCount in interface Kvrpcpb.ContextOrBuilderpublic long getCommittedLocks(int index)
Read request should read through locks belonging to these transactions because these transactions are committed and theirs commit_ts <= read request's start_ts.
repeated uint64 committed_locks = 22;getCommittedLocks in interface Kvrpcpb.ContextOrBuilderindex - The index of the element to return.public boolean hasTraceContext()
The informantion to trace a request sent to TiKV.
.tracepb.TraceContext trace_context = 23;hasTraceContext in interface Kvrpcpb.ContextOrBuilderpublic Tracepb.TraceContext getTraceContext()
The informantion to trace a request sent to TiKV.
.tracepb.TraceContext trace_context = 23;getTraceContext in interface Kvrpcpb.ContextOrBuilderpublic Tracepb.TraceContextOrBuilder getTraceContextOrBuilder()
The informantion to trace a request sent to TiKV.
.tracepb.TraceContext trace_context = 23;getTraceContextOrBuilder in interface Kvrpcpb.ContextOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Kvrpcpb.Context parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Kvrpcpb.Context parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Kvrpcpb.Context parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Kvrpcpb.Context parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Kvrpcpb.Context parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Kvrpcpb.Context parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Kvrpcpb.Context parseFrom(InputStream input) throws IOException
IOExceptionpublic static Kvrpcpb.Context parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Kvrpcpb.Context parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Kvrpcpb.Context parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Kvrpcpb.Context parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Kvrpcpb.Context parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Kvrpcpb.Context.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Kvrpcpb.Context.Builder newBuilder()
public static Kvrpcpb.Context.Builder newBuilder(Kvrpcpb.Context prototype)
public Kvrpcpb.Context.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Kvrpcpb.Context.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Kvrpcpb.Context getDefaultInstance()
public static com.google.protobuf.Parser<Kvrpcpb.Context> parser()
public com.google.protobuf.Parser<Kvrpcpb.Context> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Kvrpcpb.Context getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2025 PingCAP. All rights reserved.