Class: Google::Spanner::Admin::Database::V1::Backup
- Inherits:
-
Object
- Object
- Google::Spanner::Admin::Database::V1::Backup
- Defined in:
- lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb
Overview
A backup of a Cloud Spanner database.
Defined Under Namespace
Modules: State
Instance Attribute Summary collapse
-
#create_time ⇒ Google::Protobuf::Timestamp
Output only.
-
#database ⇒ String
Required for the CreateBackup operation.
-
#expire_time ⇒ Google::Protobuf::Timestamp
Required for the CreateBackup operation.
-
#name ⇒ String
Output only for the CreateBackup operation.
-
#referencing_databases ⇒ Array<String>
Output only.
-
#size_bytes ⇒ Integer
Output only.
-
#state ⇒ Google::Spanner::Admin::Database::V1::Backup::State
Output only.
Instance Attribute Details
#create_time ⇒ Google::Protobuf::Timestamp
Returns Output only. The backup will contain an externally consistent
copy of the database at the timestamp specified by
create_time
. create_time
is approximately the time the
CreateBackup request is received.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |
#database ⇒ String
Returns 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>
.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |
#expire_time ⇒ Google::Protobuf::Timestamp
Returns 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.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |
#name ⇒ String
Returns 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>
.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |
#referencing_databases ⇒ Array<String>
Returns 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.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |
#size_bytes ⇒ Integer
Returns Output only. Size of the backup in bytes.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |
#state ⇒ Google::Spanner::Admin::Database::V1::Backup::State
Returns Output only. The current state of the backup.
73 74 75 76 77 78 79 80 81 82 83 84 85 86 |
# File 'lib/google/cloud/spanner/admin/database/v1/doc/google/spanner/admin/database/v1/backup.rb', line 73 class Backup # Indicates the current state of the backup. module State # Not specified. STATE_UNSPECIFIED = 0 # The pending backup is still being created. Operations on the # backup may fail with `FAILED_PRECONDITION` in this state. CREATING = 1 # The backup is complete and ready for use. READY = 2 end end |