public static final class Backup.Builder extends GeneratedMessageV3.Builder<Backup.Builder> implements BackupOrBuilder
A backup of a Cloud Spanner database.
Protobuf type google.spanner.admin.database.v1.Backup
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Backup.BuilderImplements
BackupOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns | |
---|---|
Type | Description |
Descriptor |
Methods
addAllBackupSchedules(Iterable<String> values)
public Backup.Builder addAllBackupSchedules(Iterable<String> values)
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The backupSchedules to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addAllEncryptionInformation(Iterable<? extends EncryptionInfo> values)
public Backup.Builder addAllEncryptionInformation(Iterable<? extends EncryptionInfo> values)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
values |
Iterable<? extends com.google.spanner.admin.database.v1.EncryptionInfo> |
Returns | |
---|---|
Type | Description |
Backup.Builder |
addAllReferencingBackups(Iterable<String> values)
public Backup.Builder addAllReferencingBackups(Iterable<String> values)
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) = { ... }
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The referencingBackups to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addAllReferencingDatabases(Iterable<String> values)
public Backup.Builder addAllReferencingDatabases(Iterable<String> values)
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) = { ... }
Parameter | |
---|---|
Name | Description |
values |
Iterable<String> The referencingDatabases to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addBackupSchedules(String value)
public Backup.Builder addBackupSchedules(String value)
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The backupSchedules to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addBackupSchedulesBytes(ByteString value)
public Backup.Builder addBackupSchedulesBytes(ByteString value)
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the backupSchedules to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addEncryptionInformation(EncryptionInfo value)
public Backup.Builder addEncryptionInformation(EncryptionInfo value)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
EncryptionInfo |
Returns | |
---|---|
Type | Description |
Backup.Builder |
addEncryptionInformation(EncryptionInfo.Builder builderForValue)
public Backup.Builder addEncryptionInformation(EncryptionInfo.Builder builderForValue)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
EncryptionInfo.Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
addEncryptionInformation(int index, EncryptionInfo value)
public Backup.Builder addEncryptionInformation(int index, EncryptionInfo value)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
EncryptionInfo |
Returns | |
---|---|
Type | Description |
Backup.Builder |
addEncryptionInformation(int index, EncryptionInfo.Builder builderForValue)
public Backup.Builder addEncryptionInformation(int index, EncryptionInfo.Builder builderForValue)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
EncryptionInfo.Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
addEncryptionInformationBuilder()
public EncryptionInfo.Builder addEncryptionInformationBuilder()
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
EncryptionInfo.Builder |
addEncryptionInformationBuilder(int index)
public EncryptionInfo.Builder addEncryptionInformationBuilder(int index)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
EncryptionInfo.Builder |
addReferencingBackups(String value)
public Backup.Builder addReferencingBackups(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The referencingBackups to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addReferencingBackupsBytes(ByteString value)
public Backup.Builder addReferencingBackupsBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the referencingBackups to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addReferencingDatabases(String value)
public Backup.Builder addReferencingDatabases(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The referencingDatabases to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addReferencingDatabasesBytes(ByteString value)
public Backup.Builder addReferencingDatabasesBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes of the referencingDatabases to add. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Backup.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Backup.Builder |
build()
public Backup build()
Returns | |
---|---|
Type | Description |
Backup |
buildPartial()
public Backup buildPartial()
Returns | |
---|---|
Type | Description |
Backup |
clear()
public Backup.Builder clear()
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearBackupSchedules()
public Backup.Builder clearBackupSchedules()
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearCreateTime()
public Backup.Builder clearCreateTime()
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];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearDatabase()
public Backup.Builder clearDatabase()
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) = { ... }
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearDatabaseDialect()
public Backup.Builder clearDatabaseDialect()
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 | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearEncryptionInfo()
public Backup.Builder clearEncryptionInfo()
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearEncryptionInformation()
public Backup.Builder clearEncryptionInformation()
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearExclusiveSizeBytes()
public Backup.Builder clearExclusiveSizeBytes()
Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired.
This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
int64 exclusive_size_bytes = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearExpireTime()
public Backup.Builder clearExpireTime()
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;
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearField(Descriptors.FieldDescriptor field)
public Backup.Builder clearField(Descriptors.FieldDescriptor field)
Parameter | |
---|---|
Name | Description |
field |
FieldDescriptor |
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearFreeableSizeBytes()
public Backup.Builder clearFreeableSizeBytes()
Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
int64 freeable_size_bytes = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearIncrementalBackupChainId()
public Backup.Builder clearIncrementalBackupChainId()
Output only. Populated only for backups in an incremental backup chain.
Backups share the same chain id if and only if they belong to the same
incremental backup chain. Use this field to determine which backups are
part of the same incremental backup chain. The ordering of backups in the
chain can be determined by ordering the backup version_time
.
string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearMaxExpireTime()
public Backup.Builder clearMaxExpireTime()
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 | |
---|---|
Type | Description |
Backup.Builder |
clearName()
public Backup.Builder clearName()
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;
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearOldestVersionTime()
public Backup.Builder clearOldestVersionTime()
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearOneof(Descriptors.OneofDescriptor oneof)
public Backup.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter | |
---|---|
Name | Description |
oneof |
OneofDescriptor |
Returns | |
---|---|
Type | Description |
Backup.Builder |
clearReferencingBackups()
public Backup.Builder clearReferencingBackups()
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 | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearReferencingDatabases()
public Backup.Builder clearReferencingDatabases()
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 | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearSizeBytes()
public Backup.Builder clearSizeBytes()
Output only. Size of the backup in bytes.
int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearState()
public Backup.Builder clearState()
Output only. The current state of the backup.
.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
clearVersionTime()
public Backup.Builder clearVersionTime()
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 | |
---|---|
Type | Description |
Backup.Builder |
clone()
public Backup.Builder clone()
Returns | |
---|---|
Type | Description |
Backup.Builder |
getBackupSchedules(int index)
public String getBackupSchedules(int index)
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The backupSchedules at the given index. |
getBackupSchedulesBytes(int index)
public ByteString getBackupSchedulesBytes(int index)
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the backupSchedules at the given index. |
getBackupSchedulesCount()
public int getBackupSchedulesCount()
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
int |
The count of backupSchedules. |
getBackupSchedulesList()
public ProtocolStringList getBackupSchedulesList()
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Returns | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the backupSchedules. |
getCreateTime()
public 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];
Returns | |
---|---|
Type | Description |
Timestamp |
The createTime. |
getCreateTimeBuilder()
public Timestamp.Builder getCreateTimeBuilder()
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];
Returns | |
---|---|
Type | Description |
Builder |
getCreateTimeOrBuilder()
public 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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getDatabase()
public 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) = { ... }
Returns | |
---|---|
Type | Description |
String |
The database. |
getDatabaseBytes()
public 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) = { ... }
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for database. |
getDatabaseDialect()
public 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 | |
---|---|
Type | Description |
DatabaseDialect |
The databaseDialect. |
getDatabaseDialectValue()
public 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 | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for databaseDialect. |
getDefaultInstanceForType()
public Backup getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Backup |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
getEncryptionInfo()
public 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 | |
---|---|
Type | Description |
EncryptionInfo |
The encryptionInfo. |
getEncryptionInfoBuilder()
public EncryptionInfo.Builder getEncryptionInfoBuilder()
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
EncryptionInfo.Builder |
getEncryptionInfoOrBuilder()
public 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];
Returns | |
---|---|
Type | Description |
EncryptionInfoOrBuilder |
getEncryptionInformation(int index)
public EncryptionInfo getEncryptionInformation(int index)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
EncryptionInfo |
getEncryptionInformationBuilder(int index)
public EncryptionInfo.Builder getEncryptionInformationBuilder(int index)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
EncryptionInfo.Builder |
getEncryptionInformationBuilderList()
public List<EncryptionInfo.Builder> getEncryptionInformationBuilderList()
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<Builder> |
getEncryptionInformationCount()
public int getEncryptionInformationCount()
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
int |
getEncryptionInformationList()
public List<EncryptionInfo> getEncryptionInformationList()
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<EncryptionInfo> |
getEncryptionInformationOrBuilder(int index)
public EncryptionInfoOrBuilder getEncryptionInformationOrBuilder(int index)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
EncryptionInfoOrBuilder |
getEncryptionInformationOrBuilderList()
public List<? extends EncryptionInfoOrBuilder> getEncryptionInformationOrBuilderList()
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
List<? extends com.google.spanner.admin.database.v1.EncryptionInfoOrBuilder> |
getExclusiveSizeBytes()
public long getExclusiveSizeBytes()
Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired.
This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
int64 exclusive_size_bytes = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
long |
The exclusiveSizeBytes. |
getExpireTime()
public 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;
Returns | |
---|---|
Type | Description |
Timestamp |
The expireTime. |
getExpireTimeBuilder()
public Timestamp.Builder getExpireTimeBuilder()
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;
Returns | |
---|---|
Type | Description |
Builder |
getExpireTimeOrBuilder()
public 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;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getFreeableSizeBytes()
public long getFreeableSizeBytes()
Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
int64 freeable_size_bytes = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
long |
The freeableSizeBytes. |
getIncrementalBackupChainId()
public String getIncrementalBackupChainId()
Output only. Populated only for backups in an incremental backup chain.
Backups share the same chain id if and only if they belong to the same
incremental backup chain. Use this field to determine which backups are
part of the same incremental backup chain. The ordering of backups in the
chain can be determined by ordering the backup version_time
.
string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
String |
The incrementalBackupChainId. |
getIncrementalBackupChainIdBytes()
public ByteString getIncrementalBackupChainIdBytes()
Output only. Populated only for backups in an incremental backup chain.
Backups share the same chain id if and only if they belong to the same
incremental backup chain. Use this field to determine which backups are
part of the same incremental backup chain. The ordering of backups in the
chain can be determined by ordering the backup version_time
.
string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for incrementalBackupChainId. |
getMaxExpireTime()
public 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 | |
---|---|
Type | Description |
Timestamp |
The maxExpireTime. |
getMaxExpireTimeBuilder()
public Timestamp.Builder getMaxExpireTimeBuilder()
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 | |
---|---|
Type | Description |
Builder |
getMaxExpireTimeOrBuilder()
public 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];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getName()
public 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;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public 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;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getOldestVersionTime()
public Timestamp getOldestVersionTime()
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Timestamp |
The oldestVersionTime. |
getOldestVersionTimeBuilder()
public Timestamp.Builder getOldestVersionTimeBuilder()
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Builder |
getOldestVersionTimeOrBuilder()
public TimestampOrBuilder getOldestVersionTimeOrBuilder()
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
getReferencingBackups(int index)
public 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) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The referencingBackups at the given index. |
getReferencingBackupsBytes(int index)
public 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) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the referencingBackups at the given index. |
getReferencingBackupsCount()
public 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 | |
---|---|
Type | Description |
int |
The count of referencingBackups. |
getReferencingBackupsList()
public ProtocolStringList 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 | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the referencingBackups. |
getReferencingDatabases(int index)
public 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) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the element to return. |
Returns | |
---|---|
Type | Description |
String |
The referencingDatabases at the given index. |
getReferencingDatabasesBytes(int index)
public 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) = { ... }
Parameter | |
---|---|
Name | Description |
index |
int The index of the value to return. |
Returns | |
---|---|
Type | Description |
ByteString |
The bytes of the referencingDatabases at the given index. |
getReferencingDatabasesCount()
public 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 | |
---|---|
Type | Description |
int |
The count of referencingDatabases. |
getReferencingDatabasesList()
public ProtocolStringList 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 | |
---|---|
Type | Description |
ProtocolStringList |
A list containing the referencingDatabases. |
getSizeBytes()
public long getSizeBytes()
Output only. Size of the backup in bytes.
int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
long |
The sizeBytes. |
getState()
public 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 | |
---|---|
Type | Description |
Backup.State |
The state. |
getStateValue()
public 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 | |
---|---|
Type | Description |
int |
The enum numeric value on the wire for state. |
getVersionTime()
public 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 | |
---|---|
Type | Description |
Timestamp |
The versionTime. |
getVersionTimeBuilder()
public Timestamp.Builder getVersionTimeBuilder()
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 | |
---|---|
Type | Description |
Builder |
getVersionTimeOrBuilder()
public 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;
Returns | |
---|---|
Type | Description |
TimestampOrBuilder |
hasCreateTime()
public 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];
Returns | |
---|---|
Type | Description |
boolean |
Whether the createTime field is set. |
hasEncryptionInfo()
public 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 | |
---|---|
Type | Description |
boolean |
Whether the encryptionInfo field is set. |
hasExpireTime()
public 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;
Returns | |
---|---|
Type | Description |
boolean |
Whether the expireTime field is set. |
hasMaxExpireTime()
public 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 | |
---|---|
Type | Description |
boolean |
Whether the maxExpireTime field is set. |
hasOldestVersionTime()
public boolean hasOldestVersionTime()
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the oldestVersionTime field is set. |
hasVersionTime()
public 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 | |
---|---|
Type | Description |
boolean |
Whether the versionTime field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns | |
---|---|
Type | Description |
FieldAccessorTable |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
mergeCreateTime(Timestamp value)
public Backup.Builder mergeCreateTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeEncryptionInfo(EncryptionInfo value)
public Backup.Builder mergeEncryptionInfo(EncryptionInfo value)
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
EncryptionInfo |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeExpireTime(Timestamp value)
public Backup.Builder mergeExpireTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Backup.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters | |
---|---|
Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
Returns | |
---|---|
Type | Description |
Backup.Builder |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Backup.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeFrom(Backup other)
public Backup.Builder mergeFrom(Backup other)
Parameter | |
---|---|
Name | Description |
other |
Backup |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeMaxExpireTime(Timestamp value)
public Backup.Builder mergeMaxExpireTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeOldestVersionTime(Timestamp value)
public Backup.Builder mergeOldestVersionTime(Timestamp value)
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Backup.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Backup.Builder |
mergeVersionTime(Timestamp value)
public Backup.Builder mergeVersionTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
removeEncryptionInformation(int index)
public Backup.Builder removeEncryptionInformation(int index)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
index |
int |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setBackupSchedules(int index, String value)
public Backup.Builder setBackupSchedules(int index, String value)
Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups.
To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.
repeated string backup_schedules = 14 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }
Parameters | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The backupSchedules to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setCreateTime(Timestamp value)
public Backup.Builder setCreateTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setCreateTime(Timestamp.Builder builderForValue)
public Backup.Builder setCreateTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setDatabase(String value)
public Backup.Builder setDatabase(String value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
String The database to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setDatabaseBytes(ByteString value)
public Backup.Builder setDatabaseBytes(ByteString value)
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) = { ... }
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for database to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setDatabaseDialect(DatabaseDialect value)
public Backup.Builder setDatabaseDialect(DatabaseDialect value)
Output only. The database dialect information for the backup.
.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
DatabaseDialect The databaseDialect to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setDatabaseDialectValue(int value)
public Backup.Builder setDatabaseDialectValue(int value)
Output only. The database dialect information for the backup.
.google.spanner.admin.database.v1.DatabaseDialect database_dialect = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for databaseDialect to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setEncryptionInfo(EncryptionInfo value)
public Backup.Builder setEncryptionInfo(EncryptionInfo value)
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
EncryptionInfo |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setEncryptionInfo(EncryptionInfo.Builder builderForValue)
public Backup.Builder setEncryptionInfo(EncryptionInfo.Builder builderForValue)
Output only. The encryption information for the backup.
.google.spanner.admin.database.v1.EncryptionInfo encryption_info = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
EncryptionInfo.Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setEncryptionInformation(int index, EncryptionInfo value)
public Backup.Builder setEncryptionInformation(int index, EncryptionInfo value)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
value |
EncryptionInfo |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setEncryptionInformation(int index, EncryptionInfo.Builder builderForValue)
public Backup.Builder setEncryptionInformation(int index, EncryptionInfo.Builder builderForValue)
Output only. The encryption information for the backup, whether it is
protected by one or more KMS keys. The information includes all Cloud
KMS key versions used to encrypt the backup. The encryption_status' field
inside of each
EncryptionInfo` is not populated. At least one of the key
versions must be available for the backup to be restored. If a key version
is revoked in the middle of a restore, the restore behavior is undefined.
repeated .google.spanner.admin.database.v1.EncryptionInfo encryption_information = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameters | |
---|---|
Name | Description |
index |
int |
builderForValue |
EncryptionInfo.Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setExclusiveSizeBytes(long value)
public Backup.Builder setExclusiveSizeBytes(long value)
Output only. For a backup in an incremental backup chain, this is the storage space needed to keep the data that has changed since the previous backup. For all other backups, this is always the size of the backup. This value may change if backups on the same chain get deleted or expired.
This field can be used to calculate the total storage space used by a set of backups. For example, the total space used by all backups of a database can be computed by summing up this field.
int64 exclusive_size_bytes = 16 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The exclusiveSizeBytes to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setExpireTime(Timestamp value)
public Backup.Builder setExpireTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setExpireTime(Timestamp.Builder builderForValue)
public Backup.Builder setExpireTime(Timestamp.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public Backup.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
value |
Object |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setFreeableSizeBytes(long value)
public Backup.Builder setFreeableSizeBytes(long value)
Output only. The number of bytes that will be freed by deleting this backup. This value will be zero if, for example, this backup is part of an incremental backup chain and younger backups in the chain require that we keep its data. For backups not in an incremental backup chain, this is always the size of the backup. This value may change if backups on the same chain get created, deleted or expired.
int64 freeable_size_bytes = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The freeableSizeBytes to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setIncrementalBackupChainId(String value)
public Backup.Builder setIncrementalBackupChainId(String value)
Output only. Populated only for backups in an incremental backup chain.
Backups share the same chain id if and only if they belong to the same
incremental backup chain. Use this field to determine which backups are
part of the same incremental backup chain. The ordering of backups in the
chain can be determined by ordering the backup version_time
.
string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
String The incrementalBackupChainId to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setIncrementalBackupChainIdBytes(ByteString value)
public Backup.Builder setIncrementalBackupChainIdBytes(ByteString value)
Output only. Populated only for backups in an incremental backup chain.
Backups share the same chain id if and only if they belong to the same
incremental backup chain. Use this field to determine which backups are
part of the same incremental backup chain. The ordering of backups in the
chain can be determined by ordering the backup version_time
.
string incremental_backup_chain_id = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for incrementalBackupChainId to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setMaxExpireTime(Timestamp value)
public Backup.Builder setMaxExpireTime(Timestamp value)
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];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setMaxExpireTime(Timestamp.Builder builderForValue)
public Backup.Builder setMaxExpireTime(Timestamp.Builder builderForValue)
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];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setName(String value)
public Backup.Builder setName(String value)
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;
Parameter | |
---|---|
Name | Description |
value |
String The name to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setNameBytes(ByteString value)
public Backup.Builder setNameBytes(ByteString value)
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;
Parameter | |
---|---|
Name | Description |
value |
ByteString The bytes for name to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setOldestVersionTime(Timestamp value)
public Backup.Builder setOldestVersionTime(Timestamp value)
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setOldestVersionTime(Timestamp.Builder builderForValue)
public Backup.Builder setOldestVersionTime(Timestamp.Builder builderForValue)
Output only. Data deleted at a time older than this is guaranteed not to be retained in order to support this backup. For a backup in an incremental backup chain, this is the version time of the oldest backup that exists or ever existed in the chain. For all other backups, this is the version time of the backup. This field can be used to understand what data is being retained by the backup system.
.google.protobuf.Timestamp oldest_version_time = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setReferencingBackups(int index, String value)
public Backup.Builder setReferencingBackups(int index, String value)
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 | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The referencingBackups to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setReferencingDatabases(int index, String value)
public Backup.Builder setReferencingDatabases(int index, String value)
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 | |
---|---|
Name | Description |
index |
int The index to set the value at. |
value |
String The referencingDatabases to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Backup.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters | |
---|---|
Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setSizeBytes(long value)
public Backup.Builder setSizeBytes(long value)
Output only. Size of the backup in bytes.
int64 size_bytes = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
long The sizeBytes to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setState(Backup.State value)
public Backup.Builder setState(Backup.State value)
Output only. The current state of the backup.
.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
Backup.State The state to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setStateValue(int value)
public Backup.Builder setStateValue(int value)
Output only. The current state of the backup.
.google.spanner.admin.database.v1.Backup.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter | |
---|---|
Name | Description |
value |
int The enum numeric value on the wire for state to set. |
Returns | |
---|---|
Type | Description |
Backup.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Backup.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter | |
---|---|
Name | Description |
unknownFields |
UnknownFieldSet |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setVersionTime(Timestamp value)
public Backup.Builder setVersionTime(Timestamp value)
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;
Parameter | |
---|---|
Name | Description |
value |
Timestamp |
Returns | |
---|---|
Type | Description |
Backup.Builder |
setVersionTime(Timestamp.Builder builderForValue)
public Backup.Builder setVersionTime(Timestamp.Builder builderForValue)
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;
Parameter | |
---|---|
Name | Description |
builderForValue |
Builder |
Returns | |
---|---|
Type | Description |
Backup.Builder |