org.tikv.kvproto

Class Kvrpcpb.CheckTxnStatusRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

org.tikv.kvproto.Kvrpcpb.CheckTxnStatusRequest.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable, Kvrpcpb.CheckTxnStatusRequestOrBuilder

Enclosing class:

Kvrpcpb.CheckTxnStatusRequest

public static final class Kvrpcpb.CheckTxnStatusRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>
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

Method Summary

Modifier and Type	Method and Description
Kvrpcpb.CheckTxnStatusRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Kvrpcpb.CheckTxnStatusRequest	build()
Kvrpcpb.CheckTxnStatusRequest	buildPartial()
Kvrpcpb.CheckTxnStatusRequest.Builder	clear()
Kvrpcpb.CheckTxnStatusRequest.Builder	clearCallerStartTs() The start timestamp of the transaction which this request is part of.
Kvrpcpb.CheckTxnStatusRequest.Builder	clearContext() .kvrpcpb.Context context = 1;
Kvrpcpb.CheckTxnStatusRequest.Builder	clearCurrentTs() The client must specify the current time to TiKV using this timestamp.
Kvrpcpb.CheckTxnStatusRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Kvrpcpb.CheckTxnStatusRequest.Builder	clearForceSyncCommit() This field is set to true only if the transaction is known to fall back from async commit.
Kvrpcpb.CheckTxnStatusRequest.Builder	clearLockTs() Starting timestamp of the transaction being checked.
Kvrpcpb.CheckTxnStatusRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Kvrpcpb.CheckTxnStatusRequest.Builder	clearPrimaryKey() Primary key and lock ts together to locate the primary lock of a transaction.
Kvrpcpb.CheckTxnStatusRequest.Builder	clearResolvingPessimisticLock() 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.
Kvrpcpb.CheckTxnStatusRequest.Builder	clearRollbackIfNotExist() If true, then TiKV will leave a rollback tombstone in the write CF for `primary_key`, even if that key is not locked.
Kvrpcpb.CheckTxnStatusRequest.Builder	clone()
long	getCallerStartTs() The start timestamp of the transaction which this request is part of.
Kvrpcpb.Context	getContext() .kvrpcpb.Context context = 1;
Kvrpcpb.Context.Builder	getContextBuilder() .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.
Kvrpcpb.CheckTxnStatusRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.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.
boolean	hasContext() .kvrpcpb.Context context = 1;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Kvrpcpb.CheckTxnStatusRequest.Builder	mergeContext(Kvrpcpb.Context value) .kvrpcpb.Context context = 1;
Kvrpcpb.CheckTxnStatusRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Kvrpcpb.CheckTxnStatusRequest.Builder	mergeFrom(Kvrpcpb.CheckTxnStatusRequest other)
Kvrpcpb.CheckTxnStatusRequest.Builder	mergeFrom(com.google.protobuf.Message other)
Kvrpcpb.CheckTxnStatusRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Kvrpcpb.CheckTxnStatusRequest.Builder	setCallerStartTs(long value) The start timestamp of the transaction which this request is part of.
Kvrpcpb.CheckTxnStatusRequest.Builder	setContext(Kvrpcpb.Context.Builder builderForValue) .kvrpcpb.Context context = 1;
Kvrpcpb.CheckTxnStatusRequest.Builder	setContext(Kvrpcpb.Context value) .kvrpcpb.Context context = 1;
Kvrpcpb.CheckTxnStatusRequest.Builder	setCurrentTs(long value) The client must specify the current time to TiKV using this timestamp.
Kvrpcpb.CheckTxnStatusRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Kvrpcpb.CheckTxnStatusRequest.Builder	setForceSyncCommit(boolean value) This field is set to true only if the transaction is known to fall back from async commit.
Kvrpcpb.CheckTxnStatusRequest.Builder	setLockTs(long value) Starting timestamp of the transaction being checked.
Kvrpcpb.CheckTxnStatusRequest.Builder	setPrimaryKey(com.google.protobuf.ByteString value) Primary key and lock ts together to locate the primary lock of a transaction.
Kvrpcpb.CheckTxnStatusRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Kvrpcpb.CheckTxnStatusRequest.Builder	setResolvingPessimisticLock(boolean value) 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.
Kvrpcpb.CheckTxnStatusRequest.Builder	setRollbackIfNotExist(boolean value) If true, then TiKV will leave a rollback tombstone in the write CF for `primary_key`, even if that key is not locked.
Kvrpcpb.CheckTxnStatusRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

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.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

clear

public Kvrpcpb.CheckTxnStatusRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

getDefaultInstanceForType

public Kvrpcpb.CheckTxnStatusRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Kvrpcpb.CheckTxnStatusRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Kvrpcpb.CheckTxnStatusRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Kvrpcpb.CheckTxnStatusRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

