class Google::Apis::ComputeV1::Snapshot

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.

Attributes

architecture[RW]
Output Only

The architecture of the snapshot. Valid values are ARM64 or

X86_64. Corresponds to the JSON property `architecture` @return [String]

auto_created[RW]
Output Only

Set to true if snapshots are automatically created by applying

resource policy on the target disk. Corresponds to the JSON property `autoCreated` @return [Boolean]

auto_created?[RW]
Output Only

Set to true if snapshots are automatically created by applying

resource policy on the target disk. Corresponds to the JSON property `autoCreated` @return [Boolean]

chain_name[RW]

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` @return [String]

creation_timestamp[RW]
Output Only

Creation timestamp in RFC3339 text format.

Corresponds to the JSON property `creationTimestamp` @return [String]

description[RW]

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property `description` @return [String]

disk_size_gb[RW]
Output Only

Size of the source disk, specified in GB.

Corresponds to the JSON property `diskSizeGb` @return [Fixnum]

download_bytes[RW]
Output Only

Number of bytes downloaded to restore a snapshot to a disk.

Corresponds to the JSON property `downloadBytes` @return [Fixnum]

id[RW]
Output Only

The unique identifier for the resource. This identifier is

defined by the server. Corresponds to the JSON property `id` @return [Fixnum]

kind[RW]
Output Only

Type of the resource. Always compute#snapshot for Snapshot

resources. Corresponds to the JSON property `kind` @return [String]

label_fingerprint[RW]

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. @return [String]

labels[RW]

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` @return [Hash<String,String>]

license_codes[RW]
Output Only

Integer license codes indicating which licenses are attached to

this snapshot. Corresponds to the JSON property `licenseCodes` @return [Array<Fixnum>]

licenses[RW]
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` @return [Array<String>]

location_hint[RW]

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` @return [String]

name[RW]

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]*)?` 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` @return [String]

satisfies_pzs[RW]
Output Only

Reserved for future use.

Corresponds to the JSON property `satisfiesPzs` @return [Boolean]

satisfies_pzs?[RW]
Output Only

Reserved for future use.

Corresponds to the JSON property `satisfiesPzs` @return [Boolean]

snapshot_encryption_key[RW]

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` @return [Google::Apis::ComputeV1::CustomerEncryptionKey]

source_disk[RW]

The source disk used to create this snapshot. Corresponds to the JSON property `sourceDisk` @return [String]

source_disk_encryption_key[RW]

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` @return [Google::Apis::ComputeV1::CustomerEncryptionKey]

source_disk_id[RW]
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` @return [String]

source_snapshot_schedule_policy[RW]
Output Only

URL of the resource policy which created this scheduled snapshot.

Corresponds to the JSON property `sourceSnapshotSchedulePolicy` @return [String]

source_snapshot_schedule_policy_id[RW]
Output Only

ID of the resource policy which created this scheduled snapshot.

Corresponds to the JSON property `sourceSnapshotSchedulePolicyId` @return [String]

status[RW]
Output Only

The status of the snapshot. This can be CREATING, DELETING,

FAILED, READY, or UPLOADING. Corresponds to the JSON property `status` @return [String]

storage_bytes[RW]
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` @return [Fixnum]

storage_bytes_status[RW]
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` @return [String]

storage_locations[RW]

Cloud Storage bucket storage location of the snapshot (regional or multi- regional). Corresponds to the JSON property `storageLocations` @return [Array<String>]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/compute_v1/classes.rb, line 33421
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/compute_v1/classes.rb, line 33426
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)
  @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)
  @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)
  @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