Class: Google::Apis::ComputeV1::Snapshot

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

Overview

A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Snapshot

Returns a new instance of Snapshot



18379
18380
18381
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18379

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

Instance Attribute Details

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


18266
18267
18268
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18266

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) 


18272
18273
18274
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18272

def description
  @description
end

#disk_size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


18277
18278
18279
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18277

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


18283
18284
18285
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18283

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) 


18289
18290
18291
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18289

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) 


18301
18302
18303
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18301

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


18307
18308
18309
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18307

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


18313
18314
18315
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18313

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


18320
18321
18322
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18320

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) 


18330
18331
18332
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18330

def name
  @name
end

#self_link ⇒ String

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

Returns:

  • (String) 


18335
18336
18337
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18335

def self_link
  @self_link
end

#snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property snapshotEncryptionKey

Returns:



18340
18341
18342
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18340

def snapshot_encryption_key
  @snapshot_encryption_key
end

#source_disk ⇒ String

[Output Only] The source disk used to create this snapshot. Corresponds to the JSON property sourceDisk

Returns:

  • (String) 


18345
18346
18347
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18345

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property sourceDiskEncryptionKey

Returns:



18350
18351
18352
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18350

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) 


18357
18358
18359
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18357

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) 


18363
18364
18365
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18363

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) 


18369
18370
18371
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18369

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) 


18377
18378
18379
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18377

def storage_bytes_status
  @storage_bytes_status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
 
# File 'generated/google/apis/compute_v1/classes.rb', line 18384

def update!(**args)
  @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)
  @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)
end