Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Snapshot (v2.11.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#architecture

def architecture() -> ::String
Returns
  • (::String) — [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

#architecture=

def architecture=(value) -> ::String
Parameter
  • value (::String) — [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
Returns
  • (::String) — [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

#auto_created

def auto_created() -> ::Boolean
Returns
  • (::Boolean) — [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

#auto_created=

def auto_created=(value) -> ::Boolean
Parameter
  • value (::Boolean) — [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.
Returns
  • (::Boolean) — [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk.

#chain_name

def chain_name() -> ::String
Returns
  • (::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.

#chain_name=

def chain_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#creation_size_bytes

def creation_size_bytes() -> ::Integer
Returns
  • (::Integer) — [Output Only] Size in bytes of the snapshot at creation time.

#creation_size_bytes=

def creation_size_bytes=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] Size in bytes of the snapshot at creation time.
Returns
  • (::Integer) — [Output Only] Size in bytes of the snapshot at creation time.

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#disk_size_gb

def disk_size_gb() -> ::Integer
Returns
  • (::Integer) — [Output Only] Size of the source disk, specified in GB.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] Size of the source disk, specified in GB.
Returns
  • (::Integer) — [Output Only] Size of the source disk, specified in GB.

#download_bytes

def download_bytes() -> ::Integer
Returns
  • (::Integer) — [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

#download_bytes=

def download_bytes=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] Number of bytes downloaded to restore a snapshot to a disk.
Returns
  • (::Integer) — [Output Only] Number of bytes downloaded to restore a snapshot to a disk.

#enable_confidential_compute

def enable_confidential_compute() -> ::Boolean
Returns
  • (::Boolean) — Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

#enable_confidential_compute=

def enable_confidential_compute=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.
Returns
  • (::Boolean) — Whether this snapshot is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

#guest_os_features

def guest_os_features() -> ::Array<::Google::Cloud::Compute::V1::GuestOsFeature>
Returns
  • (::Array<::Google::Cloud::Compute::V1::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.

#guest_os_features=

def guest_os_features=(value) -> ::Array<::Google::Cloud::Compute::V1::GuestOsFeature>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::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.
Returns
  • (::Array<::Google::Cloud::Compute::V1::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.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::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.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.

#license_codes

def license_codes() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

#license_codes=

def license_codes=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
Returns
  • (::Array<::Integer>) — [Output Only] Integer license codes indicating which licenses are attached to this snapshot.

#licenses

def licenses() -> ::Array<::String>
Returns
  • (::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).

#licenses=

def licenses=(value) -> ::Array<::String>
Parameter
  • value (::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).
Returns
  • (::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).

#location_hint

def location_hint() -> ::String
Returns
  • (::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.

#location_hint=

def location_hint=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzi=

def satisfies_pzi=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Output only. Reserved for future use.
Returns
  • (::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — [Output Only] Reserved for future use.

#satisfies_pzs=

def satisfies_pzs=(value) -> ::Boolean
Parameter
  • value (::Boolean) — [Output Only] Reserved for future use.
Returns
  • (::Boolean) — [Output Only] Reserved for future use.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#snapshot_encryption_key

def snapshot_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns
  • (::Google::Cloud::Compute::V1::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.

#snapshot_encryption_key=

def snapshot_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
  • value (::Google::Cloud::Compute::V1::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.
Returns
  • (::Google::Cloud::Compute::V1::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.

#snapshot_type

def snapshot_type() -> ::String
Returns
  • (::String) — Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.

#snapshot_type=

def snapshot_type=(value) -> ::String
Parameter
  • value (::String) — Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.
Returns
  • (::String) — Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values.

#source_disk

def source_disk() -> ::String
Returns
  • (::String) — The source disk used to create this snapshot.

#source_disk=

def source_disk=(value) -> ::String
Parameter
  • value (::String) — The source disk used to create this snapshot.
Returns
  • (::String) — The source disk used to create this snapshot.

#source_disk_encryption_key

def source_disk_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns

#source_disk_encryption_key=

def source_disk_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
Returns

#source_disk_for_recovery_checkpoint

def source_disk_for_recovery_checkpoint() -> ::String
Returns
  • (::String) — The source disk whose recovery checkpoint will be used to create this snapshot.

#source_disk_for_recovery_checkpoint=

def source_disk_for_recovery_checkpoint=(value) -> ::String
Parameter
  • value (::String) — The source disk whose recovery checkpoint will be used to create this snapshot.
Returns
  • (::String) — The source disk whose recovery checkpoint will be used to create this snapshot.

#source_disk_id

def source_disk_id() -> ::String
Returns
  • (::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.

#source_disk_id=

def source_disk_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#source_instant_snapshot

def source_instant_snapshot() -> ::String
Returns
  • (::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

#source_instant_snapshot=

def source_instant_snapshot=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#source_instant_snapshot_encryption_key

def source_instant_snapshot_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns

#source_instant_snapshot_encryption_key=

def source_instant_snapshot_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
Returns

#source_instant_snapshot_id

def source_instant_snapshot_id() -> ::String
Returns
  • (::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.

#source_instant_snapshot_id=

def source_instant_snapshot_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#source_snapshot_schedule_policy

def source_snapshot_schedule_policy() -> ::String
Returns
  • (::String) — [Output Only] URL of the resource policy which created this scheduled snapshot.

#source_snapshot_schedule_policy=

def source_snapshot_schedule_policy=(value) -> ::String
Parameter
  • value (::String) — [Output Only] URL of the resource policy which created this scheduled snapshot.
Returns
  • (::String) — [Output Only] URL of the resource policy which created this scheduled snapshot.

#source_snapshot_schedule_policy_id

def source_snapshot_schedule_policy_id() -> ::String
Returns
  • (::String) — [Output Only] ID of the resource policy which created this scheduled snapshot.

#source_snapshot_schedule_policy_id=

def source_snapshot_schedule_policy_id=(value) -> ::String
Parameter
  • value (::String) — [Output Only] ID of the resource policy which created this scheduled snapshot.
Returns
  • (::String) — [Output Only] ID of the resource policy which created this scheduled snapshot.

#status

def status() -> ::String
Returns
  • (::String) — [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.

#status=

def status=(value) -> ::String
Parameter
  • value (::String) — [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.
Returns
  • (::String) — [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING. Check the Status enum for the list of possible values.

#storage_bytes

def storage_bytes() -> ::Integer
Returns
  • (::Integer) — [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.

#storage_bytes=

def storage_bytes=(value) -> ::Integer
Parameter
  • value (::Integer) — [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.
Returns
  • (::Integer) — [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.

#storage_bytes_status

def storage_bytes_status() -> ::String
Returns
  • (::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. Check the StorageBytesStatus enum for the list of possible values.

#storage_bytes_status=

def storage_bytes_status=(value) -> ::String
Parameter
  • value (::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. Check the StorageBytesStatus enum for the list of possible values.
Returns
  • (::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. Check the StorageBytesStatus enum for the list of possible values.

#storage_locations

def storage_locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

#storage_locations=

def storage_locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Cloud Storage bucket storage location of the snapshot (regional or multi-regional).
Returns
  • (::Array<::String>) — Cloud Storage bucket storage location of the snapshot (regional or multi-regional).