com.google.spanner.admin.database.v1

Interface BackupOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

Backup, Backup.Builder

public interface BackupOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Timestamp	getCreateTime() Output only.
TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDatabase() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
ByteString	getDatabaseBytes() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
DatabaseDialect	getDatabaseDialect() Output only.
int	getDatabaseDialectValue() Output only.
EncryptionInfo	getEncryptionInfo() Output only.
EncryptionInfoOrBuilder	getEncryptionInfoOrBuilder() Output only.
Timestamp	getExpireTime() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
TimestampOrBuilder	getExpireTimeOrBuilder() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
Timestamp	getMaxExpireTime() Output only.
TimestampOrBuilder	getMaxExpireTimeOrBuilder() Output only.
String	getName() Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
ByteString	getNameBytes() Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
String	getReferencingBackups(int index) Output only.
ByteString	getReferencingBackupsBytes(int index) Output only.
int	getReferencingBackupsCount() Output only.
List<String>	getReferencingBackupsList() Output only.
String	getReferencingDatabases(int index) Output only.
ByteString	getReferencingDatabasesBytes(int index) Output only.
int	getReferencingDatabasesCount() Output only.
List<String>	getReferencingDatabasesList() Output only.
long	getSizeBytes() Output only.
Backup.State	getState() Output only.
int	getStateValue() Output only.
Timestamp	getVersionTime() The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`.
TimestampOrBuilder	getVersionTimeOrBuilder() The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionInfo() Output only.
boolean	hasExpireTime() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
boolean	hasMaxExpireTime() Output only.
boolean	hasVersionTime() The backup will contain an externally consistent copy of the database at the timestamp specified by `version_time`.

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

getDatabase

String getDatabase()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
 Name of the database from which this backup was
 created. This needs to be in the same instance as the backup.
 Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>`.
 

