Class: Google::Apis::ComputeAlpha::Snapshot
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Snapshot
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
A persistent disk snapshot resource. (== resource_for beta.snapshots ==) (== resource_for v1.snapshots ==)
Instance Attribute Summary collapse
-
#auto_created ⇒ Boolean
(also: #auto_created?)
[Output Only] Set to true if snapshots are autoamtically by applying resource policy on the target disk.
-
#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 snapshot, specified in GB.
-
#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.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
snapshotEncryptionKey
. -
#source_disk ⇒ String
[Output Only] The source disk used to create this snapshot.
-
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceDiskEncryptionKey
. -
#source_disk_id ⇒ String
[Output Only] The ID value of the disk used to create this 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>
GCS bucket storage location of the snapshot (regional or multi-regional).
Instance Method Summary collapse
-
#initialize(**args) ⇒ Snapshot
constructor
A new instance of Snapshot.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Snapshot
Returns a new instance of Snapshot
22787 22788 22789 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22787 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 autoamtically by applying resource
policy on the target disk.
Corresponds to the JSON property autoCreated
22657 22658 22659 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22657 def auto_created @auto_created end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
22663 22664 22665 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22663 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
22669 22670 22671 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22669 def description @description end |
#disk_size_gb ⇒ Fixnum
[Output Only] Size of the snapshot, specified in GB.
Corresponds to the JSON property diskSizeGb
22674 22675 22676 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22674 def disk_size_gb @disk_size_gb 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
22681 22682 22683 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22681 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
22687 22688 22689 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22687 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#snapshot for Snapshot
resources.
Corresponds to the JSON property kind
22693 22694 22695 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22693 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.
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.
22704 22705 22706 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22704 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
22710 22711 22712 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22710 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
22716 22717 22718 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22716 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
22723 22724 22725 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22723 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
22733 22734 22735 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22733 def name @name end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
22738 22739 22740 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22738 def self_link @self_link end |
#snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property snapshotEncryptionKey
22743 22744 22745 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22743 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
22748 22749 22750 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22748 def source_disk @source_disk end |
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceDiskEncryptionKey
22753 22754 22755 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22753 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
22760 22761 22762 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22760 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
22766 22767 22768 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22766 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
22772 22773 22774 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22772 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
22780 22781 22782 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22780 def storage_bytes_status @storage_bytes_status end |
#storage_locations ⇒ Array<String>
GCS bucket storage location of the snapshot (regional or multi-regional).
Corresponds to the JSON property storageLocations
22785 22786 22787 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22785 def storage_locations @storage_locations end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
22792 22793 22794 22795 22796 22797 22798 22799 22800 22801 22802 22803 22804 22805 22806 22807 22808 22809 22810 22811 22812 22813 22814 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 22792 def update!(**args) @auto_created = args[:auto_created] if args.key?(:auto_created) @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) @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) @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 |