Class: Google::Apis::ComputeBeta::Snapshot

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/representations.rb

Overview

Represents a Persistent Disk Snapshot resource. You can use snapshots to back up data on a regular interval. For more information, read Creating persistent disk snapshots. (== resource_for $ api_version.snapshots ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Snapshot

Returns a new instance of Snapshot.



30292
30293
30294
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30292

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

Instance Attribute Details

#auto_created ⇒ Boolean Also known as: auto_created?

[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. Corresponds to the JSON property autoCreated

Returns:

  • (Boolean) 


30134
30135
30136
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30134

def auto_created
  @auto_created
end

#chain_name ⇒ String

Creates the new snapshot in the snapshot chain labeled with the specified name. The chain name must be 1-63 characters long and comply with RFC1035. This is an uncommon option only for advanced service owners who needs to create separate snapshot chains, for example, for chargeback tracking. When you describe your snapshot resource, this field is visible only if it has a non- empty value. Corresponds to the JSON property chainName

Returns:

  • (String) 


30145
30146
30147
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30145

def chain_name
  @chain_name
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


30150
30151
30152
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30150

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


30156
30157
30158
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30156

def description
  @description
end

#disk_size_gb ⇒ Fixnum

[Output Only] Size of the source disk, specified in GB. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


30161
30162
30163
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30161

def disk_size_gb
  @disk_size_gb
end

#download_bytes ⇒ Fixnum

[Output Only] Number of bytes downloaded to restore a snapshot to a disk. Corresponds to the JSON property downloadBytes

Returns:

  • (Fixnum) 


30166
30167
30168
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30166

def download_bytes
  @download_bytes
end

#guest_flush ⇒ Boolean Also known as: guest_flush?

[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process. Currently only supported on Windows instances using the Volume Shadow Copy Service (VSS). Corresponds to the JSON property guestFlush

Returns:

  • (Boolean) 


30173
30174
30175
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30173

def guest_flush
  @guest_flush
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


30180
30181
30182
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30180

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. Corresponds to the JSON property kind

Returns:

  • (String) 


30186
30187
30188
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30186

def kind
  @kind
end

#label_fingerprint ⇒ String

A fingerprint for the labels being applied to this snapshot, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a snapshot. Corresponds to the JSON property labelFingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


30198
30199
30200
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30198

def label_fingerprint
  @label_fingerprint
end

#labels ⇒ Hash<String,String>

Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


30204
30205
30206
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30204

def labels
  @labels
end

#license_codes ⇒ Array<Fixnum>

[Output Only] Integer license codes indicating which licenses are attached to this snapshot. Corresponds to the JSON property licenseCodes

Returns:

  • (Array<Fixnum>) 


30210
30211
30212
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30210

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

[Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image). Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


30217
30218
30219
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30217

def licenses
  @licenses
end

#name ⇒ String

Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a- z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String) 


30227
30228
30229
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30227

def name
  @name
end

#self_link ⇒ String

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


30232
30233
30234
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30232

def self_link
  @self_link
end

#snapshot_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

Encrypts the snapshot using a customer-supplied encryption key. After you encrypt a snapshot using a customer-supplied key, you must provide the same key if you use the snapshot later. For example, you must provide the encryption key when you create a disk from the encrypted snapshot in a future request. Customer-supplied encryption keys do not protect access to metadata of the snapshot. If you do not provide an encryption key when creating the snapshot, then the snapshot will be encrypted using an automatically generated key and you do not need to provide a key to use the snapshot later. Corresponds to the JSON property snapshotEncryptionKey

Returns:



30246
30247
30248
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30246

def snapshot_encryption_key
  @snapshot_encryption_key
end

#source_disk ⇒ String

The source disk used to create this snapshot. Corresponds to the JSON property sourceDisk

Returns:

  • (String) 


30251
30252
30253
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30251

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. Corresponds to the JSON property sourceDiskEncryptionKey

Returns:



30257
30258
30259
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30257

def source_disk_encryption_key
  @source_disk_encryption_key
end

#source_disk_id ⇒ String

[Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name. Corresponds to the JSON property sourceDiskId

Returns:

  • (String) 


30264
30265
30266
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30264

def source_disk_id
  @source_disk_id
end

#status ⇒ String

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Corresponds to the JSON property status

Returns:

  • (String) 


30270
30271
30272
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30270

def status
  @status
end

#storage_bytes ⇒ Fixnum

[Output Only] A size of the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion. Corresponds to the JSON property storageBytes

Returns:

  • (Fixnum) 


30276
30277
30278
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30276

def storage_bytes
  @storage_bytes
end

#storage_bytes_status ⇒ String

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Corresponds to the JSON property storageBytesStatus

Returns:

  • (String) 


30284
30285
30286
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30284

def storage_bytes_status
  @storage_bytes_status
end

#storage_locations ⇒ Array<String>

Cloud Storage bucket storage location of the snapshot (regional or multi- regional). Corresponds to the JSON property storageLocations

Returns:

  • (Array<String>) 


30290
30291
30292
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30290

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



30297
30298
30299
30300
30301
30302
30303
30304
30305
30306
30307
30308
30309
30310
30311
30312
30313
30314
30315
30316
30317
30318
30319
30320
30321
 
# File 'generated/google/apis/compute_beta/classes.rb', line 30297

def update!(**args)
  @auto_created = args[:auto_created] if args.key?(:auto_created)
  @chain_name = args[:chain_name] if args.key?(:chain_name)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @download_bytes = args[:download_bytes] if args.key?(:download_bytes)
  @guest_flush = args[:guest_flush] if args.key?(:guest_flush)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint)
  @labels = args[:labels] if args.key?(:labels)
  @license_codes = args[:license_codes] if args.key?(:license_codes)
  @licenses = args[:licenses] if args.key?(:licenses)
  @name = args[:name] if args.key?(:name)
  @self_link = args[:self_link] if args.key?(:self_link)
  @snapshot_encryption_key = args[:snapshot_encryption_key] if args.key?(:snapshot_encryption_key)
  @source_disk = args[:source_disk] if args.key?(:source_disk)
  @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key)
  @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
  @status = args[:status] if args.key?(:status)
  @storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes)
  @storage_bytes_status = args[:storage_bytes_status] if args.key?(:storage_bytes_status)
  @storage_locations = args[:storage_locations] if args.key?(:storage_locations)
end