Class: Google::Apis::AlloydbV1::Backup

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

Overview

Message describing Backup object

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Backup

Returns a new instance of Backup.



298
299
300
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 298

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

Instance Attribute Details

#annotations ⇒ Hash<String,String>

Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128 Corresponds to the JSON property annotations

Returns:

  • (Hash<String,String>) 


153
154
155
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 153

def annotations
  @annotations
end

#cluster_name ⇒ String

Required. The full resource name of the backup source cluster (e.g., projects/ project/locations/region/clusters/cluster_id). Corresponds to the JSON property clusterName

Returns:

  • (String) 


159
160
161
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 159

def cluster_name
  @cluster_name
end

#cluster_uid ⇒ String

Output only. The system-generated UID of the cluster which was used to create this resource. Corresponds to the JSON property clusterUid

Returns:

  • (String) 


165
166
167
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 165

def cluster_uid
  @cluster_uid
end

#create_completion_time ⇒ String

Output only. Timestamp when the resource finished being created. Corresponds to the JSON property createCompletionTime

Returns:

  • (String) 


170
171
172
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 170

def create_completion_time
  @create_completion_time
end

#create_time ⇒ String

Output only. Create time stamp Corresponds to the JSON property createTime

Returns:

  • (String) 


175
176
177
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 175

def create_time
  @create_time
end

#database_version ⇒ String

Output only. The database engine major version of the cluster this backup was created from. Any restored cluster created from this backup will have the same database version. Corresponds to the JSON property databaseVersion

Returns:

  • (String) 


182
183
184
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 182

def database_version
  @database_version
end

#delete_time ⇒ String

Output only. Delete time stamp Corresponds to the JSON property deleteTime

Returns:

  • (String) 


187
188
189
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 187

def delete_time
  @delete_time
end

#description ⇒ String

User-provided description of the backup. Corresponds to the JSON property description

Returns:

  • (String) 


192
193
194
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 192

def description
  @description
end

#display_name ⇒ String

User-settable and human-readable display name for the Backup. Corresponds to the JSON property displayName

Returns:

  • (String) 


197
198
199
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 197

def display_name
  @display_name
end

#encryption_config ⇒ Google::Apis::AlloydbV1::EncryptionConfig

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key). Corresponds to the JSON property encryptionConfig

Returns:



203
204
205
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 203

def encryption_config
  @encryption_config
end

#encryption_info ⇒ Google::Apis::AlloydbV1::EncryptionInfo

EncryptionInfo describes the encryption information of a cluster or a backup. Corresponds to the JSON property encryptionInfo

Returns:



208
209
210
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 208

def encryption_info
  @encryption_info
end

#etag ⇒ String

For Resource freshness validation (https://google.aip.dev/154) Corresponds to the JSON property etag

Returns:

  • (String) 


213
214
215
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 213

def etag
  @etag
end

#expiry_quantity ⇒ Google::Apis::AlloydbV1::QuantityBasedExpiry

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup' s retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected. Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention). Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3) Corresponds to the JSON property expiryQuantity

Returns:



224
225
226
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 224

def expiry_quantity
  @expiry_quantity
end

#expiry_time ⇒ String

Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time. Corresponds to the JSON property expiryTime

Returns:

  • (String) 


231
232
233
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 231

def expiry_time
  @expiry_time
end

#labels ⇒ Hash<String,String>

Labels as key value pairs Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


236
237
238
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 236

def labels
  @labels
end

#name ⇒ String

Output only. The name of the backup resource with the format: * projects/ project/locations/region/backups/backup_id where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]0,61[a-z0-9]) ?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https:/ /google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/project/locations/region Corresponds to the JSON property name

Returns:

  • (String) 


247
248
249
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 247

def name
  @name
end

#reconciling ⇒ Boolean Also known as: reconciling?

Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance. Corresponds to the JSON property reconciling

Returns:

  • (Boolean) 


254
255
256
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 254

def reconciling
  @reconciling
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

Output only. Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


260
261
262
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 260

def satisfies_pzs
  @satisfies_pzs
end

#size_bytes ⇒ Fixnum

Output only. The size of the backup in bytes. Corresponds to the JSON property sizeBytes

Returns:

  • (Fixnum) 


266
267
268
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 266

def size_bytes
  @size_bytes
end

#state ⇒ String

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

Returns:

  • (String) 


271
272
273
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 271

def state
  @state
end

#tags ⇒ Hash<String,String>

Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": " marketing" Corresponds to the JSON property tags

Returns:

  • (Hash<String,String>) 


278
279
280
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 278

def tags
  @tags
end

#type ⇒ String

The backup type, which suggests the trigger for the backup. Corresponds to the JSON property type

Returns:

  • (String) 


283
284
285
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 283

def type
  @type
end

#uid ⇒ String

Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted. Corresponds to the JSON property uid

Returns:

  • (String) 


289
290
291
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 289

def uid
  @uid
end

#update_time ⇒ String

Output only. Update time stamp Users should not infer any meaning from this field. Its value is generally unrelated to the timing of the backup creation operation. Corresponds to the JSON property updateTime

Returns:

  • (String) 


296
297
298
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 296

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/google/apis/alloydb_v1/classes.rb', line 303

def update!(**args)
  @annotations = args[:annotations] if args.key?(:annotations)
  @cluster_name = args[:cluster_name] if args.key?(:cluster_name)
  @cluster_uid = args[:cluster_uid] if args.key?(:cluster_uid)
  @create_completion_time = args[:create_completion_time] if args.key?(:create_completion_time)
  @create_time = args[:create_time] if args.key?(:create_time)
  @database_version = args[:database_version] if args.key?(:database_version)
  @delete_time = args[:delete_time] if args.key?(:delete_time)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @encryption_config = args[:encryption_config] if args.key?(:encryption_config)
  @encryption_info = args[:encryption_info] if args.key?(:encryption_info)
  @etag = args[:etag] if args.key?(:etag)
  @expiry_quantity = args[:expiry_quantity] if args.key?(:expiry_quantity)
  @expiry_time = args[:expiry_time] if args.key?(:expiry_time)
  @labels = args[:labels] if args.key?(:labels)
  @name = args[:name] if args.key?(:name)
  @reconciling = args[:reconciling] if args.key?(:reconciling)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @size_bytes = args[:size_bytes] if args.key?(:size_bytes)
  @state = args[:state] if args.key?(:state)
  @tags = args[:tags] if args.key?(:tags)
  @type = args[:type] if args.key?(:type)
  @uid = args[:uid] if args.key?(:uid)
  @update_time = args[:update_time] if args.key?(:update_time)
end