Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::Backup.
A backup of a Cloud Spanner database.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#backup_schedules
def backup_schedules() -> ::Array<::String>
-
(::Array<::String>) — 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.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — Output only. The time the
CreateBackup
request is received. If the request does not specify
version_time
, theversion_time
of the backup will be equivalent to thecreate_time
.
#database
def database() -> ::String
-
(::String) — 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>
.
#database=
def database=(value) -> ::String
-
value (::String) — 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) — 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>
.
#database_dialect
def database_dialect() -> ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect
- (::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect) — Output only. The database dialect information for the backup.
#encryption_info
def encryption_info() -> ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo
- (::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo) — Output only. The encryption information for the backup.
#encryption_information
def encryption_information() -> ::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo>
-
(::Array<::Google::Cloud::Spanner::Admin::Database::V1::EncryptionInfo>) — 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.
#exclusive_size_bytes
def exclusive_size_bytes() -> ::Integer
-
(::Integer) — 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.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — 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.
#expire_time=
def expire_time=(value) -> ::Google::Protobuf::Timestamp
-
value (::Google::Protobuf::Timestamp) — 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) — 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.
#freeable_size_bytes
def freeable_size_bytes() -> ::Integer
- (::Integer) — 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.
#incremental_backup_chain_id
def incremental_backup_chain_id() -> ::String
-
(::String) — 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
.
#max_expire_time
def max_expire_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — 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
.
#name
def name() -> ::String
-
(::String) — 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_\-]*[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>
.
#name=
def name=(value) -> ::String
-
value (::String) — 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_\-]*[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) — 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_\-]*[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>
.
#oldest_version_time
def oldest_version_time() -> ::Google::Protobuf::Timestamp
- (::Google::Protobuf::Timestamp) — 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.
#referencing_backups
def referencing_backups() -> ::Array<::String>
-
(::Array<::String>) — 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.
#referencing_databases
def referencing_databases() -> ::Array<::String>
-
(::Array<::String>) — 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 theREADY
state, the reference to the backup is removed.
#size_bytes
def size_bytes() -> ::Integer
- (::Integer) — Output only. Size of the backup in bytes.
#state
def state() -> ::Google::Cloud::Spanner::Admin::Database::V1::Backup::State
- (::Google::Cloud::Spanner::Admin::Database::V1::Backup::State) — Output only. The current state of the backup.
#version_time
def version_time() -> ::Google::Protobuf::Timestamp
-
(::Google::Protobuf::Timestamp) — The backup will contain an externally consistent copy of the database at
the timestamp specified by
version_time
. Ifversion_time
is not specified, the system will setversion_time
to thecreate_time
of the backup.
#version_time=
def version_time=(value) -> ::Google::Protobuf::Timestamp
-
value (::Google::Protobuf::Timestamp) — The backup will contain an externally consistent copy of the database at
the timestamp specified by
version_time
. Ifversion_time
is not specified, the system will setversion_time
to thecreate_time
of the backup.
-
(::Google::Protobuf::Timestamp) — The backup will contain an externally consistent copy of the database at
the timestamp specified by
version_time
. Ifversion_time
is not specified, the system will setversion_time
to thecreate_time
of the backup.