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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Snapshot

Returns a new instance of Snapshot.



38818
38819
38820
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38818

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

Instance Attribute Details

#architecture ⇒ String

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Corresponds to the JSON property architecture

Returns:

  • (String) 


38583
38584
38585
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38583

def architecture
  @architecture
end

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


38589
38590
38591
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38589

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) 


38600
38601
38602
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38600

def chain_name
  @chain_name
end

#creation_size_bytes ⇒ Fixnum

[Output Only] Size in bytes of the snapshot at creation time. Corresponds to the JSON property creationSizeBytes

Returns:

  • (Fixnum) 


38605
38606
38607
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38605

def creation_size_bytes
  @creation_size_bytes
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


38610
38611
38612
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38610

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) 


38616
38617
38618
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38616

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) 


38621
38622
38623
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38621

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) 


38626
38627
38628
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38626

def download_bytes
  @download_bytes
end

#enable_confidential_compute ⇒ Boolean Also known as: enable_confidential_compute?

Whether this snapshot is created from a confidential compute mode disk. [ Output Only]: This field is not set by user, but from source disk. Corresponds to the JSON property enableConfidentialCompute

Returns:

  • (Boolean) 


38632
38633
38634
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38632

def enable_confidential_compute
  @enable_confidential_compute
end

#guest_os_features ⇒ Array<Google::Apis::ComputeV1::GuestOsFeature>

[Output Only] A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options. Corresponds to the JSON property guestOsFeatures

Returns:



38640
38641
38642
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38640

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


38646
38647
38648
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38646

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) 


38652
38653
38654
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38652

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) 


38664
38665
38666
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38664

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


38670
38671
38672
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38670

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


38676
38677
38678
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38676

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


38683
38684
38685
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38683

def licenses
  @licenses
end

#location_hint ⇒ String

An opaque location hint used to place the snapshot close to other resources. This field is for use by internal tools that use the public API. Corresponds to the JSON property locationHint

Returns:

  • (String) 


38689
38690
38691
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38689

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


38699
38700
38701
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38699

def name
  @name
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


38704
38705
38706
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38704

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


38710
38711
38712
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38710

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

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

Returns:

  • (String) 


38716
38717
38718
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38716

def self_link
  @self_link
end

#snapshot_encryption_key ⇒ Google::Apis::ComputeV1::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:



38728
38729
38730
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38728

def snapshot_encryption_key
  @snapshot_encryption_key
end

#snapshot_type ⇒ String

Indicates the type of the snapshot. Corresponds to the JSON property snapshotType

Returns:

  • (String) 


38733
38734
38735
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38733

def snapshot_type
  @snapshot_type
end

#source_disk ⇒ String

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

Returns:

  • (String) 


38738
38739
38740
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38738

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeV1::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:



38744
38745
38746
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38744

def source_disk_encryption_key
  @source_disk_encryption_key
end

#source_disk_for_recovery_checkpoint ⇒ String

The source disk whose recovery checkpoint will be used to create this snapshot. Corresponds to the JSON property sourceDiskForRecoveryCheckpoint

Returns:

  • (String) 


38749
38750
38751
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38749

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


38756
38757
38758
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38756

def source_disk_id
  @source_disk_id
end

#source_instant_snapshot ⇒ String

The source instant snapshot used to create this snapshot. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone / instantSnapshots/instantSnapshot - projects/project/zones/zone/ instantSnapshots/instantSnapshot - zones/zone/instantSnapshots/instantSnapshot Corresponds to the JSON property sourceInstantSnapshot

Returns:

  • (String) 


38765
38766
38767
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38765

def source_instant_snapshot
  @source_instant_snapshot
end

#source_instant_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

Customer provided encryption key when creating Snapshot from Instant Snapshot. Corresponds to the JSON property sourceInstantSnapshotEncryptionKey

Returns:



38770
38771
38772
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38770

def source_instant_snapshot_encryption_key
  @source_instant_snapshot_encryption_key
end

#source_instant_snapshot_id ⇒ String

[Output Only] The unique ID of the instant snapshot used to create this snapshot. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact instant snapshot that was used. Corresponds to the JSON property sourceInstantSnapshotId

Returns:

  • (String) 


38780
38781
38782
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38780

def source_instant_snapshot_id
  @source_instant_snapshot_id
end

#source_snapshot_schedule_policy ⇒ String

[Output Only] URL of the resource policy which created this scheduled snapshot. Corresponds to the JSON property sourceSnapshotSchedulePolicy

Returns:

  • (String) 


38785
38786
38787
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38785

def source_snapshot_schedule_policy
  @source_snapshot_schedule_policy
end

#source_snapshot_schedule_policy_id ⇒ String

[Output Only] ID of the resource policy which created this scheduled snapshot. Corresponds to the JSON property sourceSnapshotSchedulePolicyId

Returns:

  • (String) 


38790
38791
38792
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38790

def source_snapshot_schedule_policy_id
  @source_snapshot_schedule_policy_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) 


38796
38797
38798
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38796

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) 


38802
38803
38804
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38802

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) 


38810
38811
38812
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38810

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


38816
38817
38818
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38816

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



38823
38824
38825
38826
38827
38828
38829
38830
38831
38832
38833
38834
38835
38836
38837
38838
38839
38840
38841
38842
38843
38844
38845
38846
38847
38848
38849
38850
38851
38852
38853
38854
38855
38856
38857
38858
38859
38860
 
# File 'lib/google/apis/compute_v1/classes.rb', line 38823

def update!(**args)
  @architecture = args[:architecture] if args.key?(:architecture)
  @auto_created = args[:auto_created] if args.key?(:auto_created)
  @chain_name = args[:chain_name] if args.key?(:chain_name)
  @creation_size_bytes = args[:creation_size_bytes] if args.key?(:creation_size_bytes)
  @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)
  @enable_confidential_compute = args[:enable_confidential_compute] if args.key?(:enable_confidential_compute)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @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)
  @location_hint = args[:location_hint] if args.key?(:location_hint)
  @name = args[:name] if args.key?(:name)
  @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @snapshot_encryption_key = args[:snapshot_encryption_key] if args.key?(:snapshot_encryption_key)
  @snapshot_type = args[:snapshot_type] if args.key?(:snapshot_type)
  @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_for_recovery_checkpoint = args[:source_disk_for_recovery_checkpoint] if args.key?(:source_disk_for_recovery_checkpoint)
  @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
  @source_instant_snapshot = args[:source_instant_snapshot] if args.key?(:source_instant_snapshot)
  @source_instant_snapshot_encryption_key = args[:source_instant_snapshot_encryption_key] if args.key?(:source_instant_snapshot_encryption_key)
  @source_instant_snapshot_id = args[:source_instant_snapshot_id] if args.key?(:source_instant_snapshot_id)
  @source_snapshot_schedule_policy = args[:source_snapshot_schedule_policy] if args.key?(:source_snapshot_schedule_policy)
  @source_snapshot_schedule_policy_id = args[:source_snapshot_schedule_policy_id] if args.key?(:source_snapshot_schedule_policy_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