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.



2643
2644
2645
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2643

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) 


2567
2568
2569
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2567

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) 


2572
2573
2574
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2572

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) 


2578
2579
2580
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2578

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) 


2587
2588
2589
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2587

def etag
  @etag
end

#format ⇒ String

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

Returns:

  • (String) 


2592
2593
2594
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2592

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) 


2598
2599
2600
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2598

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:



2603
2604
2605
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2603

def source_pvc
  @source_pvc
end

#state ⇒ String

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

Returns:

  • (String) 


2608
2609
2610
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2608

def state
  @state
end

#state_message ⇒ String

Output only. A human readable message explaining why the VolumeBackup is in its current state. This field is only meant for human consumption and should not be used programmatically as this field is not guaranteed to be consistent. Corresponds to the JSON property stateMessage

Returns:

  • (String) 


2615
2616
2617
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2615

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) 


2624
2625
2626
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2624

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) 


2630
2631
2632
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2630

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) 


2635
2636
2637
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2635

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) 


2641
2642
2643
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2641

def volume_backup_handle
  @volume_backup_handle
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 2648

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