org.tikv.kvproto

Class Kvrpcpb.CheckTxnStatusRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tikv.kvproto.Kvrpcpb.CheckTxnStatusRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Kvrpcpb.CheckTxnStatusRequestOrBuilder

Enclosing class:

Kvrpcpb

public static final class Kvrpcpb.CheckTxnStatusRequest
extends com.google.protobuf.GeneratedMessageV3
implements Kvrpcpb.CheckTxnStatusRequestOrBuilder

 CheckTxnStatusRequest checks the status of a transaction.
 If the transaction is rollbacked/committed, return that result.
 If the TTL of the transaction is exhausted, abort that transaction and inform the caller.
 Otherwise, returns the TTL information for the transaction.
 CheckTxnStatusRequest may also push forward the minCommitTS of a large transaction.
 

Protobuf type kvrpcpb.CheckTxnStatusRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Kvrpcpb.CheckTxnStatusRequest.Builder CheckTxnStatusRequest checks the status of a transaction.

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

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

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALLER_START_TS_FIELD_NUMBER
static int	CONTEXT_FIELD_NUMBER
static int	CURRENT_TS_FIELD_NUMBER
static int	FORCE_SYNC_COMMIT_FIELD_NUMBER
static int	LOCK_TS_FIELD_NUMBER
static int	PRIMARY_KEY_FIELD_NUMBER
static int	RESOLVING_PESSIMISTIC_LOCK_FIELD_NUMBER
static int	ROLLBACK_IF_NOT_EXIST_FIELD_NUMBER

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 and Description
boolean	equals(Object obj)
long	getCallerStartTs() The start timestamp of the transaction which this request is part of.
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.ContextOrBuilder	getContextOrBuilder() .kvrpcpb.Context context = 1;
long	getCurrentTs() The client must specify the current time to TiKV using this timestamp.
static Kvrpcpb.CheckTxnStatusRequest	getDefaultInstance()
Kvrpcpb.CheckTxnStatusRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getForceSyncCommit() This field is set to true only if the transaction is known to fall back from async commit.
long	getLockTs() Starting timestamp of the transaction being checked.
com.google.protobuf.Parser<Kvrpcpb.CheckTxnStatusRequest>	getParserForType()
com.google.protobuf.ByteString	getPrimaryKey() Primary key and lock ts together to locate the primary lock of a transaction.
boolean	getResolvingPessimisticLock() If the check request is used to resolve or decide the transaction status for a input pessimistic lock, the transaction status could not be decided if the primary lock is pessimistic too and it's still uncertain.
boolean	getRollbackIfNotExist() If true, then TiKV will leave a rollback tombstone in the write CF for `primary_key`, even if that key is not locked.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasContext() .kvrpcpb.Context context = 1;
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Kvrpcpb.CheckTxnStatusRequest.Builder	newBuilder()
static Kvrpcpb.CheckTxnStatusRequest.Builder	newBuilder(Kvrpcpb.CheckTxnStatusRequest prototype)
Kvrpcpb.CheckTxnStatusRequest.Builder	newBuilderForType()
protected Kvrpcpb.CheckTxnStatusRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Kvrpcpb.CheckTxnStatusRequest	parseDelimitedFrom(InputStream input)
static Kvrpcpb.CheckTxnStatusRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(byte[] data)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(ByteBuffer data)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(com.google.protobuf.ByteString data)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(InputStream input)
static Kvrpcpb.CheckTxnStatusRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Kvrpcpb.CheckTxnStatusRequest>	parser()
Kvrpcpb.CheckTxnStatusRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

See Also:

Constant Field Values

PRIMARY_KEY_FIELD_NUMBER

public static final int PRIMARY_KEY_FIELD_NUMBER

See Also:

Constant Field Values

LOCK_TS_FIELD_NUMBER

public static final int LOCK_TS_FIELD_NUMBER

See Also:

Constant Field Values

CALLER_START_TS_FIELD_NUMBER

public static final int CALLER_START_TS_FIELD_NUMBER

See Also:

Constant Field Values

CURRENT_TS_FIELD_NUMBER

public static final int CURRENT_TS_FIELD_NUMBER

See Also:

Constant Field Values

ROLLBACK_IF_NOT_EXIST_FIELD_NUMBER

public static final int ROLLBACK_IF_NOT_EXIST_FIELD_NUMBER

