com.google.spanner.admin.database.v1

Interface BackupOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Backup, Backup.Builder

public interface BackupOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDatabase() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.ByteString	getDatabaseBytes() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.Timestamp	getExpireTime() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.TimestampOrBuilder	getExpireTimeOrBuilder() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
String	getName() Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
com.google.protobuf.ByteString	getNameBytes() Output only for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.
String	getReferencingDatabases(int index) Output only.
com.google.protobuf.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.
boolean	hasCreateTime() Output only.
boolean	hasExpireTime() Required for the [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] operation.

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

com.google.protobuf.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.

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

com.google.protobuf.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

com.google.protobuf.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

com.google.protobuf.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 backup will contain an externally consistent
 copy of the database at the timestamp specified by
 `create_time`. `create_time` is approximately the time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. The backup will contain an externally consistent
 copy of the database at the timestamp specified by
 `create_time`. `create_time` is approximately the time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. The backup will contain an externally consistent
 copy of the database at the timestamp specified by
 `create_time`. `create_time` is approximately the time the
 [CreateBackup][google.spanner.admin.database.v1.DatabaseAdmin.CreateBackup] request is received.
 

.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];

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];

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];

Parameters:

index - The index of the element to return.

Returns:

The referencingDatabases at the given index.

getReferencingDatabasesBytes

com.google.protobuf.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];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the referencingDatabases at the given index.