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_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.
-
#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.
-
#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_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_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.
39466 39467 39468 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39466 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
39241 39242 39243 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39241 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
39247 39248 39249 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39247 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
39258 39259 39260 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39258 def chain_name @chain_name end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
39263 39264 39265 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39263 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
39269 39270 39271 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39269 def description @description end |
#disk_size_gb ⇒ Fixnum
[Output Only] Size of the source disk, specified in GB.
Corresponds to the JSON property diskSizeGb
39274 39275 39276 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39274 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
39279 39280 39281 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39279 def download_bytes @download_bytes 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
39285 39286 39287 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39285 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
39293 39294 39295 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39293 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
39299 39300 39301 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39299 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#snapshot for Snapshot
resources.
Corresponds to the JSON property kind
39305 39306 39307 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39305 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.
39317 39318 39319 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39317 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
39323 39324 39325 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39323 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
39329 39330 39331 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39329 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
39336 39337 39338 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39336 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
39342 39343 39344 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39342 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
39352 39353 39354 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39352 def name @name end |
#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?
[Output Only] Reserved for future use.
Corresponds to the JSON property satisfiesPzs
39357 39358 39359 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39357 def satisfies_pzs @satisfies_pzs end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
39363 39364 39365 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39363 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
39368 39369 39370 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39368 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
39380 39381 39382 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39380 def snapshot_encryption_key @snapshot_encryption_key end |
#snapshot_type ⇒ String
Indicates the type of the snapshot.
Corresponds to the JSON property snapshotType
39385 39386 39387 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39385 def snapshot_type @snapshot_type end |
#source_disk ⇒ String
The source disk used to create this snapshot.
Corresponds to the JSON property sourceDisk
39390 39391 39392 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39390 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
39396 39397 39398 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39396 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
39403 39404 39405 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39403 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
39412 39413 39414 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39412 def source_instant_snapshot @source_instant_snapshot 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
39422 39423 39424 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39422 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
39427 39428 39429 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39427 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
39432 39433 39434 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39432 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
39438 39439 39440 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39438 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
39444 39445 39446 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39444 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
39452 39453 39454 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39452 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
39458 39459 39460 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39458 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
39464 39465 39466 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39464 def user_licenses @user_licenses end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
39471 39472 39473 39474 39475 39476 39477 39478 39479 39480 39481 39482 39483 39484 39485 39486 39487 39488 39489 39490 39491 39492 39493 39494 39495 39496 39497 39498 39499 39500 39501 39502 39503 39504 39505 39506 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 39471 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_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) @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) @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_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_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 |