Class: Google::Apis::BackupdrV1::BackupVault

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

Overview

Message describing a BackupVault object.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BackupVault

Returns a new instance of BackupVault.



813
814
815
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 813

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Optional. User annotations. See https://google.aip.dev/128#annotations Stores small amounts of arbitrary data. Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


727
728
729
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 727

def annotations
  @annotations
end

#backup_count ⇒ Fixnum

Output only. The number of backups in this backup vault. Corresponds to the JSON property backupCount

Returns:

  • (Fixnum) 


732
733
734
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 732

def backup_count
  @backup_count
end

#backup_minimum_enforced_retention_duration ⇒ String

Required. The default and minimum enforced retention for each backup within the backup vault. The enforced retention for each backup can be extended. Corresponds to the JSON property backupMinimumEnforcedRetentionDuration

Returns:

  • (String) 


738
739
740
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 738

def backup_minimum_enforced_retention_duration
  @backup_minimum_enforced_retention_duration
end

#create_time ⇒ String

Output only. The time when the instance was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


743
744
745
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 743

def create_time
  @create_time
end

#deletable ⇒ Boolean Also known as: deletable?

Output only. Set to true when there are no backups nested under this resource. Corresponds to the JSON property deletable

Returns:

  • (Boolean) 


748
749
750
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 748

def deletable
  @deletable
end

#description ⇒ String

Optional. The description of the BackupVault instance (2048 characters or less) . Corresponds to the JSON property description

Returns:

  • (String) 


755
756
757
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 755

def description
  @description
end

#effective_time ⇒ String

Optional. Time after which the BackupVault resource is locked. Corresponds to the JSON property effectiveTime

Returns:

  • (String) 


760
761
762
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 760

def effective_time
  @effective_time
end

#enforced_retention_duration ⇒ String

Required. The default retention period for each backup in the backup vault ( Deprecated). Corresponds to the JSON property enforcedRetentionDuration

Returns:

  • (String) 


766
767
768
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 766

def enforced_retention_duration
  @enforced_retention_duration
end

#etag ⇒ String

Optional. Server specified ETag for the backup vault resource to prevent simultaneous updates from overwiting each other. Corresponds to the JSON property etag

Returns:

  • (String) 


772
773
774
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 772

def etag
  @etag
end

#labels ⇒ Hash<String,String>

Optional. Resource labels to represent user provided metadata. No labels currently defined: Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


778
779
780
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 778

def labels
  @labels
end

#name ⇒ String

Output only. The resource name. Corresponds to the JSON property name

Returns:

  • (String) 


783
784
785
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 783

def name
  @name
end

#service_account ⇒ String

Output only. Service account used by the BackupVault Service for this BackupVault. The user should grant this account permissions in their workload project to enable the service to run backups and restores there. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


790
791
792
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 790

def 
  @service_account
end

#state ⇒ String

Output only. The BackupVault resource instance state. Corresponds to the JSON property state

Returns:

  • (String) 


795
796
797
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 795

def state
  @state
end

#total_stored_bytes ⇒ Fixnum

Output only. Total size of the storage used by all backup resources. Corresponds to the JSON property totalStoredBytes

Returns:

  • (Fixnum) 


800
801
802
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 800

def total_stored_bytes
  @total_stored_bytes
end

#uid ⇒ String

Output only. Output only Immutable after resource creation until resource deletion. Corresponds to the JSON property uid

Returns:

  • (String) 


806
807
808
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 806

def uid
  @uid
end

#update_time ⇒ String

Output only. The time when the instance was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


811
812
813
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 811

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 818

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @backup_count = args[:backup_count] if args.key?(:backup_count)
  @backup_minimum_enforced_retention_duration = args[:backup_minimum_enforced_retention_duration] if args.key?(:backup_minimum_enforced_retention_duration)
  @create_time = args[:create_time] if args.key?(:create_time)
  @deletable = args[:deletable] if args.key?(:deletable)
  @description = args[:description] if args.key?(:description)
  @effective_time = args[:effective_time] if args.key?(:effective_time)
  @enforced_retention_duration = args[:enforced_retention_duration] if args.key?(:enforced_retention_duration)
  @etag = args[:etag] if args.key?(:etag)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @service_account = args[:service_account] if args.key?(:service_account)
  @state = args[:state] if args.key?(:state)
  @total_stored_bytes = args[:total_stored_bytes] if args.key?(:total_stored_bytes)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end