org.tikv.kvproto

Class Brpb.BackupRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

org.tikv.kvproto.Brpb.BackupRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, Brpb.BackupRequestOrBuilder

Enclosing class:

Brpb

public static final class Brpb.BackupRequest
extends com.google.protobuf.GeneratedMessageV3
implements Brpb.BackupRequestOrBuilder

Protobuf type backup.BackupRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Brpb.BackupRequest.Builder Protobuf type backup.BackupRequest

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	CF_FIELD_NUMBER
static int	CIPHER_INFO_FIELD_NUMBER
static int	CLUSTER_ID_FIELD_NUMBER
static int	COMPRESSION_LEVEL_FIELD_NUMBER
static int	COMPRESSION_TYPE_FIELD_NUMBER
static int	CONCURRENCY_FIELD_NUMBER
static int	DST_API_VERSION_FIELD_NUMBER
static int	END_KEY_FIELD_NUMBER
static int	END_VERSION_FIELD_NUMBER
static int	IS_RAW_KV_FIELD_NUMBER
static int	RATE_LIMIT_FIELD_NUMBER
static int	START_KEY_FIELD_NUMBER
static int	START_VERSION_FIELD_NUMBER
static int	STORAGE_BACKEND_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)
String	getCf() string cf = 11;
com.google.protobuf.ByteString	getCfBytes() string cf = 11;
Brpb.CipherInfo	getCipherInfo() The cipher_info is Used to encrypt sst
Brpb.CipherInfoOrBuilder	getCipherInfoOrBuilder() The cipher_info is Used to encrypt sst
long	getClusterId() uint64 cluster_id = 1;
int	getCompressionLevel() sst compression level, some algorithms support negative compression levels
Brpb.CompressionType	getCompressionType() algorithm used for compress sst files
int	getCompressionTypeValue() algorithm used for compress sst files
int	getConcurrency() The concurrency for executing the backup request in every tikv node.
static Brpb.BackupRequest	getDefaultInstance()
Brpb.BackupRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Kvrpcpb.APIVersion	getDstApiVersion() dst_api_version indicates the key-value encoding version used by the generated SST file.
int	getDstApiVersionValue() dst_api_version indicates the key-value encoding version used by the generated SST file.
com.google.protobuf.ByteString	getEndKey() bytes end_key = 3;
long	getEndVersion() uint64 end_version = 5;
boolean	getIsRawKv() If raw kv mode is enabled, `start_version` and `end_version` will be ignored, and `cf` specifies which cf to backup.
com.google.protobuf.Parser<Brpb.BackupRequest>	getParserForType()
long	getRateLimit() The I/O rate limit for backup request.
int	getSerializedSize()
com.google.protobuf.ByteString	getStartKey() bytes start_key = 2;
long	getStartVersion() uint64 start_version = 4;
Brpb.StorageBackend	getStorageBackend() .backup.StorageBackend storage_backend = 9;
Brpb.StorageBackendOrBuilder	getStorageBackendOrBuilder() .backup.StorageBackend storage_backend = 9;
com.google.protobuf.UnknownFieldSet	getUnknownFields()
boolean	hasCipherInfo() The cipher_info is Used to encrypt sst
int	hashCode()
boolean	hasStorageBackend() .backup.StorageBackend storage_backend = 9;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Brpb.BackupRequest.Builder	newBuilder()
static Brpb.BackupRequest.Builder	newBuilder(Brpb.BackupRequest prototype)
Brpb.BackupRequest.Builder	newBuilderForType()
protected Brpb.BackupRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Brpb.BackupRequest	parseDelimitedFrom(InputStream input)
static Brpb.BackupRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Brpb.BackupRequest	parseFrom(byte[] data)
static Brpb.BackupRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Brpb.BackupRequest	parseFrom(ByteBuffer data)
static Brpb.BackupRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Brpb.BackupRequest	parseFrom(com.google.protobuf.ByteString data)
static Brpb.BackupRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Brpb.BackupRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Brpb.BackupRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Brpb.BackupRequest	parseFrom(InputStream input)
static Brpb.BackupRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Brpb.BackupRequest>	parser()
Brpb.BackupRequest.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

