Cloud Spanner Database Admin V1 API - Class Google::Cloud::Spanner::Admin::Database::V1::Backup (v1.0.0)

Version 1.0.0

• 1.2.1 (latest)
• 1.2.0
• 1.1.1
• 1.0.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.1
• 0.16.1
• 0.15.0
• 0.14.2
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.6

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>

Returns

• (::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

Returns

• (::Google::Protobuf::Timestamp) — 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.

#database

def database() -> ::String

Returns

• (::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

Parameter

• 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>.

Returns

• (::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

Returns

• (::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

Returns

• (::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>

Returns

• (::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 eachEncryptionInfo` 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.

#expire_time

def expire_time() -> ::Google::Protobuf::Timestamp

Returns

• (::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

Parameter

• 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.

Returns

• (::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.

#max_expire_time

def max_expire_time() -> ::Google::Protobuf::Timestamp

Returns

• (::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

Returns

• (::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

Parameter

• 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>.

Returns

• (::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>.

#referencing_backups

def referencing_backups() -> ::Array<::String>

Returns

• (::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>

Returns

• (::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 the READY state, the reference to the backup is removed.

#size_bytes

def size_bytes() -> ::Integer

Returns

• (::Integer) — Output only. Size of the backup in bytes.

#state

def state() -> ::Google::Cloud::Spanner::Admin::Database::V1::Backup::State

Returns

• (::Google::Cloud::Spanner::Admin::Database::V1::Backup::State) — Output only. The current state of the backup.

#version_time

def version_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — 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.

#version_time=

def version_time=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — 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.

Returns

• (::Google::Protobuf::Timestamp) — 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.