See Also:

Constant Field Values

FORCE_SYNC_COMMIT_FIELD_NUMBER

public static final int FORCE_SYNC_COMMIT_FIELD_NUMBER

See Also:

Constant Field Values

RESOLVING_PESSIMISTIC_LOCK_FIELD_NUMBER

public static final int RESOLVING_PESSIMISTIC_LOCK_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields 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

hasContext

public boolean hasContext()

.kvrpcpb.Context context = 1;

Specified by:

hasContext in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

Whether the context field is set.

getContext

public Kvrpcpb.Context getContext()

.kvrpcpb.Context context = 1;

Specified by:

getContext in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The context.

getContextOrBuilder

public Kvrpcpb.ContextOrBuilder getContextOrBuilder()

.kvrpcpb.Context context = 1;

Specified by:

getContextOrBuilder in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

getPrimaryKey

public com.google.protobuf.ByteString getPrimaryKey()

 Primary key and lock ts together to locate the primary lock of a transaction.
 

bytes primary_key = 2;

Specified by:

getPrimaryKey in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The primaryKey.

getLockTs

public long getLockTs()

 Starting timestamp of the transaction being checked.
 

uint64 lock_ts = 3;

Specified by:

getLockTs in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The lockTs.

getCallerStartTs

public long getCallerStartTs()

 The start timestamp of the transaction which this request is part of.
 

uint64 caller_start_ts = 4;

Specified by:

getCallerStartTs in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The callerStartTs.

getCurrentTs

public long getCurrentTs()

 The client must specify the current time to TiKV using this timestamp. It is used to check TTL
 timeouts. It may be inaccurate.
 

uint64 current_ts = 5;

Specified by:

getCurrentTs in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The currentTs.

getRollbackIfNotExist

public boolean getRollbackIfNotExist()

 If true, then TiKV will leave a rollback tombstone in the write CF for `primary_key`, even if
 that key is not locked.
 

bool rollback_if_not_exist = 6;

Specified by:

getRollbackIfNotExist in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The rollbackIfNotExist.

getForceSyncCommit

public boolean getForceSyncCommit()

 This field is set to true only if the transaction is known to fall back from async commit.
 Then, CheckTxnStatus treats the transaction as non-async-commit even if the use_async_commit
 field in the primary lock is true.
 

bool force_sync_commit = 7;

Specified by:

getForceSyncCommit in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The forceSyncCommit.

getResolvingPessimisticLock

public boolean getResolvingPessimisticLock()

 If the check request is used to resolve or decide the transaction status for a input pessimistic
 lock, the transaction status could not be decided if the primary lock is pessimistic too and
 it's still uncertain.
 

bool resolving_pessimistic_lock = 8;

Specified by:

getResolvingPessimisticLock in interface Kvrpcpb.CheckTxnStatusRequestOrBuilder

Returns:

The resolvingPessimisticLock.

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 Kvrpcpb.CheckTxnStatusRequest parseFrom(ByteBuffer data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(ByteBuffer data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(com.google.protobuf.ByteString data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(com.google.protobuf.ByteString data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(byte[] data)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(byte[] data,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(InputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(InputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Kvrpcpb.CheckTxnStatusRequest parseDelimitedFrom(InputStream input)
                                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Kvrpcpb.CheckTxnStatusRequest parseDelimitedFrom(InputStream input,
                                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                        throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                               throws IOException

Throws:

IOException

parseFrom

public static Kvrpcpb.CheckTxnStatusRequest parseFrom(com.google.protobuf.CodedInputStream input,
                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                               throws IOException

Throws:

IOException

newBuilderForType

public Kvrpcpb.CheckTxnStatusRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Kvrpcpb.CheckTxnStatusRequest.Builder newBuilder()

newBuilder

public static Kvrpcpb.CheckTxnStatusRequest.Builder newBuilder(Kvrpcpb.CheckTxnStatusRequest prototype)

toBuilder

public Kvrpcpb.CheckTxnStatusRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Kvrpcpb.CheckTxnStatusRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Kvrpcpb.CheckTxnStatusRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Kvrpcpb.CheckTxnStatusRequest> parser()

getParserForType

public com.google.protobuf.Parser<Kvrpcpb.CheckTxnStatusRequest> 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 Kvrpcpb.CheckTxnStatusRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder