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. Next id: 14

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ VolumeBackup

Returns a new instance of VolumeBackup.



1953
1954
1955
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1953

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) 


1878
1879
1880
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1878

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) 


1883
1884
1885
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1883

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) 


1889
1890
1891
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1889

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) 


1898
1899
1900
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1898

def etag
  @etag
end

#format ⇒ String

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

Returns:

  • (String) 


1903
1904
1905
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1903

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) 


1909
1910
1911
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1909

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:



1914
1915
1916
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1914

def source_pvc
  @source_pvc
end

#state ⇒ String

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

Returns:

  • (String) 


1919
1920
1921
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1919

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) 


1925
1926
1927
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1925

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) 


1934
1935
1936
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1934

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) 


1940
1941
1942
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1940

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) 


1945
1946
1947
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1945

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) 


1951
1952
1953
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1951

def volume_backup_handle
  @volume_backup_handle
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
 
# File 'lib/google/apis/gkebackup_v1/classes.rb', line 1958

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