org.tikv.kvproto

Interface Brpb.BackupMetaOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Brpb.BackupMeta, Brpb.BackupMeta.Builder

Enclosing class:

Brpb

public static interface Brpb.BackupMetaOrBuilder
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.
String	getBackupResult() the backup result into `backupmeta` file
com.google.protobuf.ByteString	getBackupResultBytes() the backup result into `backupmeta` file
String	getBrVersion() Save the version of BR running backup jobs.
com.google.protobuf.ByteString	getBrVersionBytes() Save the version of BR running backup jobs.
long	getClusterId() ID and version of backuped cluster.
String	getClusterVersion() string cluster_version = 2;
com.google.protobuf.ByteString	getClusterVersionBytes() string cluster_version = 2;
Brpb.MetaFile	getDdlIndexes() An index to files contains DDLs.
Brpb.MetaFileOrBuilder	getDdlIndexesOrBuilder() An index to files contains DDLs.
com.google.protobuf.ByteString	getDdls() In incremental backup, DDLs which are completed in (lastBackupTS, backupTS] will be stored here.
long	getEndVersion() uint64 end_version = 6;
Brpb.MetaFile	getFileIndex() An index to files contains data files.
Brpb.MetaFileOrBuilder	getFileIndexOrBuilder() An index to files contains data files.
Brpb.File	getFiles(int index) A set of files that compose a backup.
int	getFilesCount() A set of files that compose a backup.
List<Brpb.File>	getFilesList() A set of files that compose a backup.
Brpb.FileOrBuilder	getFilesOrBuilder(int index) A set of files that compose a backup.
List<? extends Brpb.FileOrBuilder>	getFilesOrBuilderList() A set of files that compose a backup.
boolean	getIsRawKv() If in raw kv mode, `start_versions`, `end_versions` and `schemas` will be ignored, and the backup data's range is represented by raw_ranges.
String	getNewCollationsEnabled() new_collations_enabled specifies the config `new_collations_enabled_on_first_bootstrap` in tidb.
com.google.protobuf.ByteString	getNewCollationsEnabledBytes() new_collations_enabled specifies the config `new_collations_enabled_on_first_bootstrap` in tidb.
Brpb.PlacementPolicy	getPolicies(int index) the placement policy info in backup cluster.
int	getPoliciesCount() the placement policy info in backup cluster.
List<Brpb.PlacementPolicy>	getPoliciesList() the placement policy info in backup cluster.
Brpb.PlacementPolicyOrBuilder	getPoliciesOrBuilder(int index) the placement policy info in backup cluster.
List<? extends Brpb.PlacementPolicyOrBuilder>	getPoliciesOrBuilderList() the placement policy info in backup cluster.
Brpb.MetaFile	getRawRangeIndex() An index to files contains RawRanges.
Brpb.MetaFileOrBuilder	getRawRangeIndexOrBuilder() An index to files contains RawRanges.
Brpb.RawRange	getRawRanges(int index) Note: `raw_ranges` is deprecated, as it bloats backupmeta.
int	getRawRangesCount() Note: `raw_ranges` is deprecated, as it bloats backupmeta.
List<Brpb.RawRange>	getRawRangesList() Note: `raw_ranges` is deprecated, as it bloats backupmeta.
Brpb.RawRangeOrBuilder	getRawRangesOrBuilder(int index) Note: `raw_ranges` is deprecated, as it bloats backupmeta.
List<? extends Brpb.RawRangeOrBuilder>	getRawRangesOrBuilderList() Note: `raw_ranges` is deprecated, as it bloats backupmeta.
Brpb.MetaFile	getSchemaIndex() An index to files contains Schemas.
Brpb.MetaFileOrBuilder	getSchemaIndexOrBuilder() An index to files contains Schemas.
Brpb.Schema	getSchemas(int index) Table metadata describes database and table info.
int	getSchemasCount() Table metadata describes database and table info.
List<Brpb.Schema>	getSchemasList() Table metadata describes database and table info.
Brpb.SchemaOrBuilder	getSchemasOrBuilder(int index) Table metadata describes database and table info.
List<? extends Brpb.SchemaOrBuilder>	getSchemasOrBuilderList() Table metadata describes database and table info.
long	getStartVersion() A pair of timestamp specifies a time range of a backup.
int	getVersion() The backupmeta scheme version.
boolean	hasDdlIndexes() An index to files contains DDLs.
boolean	hasFileIndex() An index to files contains data files.
boolean	hasRawRangeIndex() An index to files contains RawRanges.
boolean	hasSchemaIndex() An index to files contains Schemas.

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()

 ID and version of backuped cluster.
 

