org.tikv.kvproto

Interface Brpb.BackupRequestOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Brpb.BackupRequest, Brpb.BackupRequest.Builder

Enclosing class:

Brpb

public static interface Brpb.BackupRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
long	getRateLimit() The I/O rate limit for backup request.
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;
boolean	hasCipherInfo() The cipher_info is Used to encrypt sst
boolean	hasStorageBackend() .backup.StorageBackend storage_backend = 9;

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

getClusterId

long getClusterId()

uint64 cluster_id = 1;

Returns:

The clusterId.

getStartKey

com.google.protobuf.ByteString getStartKey()

bytes start_key = 2;

Returns:

The startKey.

getEndKey

com.google.protobuf.ByteString getEndKey()

bytes end_key = 3;

Returns:

The endKey.

getStartVersion

long getStartVersion()

uint64 start_version = 4;

Returns:

The startVersion.

getEndVersion

long getEndVersion()

uint64 end_version = 5;

Returns:

The endVersion.

getRateLimit

long getRateLimit()

 The I/O rate limit for backup request.
 

uint64 rate_limit = 7;

Returns:

The rateLimit.

getConcurrency

int getConcurrency()

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

uint32 concurrency = 8;

Returns:

The concurrency.

hasStorageBackend

boolean hasStorageBackend()

.backup.StorageBackend storage_backend = 9;

Returns:

Whether the storageBackend field is set.

getStorageBackend

Brpb.StorageBackend getStorageBackend()

.backup.StorageBackend storage_backend = 9;

Returns:

The storageBackend.

getStorageBackendOrBuilder

Brpb.StorageBackendOrBuilder getStorageBackendOrBuilder()

.backup.StorageBackend storage_backend = 9;

getIsRawKv

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;

Returns:

The isRawKv.

getCf

String getCf()

string cf = 11;

Returns:

The cf.

getCfBytes

com.google.protobuf.ByteString getCfBytes()

string cf = 11;

Returns:

The bytes for cf.

getCompressionTypeValue

int getCompressionTypeValue()

 algorithm used for compress sst files
 

.backup.CompressionType compression_type = 12;

Returns:

The enum numeric value on the wire for compressionType.

getCompressionType

Brpb.CompressionType getCompressionType()

 algorithm used for compress sst files
 

.backup.CompressionType compression_type = 12;

Returns:

The compressionType.

getCompressionLevel

int getCompressionLevel()

 sst compression level, some algorithms support negative compression levels
 

int32 compression_level = 13;

Returns:

The compressionLevel.

hasCipherInfo

boolean hasCipherInfo()

 The cipher_info is Used to encrypt sst
 

.backup.CipherInfo cipher_info = 14;

Returns:

Whether the cipherInfo field is set.

getCipherInfo

Brpb.CipherInfo getCipherInfo()

 The cipher_info is Used to encrypt sst
 

.backup.CipherInfo cipher_info = 14;

Returns:

The cipherInfo.

getCipherInfoOrBuilder

Brpb.CipherInfoOrBuilder getCipherInfoOrBuilder()

 The cipher_info is Used to encrypt sst
 

.backup.CipherInfo cipher_info = 14;

getDstApiVersionValue

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;

Returns:

The enum numeric value on the wire for dstApiVersion.

getDstApiVersion

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;

Returns:

The dstApiVersion.