org.tikv.kvproto

Interface Kvrpcpb.ContextOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Kvrpcpb.Context, Kvrpcpb.Context.Builder

Enclosing class:

Kvrpcpb

public static interface Kvrpcpb.ContextOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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;
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.
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.
boolean	hasPeer() .metapb.Peer peer = 3;
boolean	hasRegionEpoch() .metapb.RegionEpoch region_epoch = 2;
boolean	hasTraceContext() The informantion to trace a request sent to TiKV.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRegionId

long getRegionId()

uint64 region_id = 1;

Returns:

The regionId.

hasRegionEpoch

boolean hasRegionEpoch()

.metapb.RegionEpoch region_epoch = 2;

Returns:

Whether the regionEpoch field is set.

getRegionEpoch

Metapb.RegionEpoch getRegionEpoch()

.metapb.RegionEpoch region_epoch = 2;

Returns:

The regionEpoch.

getRegionEpochOrBuilder

Metapb.RegionEpochOrBuilder getRegionEpochOrBuilder()

.metapb.RegionEpoch region_epoch = 2;

hasPeer

boolean hasPeer()

.metapb.Peer peer = 3;

Returns:

Whether the peer field is set.

getPeer

Metapb.Peer getPeer()

.metapb.Peer peer = 3;

Returns:

The peer.

getPeerOrBuilder

Metapb.PeerOrBuilder getPeerOrBuilder()

.metapb.Peer peer = 3;

getTerm

long getTerm()

uint64 term = 5;

Returns:

The term.

getPriorityValue

int getPriorityValue()

.kvrpcpb.CommandPri priority = 6;

Returns:

The enum numeric value on the wire for priority.

getPriority

Kvrpcpb.CommandPri getPriority()

.kvrpcpb.CommandPri priority = 6;

Returns:

The priority.

getIsolationLevelValue

int getIsolationLevelValue()

.kvrpcpb.IsolationLevel isolation_level = 7;

Returns:

The enum numeric value on the wire for isolationLevel.

getIsolationLevel

Kvrpcpb.IsolationLevel getIsolationLevel()

.kvrpcpb.IsolationLevel isolation_level = 7;

Returns:

The isolationLevel.

getNotFillCache

boolean getNotFillCache()

bool not_fill_cache = 8;

Returns:

The notFillCache.

getSyncLog

boolean getSyncLog()

bool sync_log = 9;

Returns:

The syncLog.

getRecordTimeStat

boolean getRecordTimeStat()

 True means execution time statistics should be recorded and returned.
 

bool record_time_stat = 10;

Returns:

The recordTimeStat.

getRecordScanStat

boolean getRecordScanStat()

 True means RocksDB scan statistics should be recorded and returned.
 

bool record_scan_stat = 11;

Returns:

The recordScanStat.

getReplicaRead

boolean getReplicaRead()

bool replica_read = 12;

Returns:

The replicaRead.

getResolvedLocksList

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;

Returns:

A list containing the resolvedLocks.

getResolvedLocksCount

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;

Returns:

The count of resolvedLocks.

getResolvedLocks

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;

Parameters:

index - The index of the element to return.

Returns:

The resolvedLocks at the given index.

getMaxExecutionDurationMs

long getMaxExecutionDurationMs()

uint64 max_execution_duration_ms = 14;

Returns:

The maxExecutionDurationMs.

getAppliedIndex

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;

Returns:

The appliedIndex.

getTaskId

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;

Returns:

The taskId.

getStaleRead

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;

Returns:

The staleRead.

getResourceGroupTag

com.google.protobuf.ByteString getResourceGroupTag()

 Any additional serialized information about the request.
 

bytes resource_group_tag = 18;

Returns:

The resourceGroupTag.

getDiskFullOptValue

int getDiskFullOptValue()

 Used to tell TiKV whether operations are allowed or not on different disk usages.
 

.kvrpcpb.DiskFullOpt disk_full_opt = 19;

Returns:

The enum numeric value on the wire for diskFullOpt.

getDiskFullOpt

Kvrpcpb.DiskFullOpt getDiskFullOpt()

 Used to tell TiKV whether operations are allowed or not on different disk usages.
 

.kvrpcpb.DiskFullOpt disk_full_opt = 19;

Returns:

The diskFullOpt.

getIsRetryRequest

boolean getIsRetryRequest()

 Indicates the request is a retry request and the same request may have been sent before.
 

bool is_retry_request = 20;

Returns:

The isRetryRequest.

getApiVersionValue

int getApiVersionValue()

 API version implies the encode of the key and value.
 

.kvrpcpb.APIVersion api_version = 21;

Returns:

The enum numeric value on the wire for apiVersion.

getApiVersion

Kvrpcpb.APIVersion getApiVersion()

 API version implies the encode of the key and value.
 

.kvrpcpb.APIVersion api_version = 21;

Returns:

The apiVersion.

getCommittedLocksList

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;

Returns:

A list containing the committedLocks.

getCommittedLocksCount

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;

Returns:

The count of committedLocks.

getCommittedLocks

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;

Parameters:

index - The index of the element to return.

Returns:

The committedLocks at the given index.

hasTraceContext

boolean hasTraceContext()

 The informantion to trace a request sent to TiKV.
 

.tracepb.TraceContext trace_context = 23;

Returns:

Whether the traceContext field is set.

getTraceContext

Tracepb.TraceContext getTraceContext()

 The informantion to trace a request sent to TiKV.
 

.tracepb.TraceContext trace_context = 23;

Returns:

The traceContext.

getTraceContextOrBuilder

Tracepb.TraceContextOrBuilder getTraceContextOrBuilder()

 The informantion to trace a request sent to TiKV.
 

.tracepb.TraceContext trace_context = 23;