GetImageResult class

Result data returned by getImage.

Constructors

GetImageResult({required String architecture, required String archiveSizeBytes, required String creationTimestamp, required DeprecationStatusResponse deprecated, required String description, required String diskSizeGb, required bool enableConfidentialCompute, required String family, required List<GuestOsFeatureResponse> guestOsFeatures, required CustomerEncryptionKeyResponse imageEncryptionKey, required String kind, required String labelFingerprint, required Map<String, String> labels, required List<String> licenseCodes, required List<String> licenses, required bool locked, required String name, required ImageRawDiskResponse rawDisk, required RolloutPolicyResponse rolloutOverride, required bool satisfiesPzs, required String selfLink, required String selfLinkWithId, required InitialStateConfigResponse shieldedInstanceInitialState, required String sourceDisk, required CustomerEncryptionKeyResponse sourceDiskEncryptionKey, required String sourceDiskId, required String sourceImage, required CustomerEncryptionKeyResponse sourceImageEncryptionKey, required String sourceImageId, required String sourceSnapshot, required CustomerEncryptionKeyResponse sourceSnapshotEncryptionKey, required String sourceSnapshotId, required String sourceType, required String status, required List<String> storageLocations, required List<String> userLicenses})
Creates a new GetImageResult. architecture The architecture of the image. Valid values are ARM64 or X86_64. archiveSizeBytes Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). creationTimestamp Creation timestamp in RFC3339 text format. deprecated The deprecation status associated with this image. description An optional description of this resource. Provide this property when you create the resource. diskSizeGb Size of the image when restored onto a persistent disk (in GB). enableConfidentialCompute Whether this image is created from a confidential compute mode disk. Output Only: This field is not set by user, but from source disk. family 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. guestOsFeatures 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. imageEncryptionKey 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. kind Type of the resource. Always compute#image for images. labelFingerprint 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. labels Labels to apply to this image. These can be later modified by the setLabels method. licenseCodes Integer license codes indicating which licenses are attached to this image. licenses Any applicable license URI. locked A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true name 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. rawDisk The parameters of the raw disk image. rolloutOverride A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method. satisfiesPzs Reserved for future use. selfLink Server-defined URL for the resource. selfLinkWithId Server-defined URL for this resource's resource id. shieldedInstanceInitialState Set the secure boot keys of shielded instance. sourceDisk 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 sourceDiskEncryptionKey The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key. sourceDiskId 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. sourceImage 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 sourceImageEncryptionKey The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. sourceImageId 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. sourceSnapshot 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 sourceSnapshotEncryptionKey The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. sourceSnapshotId 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. sourceType The type of the image used to create this disk. The default and only valid value is RAW. status 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. storageLocations Cloud Storage bucket storage location of the image (regional or multi-regional). userLicenses A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
const
GetImageResult.fromMap(Map<String, dynamic> map)
factory

Properties

architecture → String
The architecture of the image. Valid values are ARM64 or X86_64.
final
archiveSizeBytes → String
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
final
creationTimestamp → String
Creation timestamp in RFC3339 text format.
final
deprecated → DeprecationStatusResponse
The deprecation status associated with this image.
final
description → String
An optional description of this resource. Provide this property when you create the resource.
final
diskSizeGb → String
Size of the image when restored onto a persistent disk (in GB).
final
enableConfidentialCompute → bool
Whether this image is created from a confidential compute mode disk. Output Only: This field is not set by user, but from source disk.
final
family → String
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.
final
guestOsFeatures → List<GuestOsFeatureResponse>
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.
final
hashCode → int
The hash code for this object.
no setterinherited
imageEncryptionKey → CustomerEncryptionKeyResponse
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.
final
kind → String
Type of the resource. Always compute#image for images.
final
labelFingerprint → String
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.
final
labels → Map<String, String>
Labels to apply to this image. These can be later modified by the setLabels method.
final
licenseCodes → List<String>
Integer license codes indicating which licenses are attached to this image.
final
licenses → List<String>
Any applicable license URI.
final
locked → bool
A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will be inherited by the disk created from the image. The disk with locked flag set to true will be prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if disk is created via create-on-create - Create images - Create snapshots - Create disk clone (create disk from the current disk) The image with the locked field set to true will be prohibited from performing the operations below: - Create images from the current image - Update the locked field for the current image The instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Secondary disk attach - Create instant snapshot - Create machine images - Create instance template - Delete the instance with --keep-disk parameter set to true
final
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.
final
rawDisk → ImageRawDiskResponse
The parameters of the raw disk image.
final
rolloutOverride → RolloutPolicyResponse
A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone references to the image via the associated image family. The rollout policy restricts the zones where this image is accessible when using a zonal image family reference. When the rollout policy does not include the user specified zone, or if the zone is rolled out, this image is accessible. The rollout policy for this image is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
satisfiesPzs → bool
Reserved for future use.
final
Server-defined URL for the resource.
final
selfLinkWithId → String
Server-defined URL for this resource's resource id.
final
shieldedInstanceInitialState → InitialStateConfigResponse
Set the secure boot keys of shielded instance.
final
sourceDisk → String
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
final
sourceDiskEncryptionKey → CustomerEncryptionKeyResponse
The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
final
sourceDiskId → String
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.
final
sourceImage → String
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
final
sourceImageEncryptionKey → CustomerEncryptionKeyResponse
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
final
sourceImageId → String
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.
final
sourceSnapshot → String
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
final
sourceSnapshotEncryptionKey → CustomerEncryptionKeyResponse
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
final
sourceSnapshotId → String
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.
final
sourceType → String
The type of the image used to create this disk. The default and only valid value is RAW.
final
status → String
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.
final
storageLocations → List<String>
Cloud Storage bucket storage location of the image (regional or multi-regional).
final
userLicenses → List<String>
A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/debian-9-stretch
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited