Class: Google::Apis::ComputeAlpha::Snapshot
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Snapshot
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/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
-
#architecture ⇒ String
[Output Only] The architecture of the snapshot.
-
#auto_created ⇒ Boolean
(also: #auto_created?)
[Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
-
#chain_name ⇒ String
Creates the new snapshot in the snapshot chain labeled with the specified name.
-
#creation_size_bytes ⇒ Fixnum
[Output Only] Size in bytes of the snapshot at creation time.
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#disk_size_gb ⇒ Fixnum
[Output Only] Size of the source disk, specified in GB.
-
#download_bytes ⇒ Fixnum
[Output Only] Number of bytes downloaded to restore a snapshot to a disk.
-
#enable_confidential_compute ⇒ Boolean
(also: #enable_confidential_compute?)
Whether this snapshot is created from a confidential compute mode disk.
-
#guest_flush ⇒ Boolean
(also: #guest_flush?)
[Input Only] Whether to attempt an application consistent snapshot by informing the OS to prepare for the snapshot process.
-
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>
[Output Only] A list of features to enable on the guest operating system.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#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.
-
#labels ⇒ Hash<String,String>
Labels to apply to this snapshot.
-
#license_codes ⇒ Array<Fixnum>
[Output Only] Integer license codes indicating which licenses are attached to this snapshot.
-
#licenses ⇒ Array<String>
[Output Only] A list of public visible licenses that apply to this snapshot.
-
#location_hint ⇒ String
An opaque location hint used to place the snapshot close to other resources.
-
#max_retention_days ⇒ Fixnum
Number of days the snapshot should be retained before being deleted automatically.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#satisfies_pzs ⇒ Boolean
(also: #satisfies_pzs?)
[Output Only] Reserved for future use.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource's resource id.
-
#snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Encrypts the snapshot using a customer-supplied encryption key.
-
#snapshot_type ⇒ String
Indicates the type of the snapshot.
-
#source_disk ⇒ String
The source disk used to create this snapshot.
-
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source disk.
-
#source_disk_for_recovery_checkpoint ⇒ String
The source disk whose recovery checkpoint will be used to create this snapshot.
-
#source_disk_id ⇒ String
[Output Only] The ID value of the disk used to create this snapshot.
-
#source_instant_snapshot ⇒ String
The source instant snapshot used to create this snapshot.
-
#source_instant_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Customer provided encryption key when creating Snapshot from Instant Snapshot.
-
#source_instant_snapshot_id ⇒ String
[Output Only] The unique ID of the instant snapshot used to create this snapshot.
-
#source_snapshot_schedule_policy ⇒ String
[Output Only] URL of the resource policy which created this scheduled snapshot.
-
#source_snapshot_schedule_policy_id ⇒ String
[Output Only] ID of the resource policy which created this scheduled snapshot.
-
#status ⇒ String
[Output Only] The status of the snapshot.
-
#storage_bytes ⇒ Fixnum
[Output Only] A size of the storage used by the snapshot.
-
#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.
-
#storage_locations ⇒ Array<String>
Cloud Storage bucket storage location of the snapshot (regional or multi- regional).
-
#user_licenses ⇒ Array<String>
[Output Only] A list of user provided licenses represented by a list of URLs to the license resource.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Snapshot
constructor
A new instance of Snapshot.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Snapshot
Returns a new instance of Snapshot.
44827 44828 44829 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44827 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
44574 44575 44576 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44574 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
44580 44581 44582 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44580 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
44591 44592 44593 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44591 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
44596 44597 44598 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44596 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
44601 44602 44603 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44601 def @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
44607 44608 44609 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44607 def description @description end |
#disk_size_gb ⇒ Fixnum
[Output Only] Size of the source disk, specified in GB.
Corresponds to the JSON property diskSizeGb
44612 44613 44614 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44612 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
44617 44618 44619 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44617 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
44623 44624 44625 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44623 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
44630 44631 44632 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44630 def guest_flush @guest_flush end |
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::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
44638 44639 44640 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44638 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
44644 44645 44646 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44644 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#snapshot for Snapshot
resources.
Corresponds to the JSON property kind
44650 44651 44652 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44650 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.
44662 44663 44664 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44662 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
44668 44669 44670 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44668 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
44674 44675 44676 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44674 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
44681 44682 44683 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44681 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
44687 44688 44689 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44687 def location_hint @location_hint end |
#max_retention_days ⇒ Fixnum
Number of days the snapshot should be retained before being deleted
automatically.
Corresponds to the JSON property maxRetentionDays
44693 44694 44695 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44693 def max_retention_days @max_retention_days 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
44703 44704 44705 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44703 def name @name end |
#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?
[Output Only] Reserved for future use.
Corresponds to the JSON property satisfiesPzs
44708 44709 44710 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44708 def satisfies_pzs @satisfies_pzs end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
44714 44715 44716 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44714 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource's resource id.
Corresponds to the JSON property selfLinkWithId
44719 44720 44721 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44719 def self_link_with_id @self_link_with_id end |
#snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::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
44731 44732 44733 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44731 def snapshot_encryption_key @snapshot_encryption_key end |
#snapshot_type ⇒ String
Indicates the type of the snapshot.
Corresponds to the JSON property snapshotType
44736 44737 44738 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44736 def snapshot_type @snapshot_type end |
#source_disk ⇒ String
The source disk used to create this snapshot.
Corresponds to the JSON property sourceDisk
44741 44742 44743 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44741 def source_disk @source_disk end |
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::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
44747 44748 44749 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44747 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
44752 44753 44754 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44752 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
44759 44760 44761 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44759 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
44768 44769 44770 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44768 def source_instant_snapshot @source_instant_snapshot end |
#source_instant_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Customer provided encryption key when creating Snapshot from Instant Snapshot.
Corresponds to the JSON property sourceInstantSnapshotEncryptionKey
44773 44774 44775 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44773 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
44783 44784 44785 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44783 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
44788 44789 44790 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44788 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
44793 44794 44795 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44793 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
44799 44800 44801 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44799 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
44805 44806 44807 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44805 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
44813 44814 44815 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44813 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
44819 44820 44821 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44819 def storage_locations @storage_locations end |
#user_licenses ⇒ Array<String>
[Output Only] A list of user provided licenses represented by a list of URLs
to the license resource.
Corresponds to the JSON property userLicenses
44825 44826 44827 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44825 def user_licenses @user_licenses end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
44832 44833 44834 44835 44836 44837 44838 44839 44840 44841 44842 44843 44844 44845 44846 44847 44848 44849 44850 44851 44852 44853 44854 44855 44856 44857 44858 44859 44860 44861 44862 44863 44864 44865 44866 44867 44868 44869 44870 44871 44872 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 44832 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) @max_retention_days = args[:max_retention_days] if args.key?(:max_retention_days) @name = args[:name] if args.key?(:name) @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @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) @user_licenses = args[:user_licenses] if args.key?(:user_licenses) end |