uint64 cluster_id = 1;

Returns:

The clusterId.

getClusterVersion

String getClusterVersion()

string cluster_version = 2;

Returns:

The clusterVersion.

getClusterVersionBytes

com.google.protobuf.ByteString getClusterVersionBytes()

string cluster_version = 2;

Returns:

The bytes for clusterVersion.

getBrVersion

String getBrVersion()

 Save the version of BR running backup jobs.
 

string br_version = 11;

Returns:

The brVersion.

getBrVersionBytes

com.google.protobuf.ByteString getBrVersionBytes()

 Save the version of BR running backup jobs.
 

string br_version = 11;

Returns:

The bytes for brVersion.

getVersion

int getVersion()

 The backupmeta scheme version.
 

int32 version = 12;

Returns:

The version.

getFilesList

List<Brpb.File> getFilesList()

 A set of files that compose a backup.
 Note: `files` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.File files = 4;

getFiles

Brpb.File getFiles(int index)

 A set of files that compose a backup.
 Note: `files` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.File files = 4;

getFilesCount

int getFilesCount()

 A set of files that compose a backup.
 Note: `files` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.File files = 4;

getFilesOrBuilderList

List<? extends Brpb.FileOrBuilder> getFilesOrBuilderList()

 A set of files that compose a backup.
 Note: `files` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.File files = 4;

getFilesOrBuilder

Brpb.FileOrBuilder getFilesOrBuilder(int index)

 A set of files that compose a backup.
 Note: `files` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.File files = 4;

hasFileIndex

boolean hasFileIndex()

 An index to files contains data files.
 

.backup.MetaFile file_index = 13;

Returns:

Whether the fileIndex field is set.

getFileIndex

Brpb.MetaFile getFileIndex()

 An index to files contains data files.
 

.backup.MetaFile file_index = 13;

Returns:

The fileIndex.

getFileIndexOrBuilder

Brpb.MetaFileOrBuilder getFileIndexOrBuilder()

 An index to files contains data files.
 

.backup.MetaFile file_index = 13;

getStartVersion

long getStartVersion()

 A pair of timestamp specifies a time range of a backup.
 For full backup, the start_version equals to the end_version,
 it means point in time.
 For incremental backup, the time range is specified as
 (start_version, end_version].
 

uint64 start_version = 5;

Returns:

The startVersion.

getEndVersion

long getEndVersion()

uint64 end_version = 6;

Returns:

The endVersion.

getSchemasList

List<Brpb.Schema> getSchemasList()

 Table metadata describes database and table info.
 Note: `schemas` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.Schema schemas = 7;

getSchemas

Brpb.Schema getSchemas(int index)

 Table metadata describes database and table info.
 Note: `schemas` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.Schema schemas = 7;

getSchemasCount

int getSchemasCount()

 Table metadata describes database and table info.
 Note: `schemas` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.Schema schemas = 7;

getSchemasOrBuilderList

List<? extends Brpb.SchemaOrBuilder> getSchemasOrBuilderList()

 Table metadata describes database and table info.
 Note: `schemas` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.Schema schemas = 7;

getSchemasOrBuilder

Brpb.SchemaOrBuilder getSchemasOrBuilder(int index)

 Table metadata describes database and table info.
 Note: `schemas` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.Schema schemas = 7;

hasSchemaIndex

boolean hasSchemaIndex()

 An index to files contains Schemas.
 

.backup.MetaFile schema_index = 14;

Returns:

Whether the schemaIndex field is set.

getSchemaIndex

Brpb.MetaFile getSchemaIndex()

 An index to files contains Schemas.
 

.backup.MetaFile schema_index = 14;

Returns:

The schemaIndex.

getSchemaIndexOrBuilder

Brpb.MetaFileOrBuilder getSchemaIndexOrBuilder()

 An index to files contains Schemas.
 

.backup.MetaFile schema_index = 14;

getIsRawKv

boolean getIsRawKv()

 If in raw kv mode, `start_versions`, `end_versions` and `schemas` will be
 ignored, and the backup data's range is represented by raw_ranges.
 

bool is_raw_kv = 8;

Returns:

The isRawKv.

getRawRangesList

List<Brpb.RawRange> getRawRangesList()

 Note: `raw_ranges` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.RawRange raw_ranges = 9;

getRawRanges