CLUSTER_ID_FIELD_NUMBER

public static final int CLUSTER_ID_FIELD_NUMBER

See Also:

Constant Field Values

START_KEY_FIELD_NUMBER

public static final int START_KEY_FIELD_NUMBER

See Also:

Constant Field Values

END_KEY_FIELD_NUMBER

public static final int END_KEY_FIELD_NUMBER

See Also:

Constant Field Values

START_VERSION_FIELD_NUMBER

public static final int START_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

END_VERSION_FIELD_NUMBER

public static final int END_VERSION_FIELD_NUMBER

See Also:

Constant Field Values

RATE_LIMIT_FIELD_NUMBER

public static final int RATE_LIMIT_FIELD_NUMBER

See Also:

Constant Field Values

CONCURRENCY_FIELD_NUMBER

public static final int CONCURRENCY_FIELD_NUMBER

See Also:

Constant Field Values

STORAGE_BACKEND_FIELD_NUMBER

public static final int STORAGE_BACKEND_FIELD_NUMBER

See Also:

Constant Field Values

IS_RAW_KV_FIELD_NUMBER

public static final int IS_RAW_KV_FIELD_NUMBER

See Also:

Constant Field Values

CF_FIELD_NUMBER

public static final int CF_FIELD_NUMBER

See Also:

Constant Field Values

COMPRESSION_TYPE_FIELD_NUMBER

public static final int COMPRESSION_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

COMPRESSION_LEVEL_FIELD_NUMBER

public static final int COMPRESSION_LEVEL_FIELD_NUMBER

See Also:

Constant Field Values

CIPHER_INFO_FIELD_NUMBER

public static final int CIPHER_INFO_FIELD_NUMBER

See Also:

Constant Field Values

DST_API_VERSION_FIELD_NUMBER

public static final int DST_API_VERSION_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

getClusterId

public long getClusterId()

uint64 cluster_id = 1;

Specified by:

getClusterId in interface Brpb.BackupRequestOrBuilder

Returns:

The clusterId.

getStartKey

public com.google.protobuf.ByteString getStartKey()

bytes start_key = 2;

Specified by:

getStartKey in interface Brpb.BackupRequestOrBuilder

Returns:

The startKey.

getEndKey

public com.google.protobuf.ByteString getEndKey()

bytes end_key = 3;

Specified by:

getEndKey in interface Brpb.BackupRequestOrBuilder

Returns:

The endKey.

getStartVersion

public long getStartVersion()

uint64 start_version = 4;

Specified by:

getStartVersion in interface Brpb.BackupRequestOrBuilder

Returns:

The startVersion.

getEndVersion

public long getEndVersion()

uint64 end_version = 5;

Specified by:

getEndVersion in interface Brpb.BackupRequestOrBuilder

Returns:

The endVersion.

getRateLimit

public long getRateLimit()

 The I/O rate limit for backup request.
 

uint64 rate_limit = 7;

Specified by:

getRateLimit in interface Brpb.BackupRequestOrBuilder

Returns:

The rateLimit.

getConcurrency

public int getConcurrency()

 The concurrency for executing the backup request in every tikv node.
 

uint32 concurrency = 8;

Specified by:

getConcurrency in interface Brpb.BackupRequestOrBuilder

Returns:

The concurrency.

hasStorageBackend

public boolean hasStorageBackend()

.backup.StorageBackend storage_backend = 9;

Specified by:

hasStorageBackend in interface Brpb.BackupRequestOrBuilder

Returns:

Whether the storageBackend field is set.

getStorageBackend

public Brpb.StorageBackend getStorageBackend()

.backup.StorageBackend storage_backend = 9;

Specified by:

getStorageBackend in interface Brpb.BackupRequestOrBuilder

Returns:

The storageBackend.

getStorageBackendOrBuilder

public Brpb.StorageBackendOrBuilder getStorageBackendOrBuilder()

.backup.StorageBackend storage_backend = 9;

Specified by:

getStorageBackendOrBuilder in interface Brpb.BackupRequestOrBuilder

getIsRawKv

