Class Image (1.14.1)

Version 1.14.1

• 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

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

Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

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

Attributes
Name	Description
architecture	str The architecture of the image. 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.
archive_size_bytes	int Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). This field is a member of oneof_ _archive_size_bytes.
creation_timestamp	str [Output Only] Creation timestamp in RFC3339 text format. This field is a member of oneof_ _creation_timestamp.
deprecated	google.cloud.compute_v1.types.DeprecationStatus The deprecation status associated with this image. This field is a member of oneof_ _deprecated.
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 Size of the image when restored onto a persistent disk (in GB). This field is a member of oneof_ _disk_size_gb.
family	str The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. This field is a member of oneof_ _family.
guest_os_features	MutableSequence[google.cloud.compute_v1.types.GuestOsFeature] A list of features to enable on the guest operating system. Applicable only for bootable images. To see a list of available options, see the guestOSfeatures[].type parameter.
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.
image_encryption_key	google.cloud.compute_v1.types.CustomerEncryptionKey Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a customer-supplied key, you must provide the same key if you use the image later (e.g. to create a disk from the image). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the image, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the image later. This field is a member of oneof_ _image_encryption_key.
kind	str [Output Only] Type of the resource. Always compute#image for images. This field is a member of oneof_ _kind.
label_fingerprint	str A fingerprint for the labels being applied to this image, which is essentially a hash of the labels 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 an image. This field is a member of oneof_ _label_fingerprint.
labels	MutableMapping[str, str] Labels to apply to this image. These can be later modified by the setLabels method.
license_codes	MutableSequence[int] Integer license codes indicating which licenses are attached to this image.
licenses	MutableSequence[str] Any applicable license URI.
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.
raw_disk	google.cloud.compute_v1.types.RawDisk The parameters of the raw disk image. This field is a member of oneof_ _raw_disk.
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.
shielded_instance_initial_state	google.cloud.compute_v1.types.InitialStateConfig Set the secure boot keys of shielded instance. This field is a member of oneof_ _shielded_instance_initial_state.
source_disk	str URL of the source disk used to create this image. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL 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 image. This value may be used to determine whether the image 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_image	str URL of the source image used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name - projects/project_id/global/images/image_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL This field is a member of oneof_ _source_image.
source_image_encryption_key	google.cloud.compute_v1.types.CustomerEncryptionKey The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. This field is a member of oneof_ _source_image_encryption_key.
source_image_id	str [Output Only] The ID value of the image used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given image name. This field is a member of oneof_ _source_image_id.
source_snapshot	str URL of the source snapshot used to create this image. The following are valid formats for the URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/ snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create an image, you must provide the full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL This field is a member of oneof_ _source_snapshot.
source_snapshot_encryption_key	google.cloud.compute_v1.types.CustomerEncryptionKey The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. This field is a member of oneof_ _source_snapshot_encryption_key.
source_snapshot_id	str [Output Only] The ID value of the snapshot used to create this image. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given snapshot name. This field is a member of oneof_ _source_snapshot_id.
source_type	str The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values. This field is a member of oneof_ _source_type.
status	str [Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. Check the Status enum for the list of possible values. This field is a member of oneof_ _status.
storage_locations	MutableSequence[str] Cloud Storage bucket storage location of the image (regional or multi-regional).

Classes

Architecture

Architecture(value)

The architecture of the image. 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.

SourceType

SourceType(value)

The type of the image used to create this disk. The default and only valid value is RAW.

Values: UNDEFINED_SOURCE_TYPE (0): A value indicating that the enum field is not set. RAW (80904): No description available.

Status

Status(value)

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY.

Values: UNDEFINED_STATUS (0): A value indicating that the enum field is not set. DELETING (528602024): Image is deleting. FAILED (455706685): Image creation failed due to an error. PENDING (35394935): Image hasn't been created as yet. READY (77848963): Image has been successfully created.