Compute V1 Client - Class Image (1.5.0)

Reference documentation and code samples for the Compute V1 Client class Image.

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

Generated from protobuf message google.cloud.compute.v1.Image

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ architecture`	`string` The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
`↳ archive_size_bytes`	`int\|string` Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
`↳ creation_timestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`↳ deprecated`	`Google\Cloud\Compute\V1\DeprecationStatus` The deprecation status associated with this image.
`↳ description`	`string` An optional description of this resource. Provide this property when you create the resource.
`↳ disk_size_gb`	`int\|string` Size of the image when restored onto a persistent disk (in GB).
`↳ family`	`string` The name of the image family to which this image belongs. You can create disks by specifying 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.
`↳ guest_os_features`	`array<Google\Cloud\Compute\V1\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\|string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`↳ image_encryption_key`	`Google\Cloud\Compute\V1\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.
`↳ kind`	`string` [Output Only] Type of the resource. Always compute#image for images.
`↳ label_fingerprint`	`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.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Labels to apply to this image. These can be later modified by the setLabels method.
`↳ license_codes`	`array` Integer license codes indicating which licenses are attached to this image.
`↳ licenses`	`array` Any applicable license URI.
`↳ 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.
`↳ raw_disk`	`Google\Cloud\Compute\V1\RawDisk` The parameters of the raw disk image.
`↳ satisfies_pzs`	`bool` [Output Only] Reserved for future use.
`↳ self_link`	`string` [Output Only] Server-defined URL for the resource.
`↳ shielded_instance_initial_state`	`Google\Cloud\Compute\V1\InitialStateConfig` Set the secure boot keys of shielded instance.
`↳ source_disk`	`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
`↳ source_disk_encryption_key`	`Google\Cloud\Compute\V1\CustomerEncryptionKey` The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.
`↳ source_disk_id`	`string` [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.
`↳ source_image`	`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
`↳ source_image_encryption_key`	`Google\Cloud\Compute\V1\CustomerEncryptionKey` The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.
`↳ source_image_id`	`string` [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.
`↳ source_snapshot`	`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
`↳ source_snapshot_encryption_key`	`Google\Cloud\Compute\V1\CustomerEncryptionKey` The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
`↳ source_snapshot_id`	`string` [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.
`↳ source_type`	`string` 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.
`↳ status`	`string` [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.
`↳ storage_locations`	`array` Cloud Storage bucket storage location of the image (regional or multi-regional).

getArchitecture

The architecture of the image. Valid values are ARM64 or X86_64.

Check the Architecture enum for the list of possible values.

Generated from protobuf field optional string architecture = 302803283;

Returns
Type	Description
`string`

hasArchitecture

clearArchitecture

setArchitecture

The architecture of the image. Valid values are ARM64 or X86_64.

Check the Architecture enum for the list of possible values.

Generated from protobuf field optional string architecture = 302803283;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getArchiveSizeBytes

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Generated from protobuf field optional int64 archive_size_bytes = 381093450;

Returns
Type	Description
`int\|string`

hasArchiveSizeBytes

clearArchiveSizeBytes

setArchiveSizeBytes

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Generated from protobuf field optional int64 archive_size_bytes = 381093450;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Generated from protobuf field optional string creation_timestamp = 30525366;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDeprecated

The deprecation status associated with this image.

Generated from protobuf field optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type	Description
`Google\Cloud\Compute\V1\DeprecationStatus\|null`

hasDeprecated

clearDeprecated

setDeprecated

The deprecation status associated with this image.

Generated from protobuf field optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\DeprecationStatus`

Returns
Type	Description
`$this`

getDescription

An optional description of this resource. Provide this property when you create the resource.

Generated from protobuf field optional string description = 422937596;

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Generated from protobuf field optional string description = 422937596;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDiskSizeGb

Size of the image when restored onto a persistent disk (in GB).

Generated from protobuf field optional int64 disk_size_gb = 316263735;

Returns
Type	Description
`int\|string`

hasDiskSizeGb

clearDiskSizeGb

setDiskSizeGb

Size of the image when restored onto a persistent disk (in GB).

Generated from protobuf field optional int64 disk_size_gb = 316263735;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getFamily

The name of the image family to which this image belongs. You can create disks by specifying 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.

Generated from protobuf field optional string family = 328751972;

Returns
Type	Description
`string`

hasFamily

clearFamily

setFamily

Generated from protobuf field optional string family = 328751972;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGuestOsFeatures

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.

Generated from protobuf field repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setGuestOsFeatures

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.

Generated from protobuf field repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\GuestOsFeature>`

Returns
Type	Description
`$this`

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Generated from protobuf field optional uint64 id = 3355;

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getImageEncryptionKey

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.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey image_encryption_key = 379512583;

Returns
Type	Description
`Google\Cloud\Compute\V1\CustomerEncryptionKey\|null`

hasImageEncryptionKey

clearImageEncryptionKey

setImageEncryptionKey

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey image_encryption_key = 379512583;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getKind

[Output Only] Type of the resource. Always compute#image for images.

Generated from protobuf field optional string kind = 3292052;

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#image for images.

Generated from protobuf field optional string kind = 3292052;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabelFingerprint

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.

Generated from protobuf field optional string label_fingerprint = 178124825;

Returns
Type	Description
`string`

hasLabelFingerprint

clearLabelFingerprint

setLabelFingerprint

Generated from protobuf field optional string label_fingerprint = 178124825;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Labels to apply to this image. These can be later modified by the setLabels method.

Generated from protobuf field map<string, string> labels = 500195327;

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setLabels

Labels to apply to this image. These can be later modified by the setLabels method.

Generated from protobuf field map<string, string> labels = 500195327;

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getLicenseCodes

Integer license codes indicating which licenses are attached to this image.

Generated from protobuf field repeated int64 license_codes = 45482664;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLicenseCodes

Integer license codes indicating which licenses are attached to this image.

Generated from protobuf field repeated int64 license_codes = 45482664;

Parameter
Name	Description
`var`	`int[]\|string[]\|Google\Protobuf\Internal\RepeatedField`

Returns
Type	Description
`$this`

getLicenses

Any applicable license URI.

Generated from protobuf field repeated string licenses = 337642578;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setLicenses

Any applicable license URI.

Generated from protobuf field repeated string licenses = 337642578;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getName

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.

Generated from protobuf field optional string name = 3373707;

Returns
Type	Description
`string`

hasName

clearName

setName

Generated from protobuf field optional string name = 3373707;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getRawDisk

The parameters of the raw disk image.

Generated from protobuf field optional .google.cloud.compute.v1.RawDisk raw_disk = 503113556;

Returns
Type	Description
`Google\Cloud\Compute\V1\RawDisk\|null`

hasRawDisk

clearRawDisk

setRawDisk

The parameters of the raw disk image.

Generated from protobuf field optional .google.cloud.compute.v1.RawDisk raw_disk = 503113556;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\RawDisk`

Returns
Type	Description
`$this`

getSatisfiesPzs

[Output Only] Reserved for future use.

Generated from protobuf field optional bool satisfies_pzs = 480964267;

Returns
Type	Description
`bool`

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

[Output Only] Reserved for future use.

Generated from protobuf field optional bool satisfies_pzs = 480964267;

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSelfLink

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Generated from protobuf field optional string self_link = 456214797;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getShieldedInstanceInitialState

Set the secure boot keys of shielded instance.

Generated from protobuf field optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;

Returns
Type	Description
`Google\Cloud\Compute\V1\InitialStateConfig\|null`

hasShieldedInstanceInitialState

clearShieldedInstanceInitialState

setShieldedInstanceInitialState

Set the secure boot keys of shielded instance.

Generated from protobuf field optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\InitialStateConfig`

Returns
Type	Description
`$this`

getSourceDisk

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

Generated from protobuf field optional string source_disk = 451753793;

Returns
Type	Description
`string`

hasSourceDisk

clearSourceDisk

setSourceDisk

Generated from protobuf field optional string source_disk = 451753793;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceDiskEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type	Description
`Google\Cloud\Compute\V1\CustomerEncryptionKey\|null`

hasSourceDiskEncryptionKey

clearSourceDiskEncryptionKey

setSourceDiskEncryptionKey

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getSourceDiskId

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

Generated from protobuf field optional string source_disk_id = 454190809;

Returns
Type	Description
`string`

hasSourceDiskId

clearSourceDiskId

setSourceDiskId

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

Generated from protobuf field optional string source_disk_id = 454190809;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceImage

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

Generated from protobuf field optional string source_image = 50443319;

Returns
Type	Description
`string`

hasSourceImage

clearSourceImage

setSourceImage

Generated from protobuf field optional string source_image = 50443319;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceImageEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type	Description
`Google\Cloud\Compute\V1\CustomerEncryptionKey\|null`

hasSourceImageEncryptionKey

clearSourceImageEncryptionKey

setSourceImageEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getSourceImageId

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

Generated from protobuf field optional string source_image_id = 55328291;

Returns
Type	Description
`string`

hasSourceImageId

clearSourceImageId

setSourceImageId

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

Generated from protobuf field optional string source_image_id = 55328291;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceSnapshot

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

Generated from protobuf field optional string source_snapshot = 126061928;

Returns
Type	Description
`string`

hasSourceSnapshot

clearSourceSnapshot

setSourceSnapshot

Generated from protobuf field optional string source_snapshot = 126061928;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type	Description
`Google\Cloud\Compute\V1\CustomerEncryptionKey\|null`

hasSourceSnapshotEncryptionKey

clearSourceSnapshotEncryptionKey

setSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getSourceSnapshotId

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

Generated from protobuf field optional string source_snapshot_id = 98962258;

Returns
Type	Description
`string`

hasSourceSnapshotId

clearSourceSnapshotId

setSourceSnapshotId

Generated from protobuf field optional string source_snapshot_id = 98962258;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceType

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.

Generated from protobuf field optional string source_type = 452245726;

Returns
Type	Description
`string`

hasSourceType

clearSourceType

setSourceType

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.

Generated from protobuf field optional string source_type = 452245726;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

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

Generated from protobuf field optional string status = 181260274;

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

Check the Status enum for the list of possible values.

Generated from protobuf field optional string status = 181260274;

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStorageLocations

Cloud Storage bucket storage location of the image (regional or multi-regional).

Generated from protobuf field repeated string storage_locations = 328005274;

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setStorageLocations

Cloud Storage bucket storage location of the image (regional or multi-regional).

Generated from protobuf field repeated string storage_locations = 328005274;

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`