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

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

Overview

A backup of a Cloud Bigtable table.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Backup

Returns a new instance of Backup.


257
258
259
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 257

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

Instance Attribute Details

#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)

207
208
209
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 207

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 30 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)

216
217
218
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 216

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)

229
230
231
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 229

def name
  @name
end

#size_bytesFixnum

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

Returns:

  • (Fixnum)

234
235
236
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 234

def size_bytes
  @size_bytes
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)

242
243
244
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 242

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)

250
251
252
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 250

def start_time
  @start_time
end

#stateString

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

Returns:

  • (String)

255
256
257
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 255

def state
  @state
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


262
263
264
265
266
267
268
269
270
# File 'generated/google/apis/bigtableadmin_v2/classes.rb', line 262

def update!(**args)
  @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_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