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.



1157
1158
1159
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1157

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

Instance Attribute Details

#access_restriction ⇒ String

Optional. Note: This field is added for future use case and will not be supported in the current release. Optional. Access restriction for the backup vault. Default value is WITHIN_ORGANIZATION if not provided during creation. Corresponds to the JSON property accessRestriction

Returns:

  • (String) 


1068
1069
1070
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1068

def access_restriction
  @access_restriction
end

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


1074
1075
1076
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1074

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) 


1079
1080
1081
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1079

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) 


1085
1086
1087
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1085

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) 


1090
1091
1092
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1090

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) 


1095
1096
1097
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1095

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) 


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

def description
  @description
end

#effective_time ⇒ String

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

Returns:

  • (String) 


1107
1108
1109
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1107

def effective_time
  @effective_time
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) 


1113
1114
1115
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1113

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


1119
1120
1121
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1119

def labels
  @labels
end

#name ⇒ String

Output only. Identifier. Name of the backup vault to create. It must have the format"projects/project/locations/location/backupVaults/backupvault". backupvault`cannot be changed after creation. It must be between 3-63 characters long and must be unique within the project and location. Corresponds to the JSON propertyname`

Returns:

  • (String) 


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

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) 


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

def 
  @service_account
end

#state ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

def uid
  @uid
end

#update_time ⇒ String

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

Returns:

  • (String) 


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

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
 
# File 'lib/google/apis/backupdr_v1/classes.rb', line 1162

def update!(**args)
  @access_restriction = args[:access_restriction] if args.key?(:access_restriction)
  @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)
  @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