public boolean getIsRawKv()

 If raw kv mode is enabled, `start_version` and `end_version` will be ignored, and `cf`
 specifies which cf to backup.
 

bool is_raw_kv = 10;

Specified by:

getIsRawKv in interface Brpb.BackupRequestOrBuilder

Returns:

The isRawKv.

getCf

public String getCf()

string cf = 11;

Specified by:

getCf in interface Brpb.BackupRequestOrBuilder

Returns:

The cf.

getCfBytes

public com.google.protobuf.ByteString getCfBytes()

string cf = 11;

Specified by:

getCfBytes in interface Brpb.BackupRequestOrBuilder

Returns:

The bytes for cf.

getCompressionTypeValue

public int getCompressionTypeValue()

 algorithm used for compress sst files
 

.backup.CompressionType compression_type = 12;

Specified by:

getCompressionTypeValue in interface Brpb.BackupRequestOrBuilder

Returns:

The enum numeric value on the wire for compressionType.

getCompressionType

public Brpb.CompressionType getCompressionType()

 algorithm used for compress sst files
 

.backup.CompressionType compression_type = 12;

Specified by:

getCompressionType in interface Brpb.BackupRequestOrBuilder

Returns:

The compressionType.

getCompressionLevel

public int getCompressionLevel()

 sst compression level, some algorithms support negative compression levels
 

int32 compression_level = 13;

Specified by:

getCompressionLevel in interface Brpb.BackupRequestOrBuilder

Returns:

The compressionLevel.

hasCipherInfo

public boolean hasCipherInfo()

 The cipher_info is Used to encrypt sst
 

.backup.CipherInfo cipher_info = 14;

Specified by:

hasCipherInfo in interface Brpb.BackupRequestOrBuilder

Returns:

Whether the cipherInfo field is set.

getCipherInfo

public Brpb.CipherInfo getCipherInfo()

 The cipher_info is Used to encrypt sst
 

.backup.CipherInfo cipher_info = 14;

Specified by:

getCipherInfo in interface Brpb.BackupRequestOrBuilder

Returns:

The cipherInfo.

getCipherInfoOrBuilder

public Brpb.CipherInfoOrBuilder getCipherInfoOrBuilder()

 The cipher_info is Used to encrypt sst
 

.backup.CipherInfo cipher_info = 14;

Specified by:

getCipherInfoOrBuilder in interface Brpb.BackupRequestOrBuilder

getDstApiVersionValue

public int getDstApiVersionValue()

 dst_api_version indicates the key-value encoding version used by the
 generated SST file. Accepted values:
 1. "v1": the generated SST files are encoded with api-v1, can be restored
    to TiKV clusters whose api version is set to v1.
 2. "v2": the generated SST files are encoded with api-v2, can be restored
    to TiKV clusters whose api version is set to v2.
 

.kvrpcpb.APIVersion dst_api_version = 15;

Specified by:

getDstApiVersionValue in interface Brpb.BackupRequestOrBuilder

Returns:

The enum numeric value on the wire for dstApiVersion.

getDstApiVersion

public Kvrpcpb.APIVersion getDstApiVersion()

 dst_api_version indicates the key-value encoding version used by the
 generated SST file. Accepted values:
 1. "v1": the generated SST files are encoded with api-v1, can be restored
    to TiKV clusters whose api version is set to v1.
 2. "v2": the generated SST files are encoded with api-v2, can be restored
    to TiKV clusters whose api version is set to v2.
 

.kvrpcpb.APIVersion dst_api_version = 15;

Specified by:

getDstApiVersion in interface Brpb.BackupRequestOrBuilder

Returns:

The dstApiVersion.

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Brpb.BackupRequest parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Brpb.BackupRequest parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Brpb.BackupRequest parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Brpb.BackupRequest parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Brpb.BackupRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Brpb.BackupRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Brpb.BackupRequest.Builder newBuilder()

newBuilder

public static Brpb.BackupRequest.Builder newBuilder(Brpb.BackupRequest prototype)

toBuilder

public Brpb.BackupRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Brpb.BackupRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Brpb.BackupRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Brpb.BackupRequest> parser()

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder