public interface BackupOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getCreateTime()
public abstract Timestamp getCreateTime()
Output only. The time the 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];
Type | Description |
Timestamp | The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the 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];
Type | Description |
TimestampOrBuilder |
getDatabase()
public abstract String getDatabase()
Required for the 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) = { ... }
Type | Description |
String | The database. |
getDatabaseBytes()
public abstract ByteString getDatabaseBytes()
Required for the 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) = { ... }
Type | Description |
ByteString | The bytes for database. |
getDatabaseDialect()
public abstract 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];
Type | Description |
DatabaseDialect | The databaseDialect. |
getDatabaseDialectValue()
public abstract 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];
Type | Description |
int | The enum numeric value on the wire for databaseDialect. |
getEncryptionInfo()
public abstract 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];
Type | Description |
EncryptionInfo | The encryptionInfo. |
getEncryptionInfoOrBuilder()
public abstract 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];
Type | Description |
EncryptionInfoOrBuilder |
getExpireTime()
public abstract Timestamp getExpireTime()
Required for the 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;
Type | Description |
Timestamp | The expireTime. |
getExpireTimeOrBuilder()
public abstract TimestampOrBuilder getExpireTimeOrBuilder()
Required for the 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;
Type | Description |
TimestampOrBuilder |
getMaxExpireTime()
public abstract 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];
Type | Description |
Timestamp | The maxExpireTime. |
getMaxExpireTimeOrBuilder()
public abstract 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];
Type | Description |
TimestampOrBuilder |
getName()
public abstract String getName()
Output only for the CreateBackup operation.
Required for the 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]
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;
Type | Description |
String | The name. |
getNameBytes()
public abstract ByteString getNameBytes()
Output only for the CreateBackup operation.
Required for the 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]
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;
Type | Description |
ByteString | The bytes for name. |
getReferencingBackups(int index)
public abstract 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) = { ... }
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The referencingBackups at the given index. |
getReferencingBackupsBytes(int index)
public abstract 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) = { ... }
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the referencingBackups at the given index. |
getReferencingBackupsCount()
public abstract 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) = { ... }
Type | Description |
int | The count of referencingBackups. |
getReferencingBackupsList()
public abstract 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) = { ... }
Type | Description |
List<String> | A list containing the referencingBackups. |
getReferencingDatabases(int index)
public abstract 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) = { ... }
Name | Description |
index | int The index of the element to return. |
Type | Description |
String | The referencingDatabases at the given index. |
getReferencingDatabasesBytes(int index)
public abstract 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) = { ... }
Name | Description |
index | int The index of the value to return. |
Type | Description |
ByteString | The bytes of the referencingDatabases at the given index. |
getReferencingDatabasesCount()
public abstract 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) = { ... }
Type | Description |
int | The count of referencingDatabases. |
getReferencingDatabasesList()
public abstract 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) = { ... }
Type | Description |
List<String> | A list containing the referencingDatabases. |
getSizeBytes()
public abstract long getSizeBytes()
Output only. Size of the backup in bytes.
int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Type | Description |
long | The sizeBytes. |
getState()
public abstract 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];
Type | Description |
Backup.State | The state. |
getStateValue()
public abstract 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];
Type | Description |
int | The enum numeric value on the wire for state. |
getVersionTime()
public abstract 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;
Type | Description |
Timestamp | The versionTime. |
getVersionTimeOrBuilder()
public abstract 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;
Type | Description |
TimestampOrBuilder |
hasCreateTime()
public abstract boolean hasCreateTime()
Output only. The time the 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];
Type | Description |
boolean | Whether the createTime field is set. |
hasEncryptionInfo()
public abstract 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];
Type | Description |
boolean | Whether the encryptionInfo field is set. |
hasExpireTime()
public abstract boolean hasExpireTime()
Required for the 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;
Type | Description |
boolean | Whether the expireTime field is set. |
hasMaxExpireTime()
public abstract 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];
Type | Description |
boolean | Whether the maxExpireTime field is set. |
hasVersionTime()
public abstract 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;
Type | Description |
boolean | Whether the versionTime field is set. |