Class: Google::Apis::BigtableadminV2::Backup

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigtableadmin_v2/classes.rb,
lib/google/apis/bigtableadmin_v2/representations.rb,
lib/google/apis/bigtableadmin_v2/representations.rb

Overview

A backup of a Cloud Bigtable table.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Backup

Returns a new instance of Backup.



366
367
368
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 366

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#encryption_info ⇒ Google::Apis::BigtableadminV2::EncryptionInfo

Encryption information for a given resource. If this resource is protected with customer managed encryption, the in-use Cloud Key Management Service ( Cloud KMS) key version is specified along with its status. Corresponds to the JSON property encryptionInfo

Returns:



309
310
311
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 309

def encryption_info
  @encryption_info
end

#end_time ⇒ String

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. Corresponds to the JSON property endTime

Returns:

  • (String) 


315
316
317
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 315

def end_time
  @end_time
end

#expire_time ⇒ String

Required. The expiration time of the backup. When creating a backup or updating its expire_time, the value must be greater than the backup creation time by: - At least 6 hours - At most 90 days Once the expire_time has passed, Cloud Bigtable will delete the backup. Corresponds to the JSON property expireTime

Returns:

  • (String) 


323
324
325
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 323

def expire_time
  @expire_time
end

#name ⇒ String

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* 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`. Corresponds to the JSON propertyname`

Returns:

  • (String) 


333
334
335
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 333

def name
  @name
end

#size_bytes ⇒ Fixnum

Output only. Size of the backup in bytes. Corresponds to the JSON property sizeBytes

Returns:

  • (Fixnum) 


338
339
340
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 338

def size_bytes
  @size_bytes
end

#source_backup ⇒ String

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//instances//clusters//backups/ Corresponds to the JSON property sourceBackup

Returns:

  • (String) 


345
346
347
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 345

def source_backup
  @source_backup
end

#source_table ⇒ String

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`. Corresponds to the JSON propertysourceTable`

Returns:

  • (String) 


352
353
354
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 352

def source_table
  @source_table
end

#start_time ⇒ String

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. Corresponds to the JSON property startTime

Returns:

  • (String) 


359
360
361
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 359

def start_time
  @start_time
end

#state ⇒ String

Output only. The current state of the backup. Corresponds to the JSON property state

Returns:

  • (String) 


364
365
366
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 364

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 371

def update!(**args)
  @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
  @end_time = args[:end_time] if args.key?(:end_time)
  @expire_time = args[:expire_time] if args.key?(:expire_time)
  @name = args[:name] if args.key?(:name)
  @size_bytes = args[:size_bytes] if args.key?(:size_bytes)
  @source_backup = args[:source_backup] if args.key?(:source_backup)
  @source_table = args[:source_table] if args.key?(:source_table)
  @start_time = args[:start_time] if args.key?(:start_time)
  @state = args[:state] if args.key?(:state)
end