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.



274
275
276
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 274

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

Instance Attribute Details

#encryption_infoGoogle::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



217
218
219
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 217

def encryption_info
  @encryption_info
end

#end_timeString

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)


223
224
225
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 223

def end_time
  @end_time
end

#expire_timeString

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

Returns:

  • (String)


231
232
233
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 231

def expire_time
  @expire_time
end

#nameString

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)


241
242
243
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 241

def name
  @name
end

#size_bytesFixnum

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

Returns:

  • (Fixnum)


246
247
248
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 246

def size_bytes
  @size_bytes
end

#source_backupString

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

Returns:

  • (String)


253
254
255
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 253

def source_backup
  @source_backup
end

#source_tableString

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)


260
261
262
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 260

def source_table
  @source_table
end

#start_timeString

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)


267
268
269
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 267

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)


272
273
274
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 272

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



279
280
281
282
283
284
285
286
287
288
289
# File 'lib/google/apis/bigtableadmin_v2/classes.rb', line 279

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