Brpb.RawRange getRawRanges(int index)

 Note: `raw_ranges` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.RawRange raw_ranges = 9;

getRawRangesCount

int getRawRangesCount()

 Note: `raw_ranges` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.RawRange raw_ranges = 9;

getRawRangesOrBuilderList

List<? extends Brpb.RawRangeOrBuilder> getRawRangesOrBuilderList()

 Note: `raw_ranges` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.RawRange raw_ranges = 9;

getRawRangesOrBuilder

Brpb.RawRangeOrBuilder getRawRangesOrBuilder(int index)

 Note: `raw_ranges` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

repeated .backup.RawRange raw_ranges = 9;

hasRawRangeIndex

boolean hasRawRangeIndex()

 An index to files contains RawRanges.
 

.backup.MetaFile raw_range_index = 15;

Returns:

Whether the rawRangeIndex field is set.

getRawRangeIndex

Brpb.MetaFile getRawRangeIndex()

 An index to files contains RawRanges.
 

.backup.MetaFile raw_range_index = 15;

Returns:

The rawRangeIndex.

getRawRangeIndexOrBuilder

Brpb.MetaFileOrBuilder getRawRangeIndexOrBuilder()

 An index to files contains RawRanges.
 

.backup.MetaFile raw_range_index = 15;

getDdls

com.google.protobuf.ByteString getDdls()

 In incremental backup, DDLs which are completed in
 (lastBackupTS, backupTS] will be stored here.
 Note: `raw_ranges` is deprecated, as it bloats backupmeta. It is kept for
       compatibility, so new BR can restore older backups.
 

bytes ddls = 10;

Returns:

The ddls.

hasDdlIndexes

boolean hasDdlIndexes()

 An index to files contains DDLs.
 

.backup.MetaFile ddl_indexes = 16;

Returns:

Whether the ddlIndexes field is set.

getDdlIndexes

Brpb.MetaFile getDdlIndexes()

 An index to files contains DDLs.
 

.backup.MetaFile ddl_indexes = 16;

Returns:

The ddlIndexes.

getDdlIndexesOrBuilder

Brpb.MetaFileOrBuilder getDdlIndexesOrBuilder()

 An index to files contains DDLs.
 

.backup.MetaFile ddl_indexes = 16;

getBackupResult

String getBackupResult()

 the backup result into `backupmeta` file
 

string backup_result = 17;

Returns:

The backupResult.

getBackupResultBytes

com.google.protobuf.ByteString getBackupResultBytes()

 the backup result into `backupmeta` file
 

string backup_result = 17;

Returns:

The bytes for backupResult.

getApiVersionValue

int getApiVersionValue()

 API version implies the encode of the key and value.
 

.kvrpcpb.APIVersion api_version = 18;

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 = 18;

Returns:

The apiVersion.

getPoliciesList

List<Brpb.PlacementPolicy> getPoliciesList()

 the placement policy info in backup cluster. we assume the policy won't be too much for one cluster.
 

repeated .backup.PlacementPolicy policies = 19;

getPolicies

Brpb.PlacementPolicy getPolicies(int index)

 the placement policy info in backup cluster. we assume the policy won't be too much for one cluster.
 

repeated .backup.PlacementPolicy policies = 19;

getPoliciesCount

int getPoliciesCount()

 the placement policy info in backup cluster. we assume the policy won't be too much for one cluster.
 

repeated .backup.PlacementPolicy policies = 19;

getPoliciesOrBuilderList

List<? extends Brpb.PlacementPolicyOrBuilder> getPoliciesOrBuilderList()

 the placement policy info in backup cluster. we assume the policy won't be too much for one cluster.
 

repeated .backup.PlacementPolicy policies = 19;

getPoliciesOrBuilder

Brpb.PlacementPolicyOrBuilder getPoliciesOrBuilder(int index)

 the placement policy info in backup cluster. we assume the policy won't be too much for one cluster.
 

repeated .backup.PlacementPolicy policies = 19;

getNewCollationsEnabled

String getNewCollationsEnabled()

 new_collations_enabled specifies the config `new_collations_enabled_on_first_bootstrap` in tidb.
 

string new_collations_enabled = 20;

Returns:

The newCollationsEnabled.

getNewCollationsEnabledBytes

com.google.protobuf.ByteString getNewCollationsEnabledBytes()

 new_collations_enabled specifies the config `new_collations_enabled_on_first_bootstrap` in tidb.
 

string new_collations_enabled = 20;

Returns:

The bytes for newCollationsEnabled.