Class: Google::Cloud::Bigtable::Admin::V2::Backup
- Inherits:
-
Object
- Object
- Google::Cloud::Bigtable::Admin::V2::Backup
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/bigtable/admin/v2/table.rb
Overview
A backup of a Cloud Bigtable table.
Defined Under Namespace
Modules: State
Instance Attribute Summary collapse
-
#encryption_info ⇒ ::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo
readonly
Output only.
-
#end_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#expire_time ⇒ ::Google::Protobuf::Timestamp
Required.
-
#name ⇒ ::String
A globally unique identifier for the backup which cannot be changed.
-
#size_bytes ⇒ ::Integer
readonly
Output only.
-
#source_backup ⇒ ::String
readonly
Output only.
-
#source_table ⇒ ::String
Required.
-
#start_time ⇒ ::Google::Protobuf::Timestamp
readonly
Output only.
-
#state ⇒ ::Google::Cloud::Bigtable::Admin::V2::Backup::State
readonly
Output only.
Instance Attribute Details
#encryption_info ⇒ ::Google::Cloud::Bigtable::Admin::V2::EncryptionInfo (readonly)
Returns Output only. The encryption information for the backup.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 |
#end_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. end_time
is the time that the backup was finished. The row
data in the backup will be no newer than this timestamp.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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. The expiration time of the backup, with microseconds
granularity that must be at least 6 hours and at most 90 days
from the time the request is received. Once the expire_time
has passed, Cloud Bigtable will delete the backup and free the
resources used by the backup.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 A globally unique identifier for the backup which cannot be
changed. Values are of the form
projects/{project}/instances/{instance}/clusters/{cluster}/
backups/[_a-zA-Z0-9][-_.a-zA-Z0-9]*
The final segment of the name must be between 1 and 50 characters
in length.
The backup is stored in the cluster identified by the prefix of the backup
name of the form
projects/{project}/instances/{instance}/clusters/{cluster}
.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 (readonly)
Returns Output only. Size of the backup in bytes.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 |
#source_backup ⇒ ::String (readonly)
Returns Output only. Name of the backup from which this backup was copied. If a
backup is not created by copying a backup, this field will be empty. Values
are of the form: projects/
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 |
#source_table ⇒ ::String
Returns Required. Immutable. Name of the table 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}/tables/{source_table}
.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 |
#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)
Returns Output only. start_time
is the time that the backup was started
(i.e. approximately the time the
CreateBackup
request is received). The row data in this backup will be no older than
this timestamp.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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::Cloud::Bigtable::Admin::V2::Backup::State (readonly)
Returns Output only. The current state of the backup.
392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 |
# File 'proto_docs/google/bigtable/admin/v2/table.rb', line 392 class Backup include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # 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 |