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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Snapshot

Returns a new instance of Snapshot.



62942
62943
62944
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62942

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

Instance Attribute Details

#architecture ⇒ String

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

Returns:

  • (String) 


62642
62643
62644
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62642

def architecture
  @architecture
end

#auto_created ⇒ Boolean Also known as: auto_created?

Output only. [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) 


62649
62650
62651
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62649

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) 


62660
62661
62662
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62660

def chain_name
  @chain_name
end

#creation_size_bytes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


62665
62666
62667
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62665

def creation_size_bytes
  @creation_size_bytes
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


62671
62672
62673
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62671

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) 


62677
62678
62679
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62677

def description
  @description
end

#disk_size_gb ⇒ Fixnum

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

Returns:

  • (Fixnum) 


62682
62683
62684
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62682

def disk_size_gb
  @disk_size_gb
end

#download_bytes ⇒ Fixnum

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

Returns:

  • (Fixnum) 


62688
62689
62690
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62688

def download_bytes
  @download_bytes
end

#enable_confidential_compute ⇒ Boolean Also known as: enable_confidential_compute?

Output only. 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) 


62695
62696
62697
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62695

def enable_confidential_compute
  @enable_confidential_compute
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. Corresponds to the JSON property guestFlush

Returns:

  • (Boolean) 


62702
62703
62704
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62702

def guest_flush
  @guest_flush
end

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

Output only. [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:



62712
62713
62714
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62712

def guest_os_features
  @guest_os_features
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


62719
62720
62721
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62719

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


62725
62726
62727
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62725

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


62738
62739
62740
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62738

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


62745
62746
62747
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62745

def labels
  @labels
end

#license_codes ⇒ Array<Fixnum>

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

Returns:

  • (Array<Fixnum>) 


62752
62753
62754
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62752

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

Output only. [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>) 


62760
62761
62762
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62760

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) 


62767
62768
62769
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62767

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


62778
62779
62780
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62778

def name
  @name
end

#params ⇒ Google::Apis::ComputeBeta::SnapshotParams

Additional snapshot params. Corresponds to the JSON property params

Returns:



62783
62784
62785
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62783

def params
  @params
end

#region ⇒ String

Output only. [Output Only] URL of the region where the snapshot resides. Only applicable for regional snapshots. Corresponds to the JSON property region

Returns:

  • (String) 


62790
62791
62792
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62790

def region
  @region
end

#satisfies_pzi ⇒ Boolean Also known as: satisfies_pzi?

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

Returns:

  • (Boolean) 


62795
62796
62797
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62795

def satisfies_pzi
  @satisfies_pzi
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


62801
62802
62803
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62801

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

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

Returns:

  • (String) 


62807
62808
62809
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62807

def self_link
  @self_link
end

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

Encrypts the snapshot using acustomer-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:



62822
62823
62824
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62822

def snapshot_encryption_key
  @snapshot_encryption_key
end

#snapshot_group_id ⇒ String

Output only. [Output Only] The unique ID of the snapshot group that this snapshot belongs to. The usage of snapshot group feature is restricted. Corresponds to the JSON property snapshotGroupId

Returns:

  • (String) 


62829
62830
62831
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62829

def snapshot_group_id
  @snapshot_group_id
end

#snapshot_group_name ⇒ String

Output only. [Output only] The snapshot group that this snapshot belongs to. The usage of snapshot group feature is restricted. Corresponds to the JSON property snapshotGroupName

Returns:

  • (String) 


62836
62837
62838
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62836

def snapshot_group_name
  @snapshot_group_name
end

#snapshot_type ⇒ String

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

Returns:

  • (String) 


62841
62842
62843
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62841

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) 


62846
62847
62848
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62846

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:



62853
62854
62855
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62853

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) 


62859
62860
62861
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62859

def source_disk_for_recovery_checkpoint
  @source_disk_for_recovery_checkpoint
end

#source_disk_id ⇒ String

Output only. [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) 


62867
62868
62869
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62867

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:

Returns:

  • (String) 


62880
62881
62882
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62880

def source_instant_snapshot
  @source_instant_snapshot
end

#source_instant_snapshot_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

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

Returns:



62886
62887
62888
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62886

def source_instant_snapshot_encryption_key
  @source_instant_snapshot_encryption_key
end

#source_instant_snapshot_id ⇒ String

Output only. [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 snapshot. For example, if you created the snapshot 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) 


62897
62898
62899
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62897

def source_instant_snapshot_id
  @source_instant_snapshot_id
end

#source_snapshot_schedule_policy ⇒ String

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

Returns:

  • (String) 


62903
62904
62905
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62903

def source_snapshot_schedule_policy
  @source_snapshot_schedule_policy
end

#source_snapshot_schedule_policy_id ⇒ String

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

Returns:

  • (String) 


62909
62910
62911
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62909

def source_snapshot_schedule_policy_id
  @source_snapshot_schedule_policy_id
end

#status ⇒ String

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

Returns:

  • (String) 


62915
62916
62917
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62915

def status
  @status
end

#storage_bytes ⇒ Fixnum

Output only. [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) 


62923
62924
62925
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62923

def storage_bytes
  @storage_bytes
end

#storage_bytes_status ⇒ String

Output only. [Deprecated] Instead, check the storageBytes field. After snapshot creation, the storageBytesStatus field is alwaysUP_TO_DATE. [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 unset, meaning the snapshot is being created, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Corresponds to the JSON property storageBytesStatus

Returns:

  • (String) 


62934
62935
62936
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62934

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


62940
62941
62942
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62940

def storage_locations
  @storage_locations
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



62947
62948
62949
62950
62951
62952
62953
62954
62955
62956
62957
62958
62959
62960
62961
62962
62963
62964
62965
62966
62967
62968
62969
62970
62971
62972
62973
62974
62975
62976
62977
62978
62979
62980
62981
62982
62983
62984
62985
62986
62987
62988
62989
 
# File 'lib/google/apis/compute_beta/classes.rb', line 62947

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_flush = args[:guest_flush] if args.key?(:guest_flush)
  @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)
  @params = args[:params] if args.key?(:params)
  @region = args[:region] if args.key?(:region)
  @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_group_id = args[:snapshot_group_id] if args.key?(:snapshot_group_id)
  @snapshot_group_name = args[:snapshot_group_name] if args.key?(:snapshot_group_name)
  @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