Class Snapshot (1.12.0)

Version 1.12.0

• 1.20.1 (latest)
• 1.20.0
• 1.19.2
• 1.18.0
• 1.17.0
• 1.16.1
• 1.15.0
• 1.14.1
• 1.13.0
• 1.12.1
• 1.11.0
• 1.10.1
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.1
• 1.5.2
• 1.4.0
• 1.3.2
• 1.2.0
• 1.1.0
• 1.0.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.1
• 0.1.0

Snapshot(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name	Description
architecture	str [Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values. This field is a member of oneof_ _architecture.
auto_created	bool [Output Only] Set to true if snapshots are automatically created by applying resource policy on the target disk. This field is a member of oneof_ _auto_created.
chain_name	str 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. This field is a member of oneof_ _chain_name.
creation_size_bytes	int [Output Only] Size in bytes of the snapshot at creation time. This field is a member of oneof_ _creation_size_bytes.
creation_timestamp	str [Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
description	str An optional description of this resource. Provide this property when you create the resource. This field is a member of oneof_ _description.
disk_size_gb	int [Output Only] Size of the source disk, specified in GB. This field is a member of oneof_ _disk_size_gb.
download_bytes	int [Output Only] Number of bytes downloaded to restore a snapshot to a disk. This field is a member of oneof_ _download_bytes.
id	int [Output Only] The unique identifier for the resource. This identifier is defined by the server. This field is a member of oneof_ _id.
kind	str [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources. This field is a member of oneof_ _kind.
label_fingerprint	str 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. This field is a member of oneof_ _label_fingerprint.
labels	MutableMapping[str, str] Labels to apply to this snapshot. These can be later modified by the setLabels method. Label values may be empty.
license_codes	MutableSequence[int] [Output Only] Integer license codes indicating which licenses are attached to this snapshot.
licenses	MutableSequence[str] [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	str 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. This field is a member of oneof_ _location_hint.
name	str 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. This field is a member of oneof_ _name.
satisfies_pzs	bool [Output Only] Reserved for future use. This field is a member of oneof_ _satisfies_pzs.
self_link	str [Output Only] Server-defined URL for the resource. This field is a member of oneof_ _self_link.
snapshot_encryption_key	google.cloud.compute_v1.types.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. This field is a member of oneof_ _snapshot_encryption_key.
snapshot_type	str Indicates the type of the snapshot. Check the SnapshotType enum for the list of possible values. This field is a member of oneof_ _snapshot_type.
source_disk	str The source disk used to create this snapshot. This field is a member of oneof_ _source_disk.
source_disk_encryption_key	google.cloud.compute_v1.types.CustomerEncryptionKey The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. This field is a member of oneof_ _source_disk_encryption_key.
source_disk_id	str [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. This field is a member of oneof_ _source_disk_id.
source_snapshot_schedule_policy	str [Output Only] URL of the resource policy which created this scheduled snapshot. This field is a member of oneof_ _source_snapshot_schedule_policy.
source_snapshot_schedule_policy_id	str [Output Only] ID of the resource policy which created this scheduled snapshot. This field is a member of oneof_ _source_snapshot_schedule_policy_id.
status	str [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. This field is a member of oneof_ _status.
storage_bytes	int [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. This field is a member of oneof_ _storage_bytes.
storage_bytes_status	str [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. This field is a member of oneof_ _storage_bytes_status.
storage_locations	MutableSequence[str] Cloud Storage bucket storage location of the snapshot (regional or multi-regional).

Classes

Architecture

Architecture(value)

[Output Only] The architecture of the snapshot. Valid values are ARM64 or X86_64.

Values: UNDEFINED_ARCHITECTURE (0): A value indicating that the enum field is not set. ARCHITECTURE_UNSPECIFIED (394750507): Default value indicating Architecture is not set. ARM64 (62547450): Machines with architecture ARM64 X86_64 (425300551): Machines with architecture X86_64

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

SnapshotType

SnapshotType(value)

Indicates the type of the snapshot.

Values: UNDEFINED_SNAPSHOT_TYPE (0): A value indicating that the enum field is not set. ARCHIVE (506752162): No description available. STANDARD (484642493): No description available.

Status

Status(value)

[Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.

Values: UNDEFINED_STATUS (0): A value indicating that the enum field is not set. CREATING (455564985): Snapshot creation is in progress. DELETING (528602024): Snapshot is currently being deleted. FAILED (455706685): Snapshot creation failed. READY (77848963): Snapshot has been created successfully. UPLOADING (267603489): Snapshot is being uploaded.

StorageBytesStatus

StorageBytesStatus(value)

[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.

Values: UNDEFINED_STORAGE_BYTES_STATUS (0): A value indicating that the enum field is not set. UPDATING (494614342): No description available. UP_TO_DATE (101306702): No description available.