Class: Google::Apis::ComputeV1::Snapshot
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Snapshot
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/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. (== 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 automatically 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.
-
#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::ComputeV1::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::ComputeV1::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
21572 21573 21574 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21572 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 automatically by applying resource
policy on the target disk.
Corresponds to the JSON property autoCreated
21448 21449 21450 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21448 def auto_created @auto_created end |
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
21454 21455 21456 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21454 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
21460 21461 21462 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21460 def description @description end |
#disk_size_gb ⇒ Fixnum
[Output Only] Size of the snapshot, specified in GB.
Corresponds to the JSON property diskSizeGb
21465 21466 21467 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21465 def disk_size_gb @disk_size_gb end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
21471 21472 21473 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21471 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#snapshot for Snapshot
resources.
Corresponds to the JSON property kind
21477 21478 21479 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21477 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.
21489 21490 21491 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21489 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
21495 21496 21497 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21495 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
21501 21502 21503 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21501 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
21508 21509 21510 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21508 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
21518 21519 21520 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21518 def name @name end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
21523 21524 21525 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21523 def self_link @self_link end |
#snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property snapshotEncryptionKey
21528 21529 21530 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21528 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
21533 21534 21535 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21533 def source_disk @source_disk end |
#source_disk_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceDiskEncryptionKey
21538 21539 21540 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21538 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
21545 21546 21547 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21545 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
21551 21552 21553 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21551 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
21557 21558 21559 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21557 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
21565 21566 21567 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21565 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
21570 21571 21572 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21570 def storage_locations @storage_locations end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
21577 21578 21579 21580 21581 21582 21583 21584 21585 21586 21587 21588 21589 21590 21591 21592 21593 21594 21595 21596 21597 21598 |
# File 'generated/google/apis/compute_v1/classes.rb', line 21577 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) @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 |