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.



1168
1169
1170
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1168

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


1082
1083
1084
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1082

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) 


1087
1088
1089
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1087

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) 


1093
1094
1095
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1093

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) 


1098
1099
1100
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1098

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) 


1103
1104
1105
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1103

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) 


1110
1111
1112
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1110

def description
  @description
end

#effective_time ⇒ String

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

Returns:

  • (String) 


1115
1116
1117
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1115

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) 


1121
1122
1123
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1121

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) 


1127
1128
1129
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1127

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


1133
1134
1135
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1133

def labels
  @labels
end

#name ⇒ String

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

Returns:

  • (String) 


1138
1139
1140
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1138

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) 


1145
1146
1147
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1145

def 
  @service_account
end

#state ⇒ String

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

Returns:

  • (String) 


1150
1151
1152
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1150

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) 


1155
1156
1157
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1155

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) 


1161
1162
1163
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1161

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


1166
1167
1168
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1166

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1173

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