setField

public Kvrpcpb.CheckTxnStatusRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                      Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

clearField

public Kvrpcpb.CheckTxnStatusRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

clearOneof

public Kvrpcpb.CheckTxnStatusRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

setRepeatedField

public Kvrpcpb.CheckTxnStatusRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              int index,
                                                              Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

addRepeatedField

public Kvrpcpb.CheckTxnStatusRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                              Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

mergeFrom

public Kvrpcpb.CheckTxnStatusRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

mergeFrom

public Kvrpcpb.CheckTxnStatusRequest.Builder mergeFrom(Kvrpcpb.CheckTxnStatusRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

Throws:

IOException

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.

setContext

public Kvrpcpb.CheckTxnStatusRequest.Builder setContext(Kvrpcpb.Context value)

.kvrpcpb.Context context = 1;

setContext

public Kvrpcpb.CheckTxnStatusRequest.Builder setContext(Kvrpcpb.Context.Builder builderForValue)

.kvrpcpb.Context context = 1;

mergeContext

public Kvrpcpb.CheckTxnStatusRequest.Builder mergeContext(Kvrpcpb.Context value)

.kvrpcpb.Context context = 1;

clearContext

public Kvrpcpb.CheckTxnStatusRequest.Builder clearContext()

.kvrpcpb.Context context = 1;

getContextBuilder

public Kvrpcpb.Context.Builder getContextBuilder()

.kvrpcpb.Context context = 1;

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.

setPrimaryKey

public Kvrpcpb.CheckTxnStatusRequest.Builder setPrimaryKey(com.google.protobuf.ByteString value)

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

bytes primary_key = 2;

Parameters:

value - The primaryKey to set.

Returns:

This builder for chaining.

clearPrimaryKey

public Kvrpcpb.CheckTxnStatusRequest.Builder clearPrimaryKey()

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

bytes primary_key = 2;

Returns:

This builder for chaining.

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.

setLockTs

public Kvrpcpb.CheckTxnStatusRequest.Builder setLockTs(long value)

 Starting timestamp of the transaction being checked.
 

uint64 lock_ts = 3;

Parameters:

value - The lockTs to set.

Returns:

This builder for chaining.

clearLockTs

public Kvrpcpb.CheckTxnStatusRequest.Builder clearLockTs()

 Starting timestamp of the transaction being checked.
 

uint64 lock_ts = 3;

Returns:

This builder for chaining.

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.

setCallerStartTs

public Kvrpcpb.CheckTxnStatusRequest.Builder setCallerStartTs(long value)

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

uint64 caller_start_ts = 4;

Parameters:

value - The callerStartTs to set.

Returns:

This builder for chaining.

clearCallerStartTs

public Kvrpcpb.CheckTxnStatusRequest.Builder clearCallerStartTs()

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

uint64 caller_start_ts = 4;

Returns:

This builder for chaining.

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.

setCurrentTs

public Kvrpcpb.CheckTxnStatusRequest.Builder setCurrentTs(long value)

 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;

Parameters:

value - The currentTs to set.

Returns:

This builder for chaining.

clearCurrentTs

public Kvrpcpb.CheckTxnStatusRequest.Builder clearCurrentTs()

 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;

Returns:

This builder for chaining.

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.

setRollbackIfNotExist

public Kvrpcpb.CheckTxnStatusRequest.Builder setRollbackIfNotExist(boolean value)

 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;

Parameters:

value - The rollbackIfNotExist to set.

Returns:

This builder for chaining.

clearRollbackIfNotExist

public Kvrpcpb.CheckTxnStatusRequest.Builder clearRollbackIfNotExist()

 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;

Returns:

This builder for chaining.

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.

setForceSyncCommit

public Kvrpcpb.CheckTxnStatusRequest.Builder setForceSyncCommit(boolean value)

 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;

Parameters:

value - The forceSyncCommit to set.

Returns:

This builder for chaining.

clearForceSyncCommit

public Kvrpcpb.CheckTxnStatusRequest.Builder clearForceSyncCommit()

 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;

Returns:

This builder for chaining.

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.

setResolvingPessimisticLock

public Kvrpcpb.CheckTxnStatusRequest.Builder setResolvingPessimisticLock(boolean value)

 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;

Parameters:

value - The resolvingPessimisticLock to set.

Returns:

This builder for chaining.

clearResolvingPessimisticLock

public Kvrpcpb.CheckTxnStatusRequest.Builder clearResolvingPessimisticLock()

 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;

Returns:

This builder for chaining.

setUnknownFields

public final Kvrpcpb.CheckTxnStatusRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>

mergeUnknownFields

public final Kvrpcpb.CheckTxnStatusRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Kvrpcpb.CheckTxnStatusRequest.Builder>