Class: Google::Apis::GkebackupV1::VolumeBackup

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

Overview

Represents the backup of a specific persistent volume as a component of a Backup - both the record of the operation and a pointer to the underlying storage-specific artifacts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VolumeBackup

Returns a new instance of VolumeBackup.



2444
2445
2446
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2444

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

Instance Attribute Details

#complete_time ⇒ String

Output only. The timestamp when the associated underlying volume backup operation completed. Corresponds to the JSON property completeTime

Returns:

  • (String) 


2369
2370
2371
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2369

def complete_time
  @complete_time
end

#create_time ⇒ String

Output only. The timestamp when this VolumeBackup resource was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2374
2375
2376
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2374

def create_time
  @create_time
end

#disk_size_bytes ⇒ Fixnum

Output only. The minimum size of the disk to which this VolumeBackup can be restored. Corresponds to the JSON property diskSizeBytes

Returns:

  • (Fixnum) 


2380
2381
2382
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2380

def disk_size_bytes
  @disk_size_bytes
end

#etag ⇒ String

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a volume backup from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform volume backup updates in order to avoid race conditions. Corresponds to the JSON property etag

Returns:

  • (String) 


2389
2390
2391
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2389

def etag
  @etag
end

#format ⇒ String

Output only. The format used for the volume backup. Corresponds to the JSON property format

Returns:

  • (String) 


2394
2395
2396
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2394

def format
  @format
end

#name ⇒ String

Output only. The full name of the VolumeBackup resource. Format: projects/*/ locations/*/backupPlans/*/backups/*/volumeBackups/*. Corresponds to the JSON property name

Returns:

  • (String) 


2400
2401
2402
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2400

def name
  @name
end

#source_pvc ⇒ Google::Apis::GkebackupV1::NamespacedName

A reference to a namespaced resource in Kubernetes. Corresponds to the JSON property sourcePvc

Returns:



2405
2406
2407
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2405

def source_pvc
  @source_pvc
end

#state ⇒ String

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

Returns:

  • (String) 


2410
2411
2412
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2410

def state
  @state
end

#state_message ⇒ String

Output only. A human readable message explaining why the VolumeBackup is in its current state. Corresponds to the JSON property stateMessage

Returns:

  • (String) 


2416
2417
2418
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2416

def state_message
  @state_message
end

#storage_bytes ⇒ Fixnum

Output only. The aggregate size of the underlying artifacts associated with this VolumeBackup in the backup storage. This may change over time when multiple backups of the same volume share the same backup storage location. In particular, this is likely to increase in size when the immediately preceding backup of the same volume is deleted. Corresponds to the JSON property storageBytes

Returns:

  • (Fixnum) 


2425
2426
2427
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2425

def storage_bytes
  @storage_bytes
end

#uid ⇒ String

Output only. Server generated global unique identifier of UUID format. Corresponds to the JSON property uid

Returns:

  • (String) 


2431
2432
2433
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2431

def uid
  @uid
end

#update_time ⇒ String

Output only. The timestamp when this VolumeBackup resource was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2436
2437
2438
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2436

def update_time
  @update_time
end

#volume_backup_handle ⇒ String

Output only. A storage system-specific opaque handle to the underlying volume backup. Corresponds to the JSON property volumeBackupHandle

Returns:

  • (String) 


2442
2443
2444
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2442

def volume_backup_handle
  @volume_backup_handle
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2449

def update!(**args)
  @complete_time = args[:complete_time] if args.key?(:complete_time)
  @create_time = args[:create_time] if args.key?(:create_time)
  @disk_size_bytes = args[:disk_size_bytes] if args.key?(:disk_size_bytes)
  @etag = args[:etag] if args.key?(:etag)
  @format = args[:format] if args.key?(:format)
  @name = args[:name] if args.key?(:name)
  @source_pvc = args[:source_pvc] if args.key?(:source_pvc)
  @state = args[:state] if args.key?(:state)
  @state_message = args[:state_message] if args.key?(:state_message)
  @storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
  @volume_backup_handle = args[:volume_backup_handle] if args.key?(:volume_backup_handle)
end