string database = 2 [(.google.api.resource_reference) = { ... }

Returns:

The database.

getDatabaseBytes

ByteString getDatabaseBytes()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
 Name of the database from which this backup was
 created. This needs to be in the same instance as the backup.
 Values are of the form
 `projects/<project>/instances/<instance>/databases/<database>`.
 

string database = 2 [(.google.api.resource_reference) = { ... }

Returns:

The bytes for database.

hasVersionTime

boolean hasVersionTime()

 The backup will contain an externally consistent copy of the database at
 the timestamp specified by `version_time`. If `version_time` is not
 specified, the system will set `version_time` to the `create_time` of the
 backup.
 

.google.protobuf.Timestamp version_time = 9;

Returns:

Whether the versionTime field is set.

getVersionTime

Timestamp getVersionTime()

 The backup will contain an externally consistent copy of the database at
 the timestamp specified by `version_time`. If `version_time` is not
 specified, the system will set `version_time` to the `create_time` of the
 backup.
 

.google.protobuf.Timestamp version_time = 9;

Returns:

The versionTime.

getVersionTimeOrBuilder

TimestampOrBuilder getVersionTimeOrBuilder()

 The backup will contain an externally consistent copy of the database at
 the timestamp specified by `version_time`. If `version_time` is not
 specified, the system will set `version_time` to the `create_time` of the
 backup.
 

.google.protobuf.Timestamp version_time = 9;

hasExpireTime

boolean hasExpireTime()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 operation. The expiration time of the backup, with microseconds
 granularity that must be at least 6 hours and at most 366 days
 from the time the CreateBackup request is processed. Once the `expire_time`
 has passed, the backup is eligible to be automatically deleted by Cloud
 Spanner to free the resources used by the backup.
 

.google.protobuf.Timestamp expire_time = 3;

Returns:

Whether the expireTime field is set.

getExpireTime

Timestamp getExpireTime()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 operation. The expiration time of the backup, with microseconds
 granularity that must be at least 6 hours and at most 366 days
 from the time the CreateBackup request is processed. Once the `expire_time`
 has passed, the backup is eligible to be automatically deleted by Cloud
 Spanner to free the resources used by the backup.
 

.google.protobuf.Timestamp expire_time = 3;

Returns:

The expireTime.

getExpireTimeOrBuilder

TimestampOrBuilder getExpireTimeOrBuilder()

 Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 operation. The expiration time of the backup, with microseconds
 granularity that must be at least 6 hours and at most 366 days
 from the time the CreateBackup request is processed. Once the `expire_time`
 has passed, the backup is eligible to be automatically deleted by Cloud
 Spanner to free the resources used by the backup.
 

.google.protobuf.Timestamp expire_time = 3;

getName

String getName()

 Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
 Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation.
 A globally unique identifier for the backup which cannot be
 changed. Values are of the form
 `projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9]`
 The final segment of the name must be between 2 and 60 characters
 in length.
 The backup is stored in the location(s) specified in the instance
 configuration of the instance containing the backup, identified
 by the prefix of the backup name of the form
 `projects/<project>/instances/<instance>`.
 

string name = 1;

Returns:

The name.

getNameBytes

ByteString getNameBytes()

 Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
 Required for the [UpdateBackup][google.spanner.admin.database.v1.DatabaseAdmin.UpdateBackup] operation.
 A globally unique identifier for the backup which cannot be
 changed. Values are of the form
 `projects/<project>/instances/<instance>/backups/[a-z][a-z0-9_\-]*[a-z0-9]`
 The final segment of the name must be between 2 and 60 characters
 in length.
 The backup is stored in the location(s) specified in the instance
 configuration of the instance containing the backup, identified
 by the prefix of the backup name of the form
 `projects/<project>/instances/<instance>`.
 

string name = 1;

Returns:

The bytes for name.

hasCreateTime

boolean hasCreateTime()

 Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 request is received. If the request does not specify `version_time`, the
 `version_time` of the backup will be equivalent to the `create_time`.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the createTime field is set.

getCreateTime

Timestamp getCreateTime()

 Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 request is received. If the request does not specify `version_time`, the
 `version_time` of the backup will be equivalent to the `create_time`.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The createTime.

getCreateTimeOrBuilder

TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The time the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup]
 request is received. If the request does not specify `version_time`, the
 `version_time` of the backup will be equivalent to the `create_time`.
 

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

getSizeBytes

long getSizeBytes()

 Output only. Size of the backup in bytes.
 

int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The sizeBytes.

getStateValue

int getStateValue()

 Output only. The current state of the backup.
 

.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

Backup.State getState()

 Output only. The current state of the backup.
 

.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

getReferencingDatabasesList

List<String> getReferencingDatabasesList()

 Output only. The names of the restored databases that reference the backup.
 The database names are of
 the form `projects/<project>/instances/<instance>/databases/<database>`.
 Referencing databases may exist in different instances. The existence of
 any referencing database prevents the backup from being deleted. When a
 restored database from the backup enters the `READY` state, the reference
 to the backup is removed.
 

repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

A list containing the referencingDatabases.

getReferencingDatabasesCount

int getReferencingDatabasesCount()

 Output only. The names of the restored databases that reference the backup.
 The database names are of
 the form `projects/<project>/instances/<instance>/databases/<database>`.
 Referencing databases may exist in different instances. The existence of
 any referencing database prevents the backup from being deleted. When a
 restored database from the backup enters the `READY` state, the reference
 to the backup is removed.
 

repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

The count of referencingDatabases.

getReferencingDatabases

String getReferencingDatabases(int index)

 Output only. The names of the restored databases that reference the backup.
 The database names are of
 the form `projects/<project>/instances/<instance>/databases/<database>`.
 Referencing databases may exist in different instances. The existence of
 any referencing database prevents the backup from being deleted. When a
 restored database from the backup enters the `READY` state, the reference
 to the backup is removed.
 

repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters:

index - The index of the element to return.

Returns:

The referencingDatabases at the given index.

getReferencingDatabasesBytes

ByteString getReferencingDatabasesBytes(int index)

 Output only. The names of the restored databases that reference the backup.
 The database names are of
 the form `projects/<project>/instances/<instance>/databases/<database>`.
 Referencing databases may exist in different instances. The existence of
 any referencing database prevents the backup from being deleted. When a
 restored database from the backup enters the `READY` state, the reference
 to the backup is removed.
 

repeated string referencing_databases = 7 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters:

index - The index of the value to return.

Returns:

The bytes of the referencingDatabases at the given index.

hasEncryptionInfo

boolean hasEncryptionInfo()

 Output only. The encryption information for the backup.
 

.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the encryptionInfo field is set.

getEncryptionInfo

EncryptionInfo getEncryptionInfo()

 Output only. The encryption information for the backup.
 

.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The encryptionInfo.

getEncryptionInfoOrBuilder

EncryptionInfoOrBuilder getEncryptionInfoOrBuilder()

 Output only. The encryption information for the backup.
 

.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

getDatabaseDialectValue

int getDatabaseDialectValue()

 Output only. The database dialect information for the backup.
 

.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for databaseDialect.

getDatabaseDialect

DatabaseDialect getDatabaseDialect()

 Output only. The database dialect information for the backup.
 

.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The databaseDialect.

getReferencingBackupsList

List<String> getReferencingBackupsList()

 Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
 

repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

A list containing the referencingBackups.

getReferencingBackupsCount

int getReferencingBackupsCount()

 Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
 

repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns:

The count of referencingBackups.

getReferencingBackups

String getReferencingBackups(int index)

 Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
 

repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters:

index - The index of the element to return.

Returns:

The referencingBackups at the given index.

getReferencingBackupsBytes

ByteString getReferencingBackupsBytes(int index)

 Output only. The names of the destination backups being created by copying
 this source backup. The backup names are of the form
 `projects/<project>/instances/<instance>/backups/<backup>`.
 Referencing backups may exist in different instances. The existence of
 any referencing backup prevents the backup from being deleted. When the
 copy operation is done (either successfully completed or cancelled or the
 destination backup is deleted), the reference to the backup is removed.
 

repeated string referencing_backups = 11 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Parameters:

index - The index of the value to return.

Returns:

The bytes of the referencingBackups at the given index.

hasMaxExpireTime

boolean hasMaxExpireTime()

 Output only. The max allowed expiration time of the backup, with
 microseconds granularity. A backup's expiration time can be configured in
 multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
 copying an existing backup, the expiration time specified must be
 less than `Backup.max_expire_time`.
 

.google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the maxExpireTime field is set.

getMaxExpireTime

Timestamp getMaxExpireTime()

 Output only. The max allowed expiration time of the backup, with
 microseconds granularity. A backup's expiration time can be configured in
 multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
 copying an existing backup, the expiration time specified must be
 less than `Backup.max_expire_time`.
 

.google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The maxExpireTime.

getMaxExpireTimeOrBuilder

TimestampOrBuilder getMaxExpireTimeOrBuilder()

 Output only. The max allowed expiration time of the backup, with
 microseconds granularity. A backup's expiration time can be configured in
 multiple APIs: CreateBackup, UpdateBackup, CopyBackup. When updating or
 copying an existing backup, the expiration time specified must be
 less than `Backup.max_expire_time`.
 

.google.protobuf.Timestamp max_expire_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];