Compute V1 Client - Class MachineImage (1.14.0)

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

Represents a machine image resource. A machine image is a Compute Engine resource that stores all the configuration, metadata, permissions, and data from one or more disks required to create a Virtual machine (VM) instance. For more information, see Machine images.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ creation_timestamp`	`string` [Output Only] The creation timestamp for this machine image in RFC3339 text format.
`↳ description`	`string` An optional description of this resource. Provide this property when you create the resource.
`↳ guest_flush`	`bool` [Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.
`↳ id`	`int\|string` [Output Only] A unique identifier for this machine image. The server defines this identifier.
`↳ instance_properties`	`Google\Cloud\Compute\V1\InstanceProperties` [Output Only] Properties of source instance
`↳ kind`	`string` [Output Only] The resource type, which is always compute#machineImage for machine image.
`↳ machine_image_encryption_key`	`Google\Cloud\Compute\V1\CustomerEncryptionKey` Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.
`↳ 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.
`↳ satisfies_pzs`	`bool` [Output Only] Reserved for future use.
`↳ saved_disks`	`array<Google\Cloud\Compute\V1\SavedDisk>` An array of Machine Image specific properties for disks attached to the source instance
`↳ self_link`	`string` [Output Only] The URL for this machine image. The server defines this URL.
`↳ source_disk_encryption_keys`	`array<Google\Cloud\Compute\V1\SourceDiskEncryptionKey>` [Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.
`↳ source_instance`	`string` The source instance used to create the machine image. 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 /instances/instance - projects/project/zones/zone/instances/instance
`↳ source_instance_properties`	`Google\Cloud\Compute\V1\SourceInstanceProperties` [Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.
`↳ status`	`string` [Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. Check the Status enum for the list of possible values.
`↳ storage_locations`	`array` The regional or multi-regional Cloud Storage bucket location where the machine image is stored.
`↳ total_storage_bytes`	`int\|string` [Output Only] Total size of the storage used by the machine image.

getCreationTimestamp

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGuestFlush

[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

Returns
Type	Description
`bool`

hasGuestFlush

clearGuestFlush

setGuestFlush

[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getId

[Output Only] A unique identifier for this machine image. The server defines this identifier.

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] A unique identifier for this machine image. The server defines this identifier.

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

Returns
Type	Description
`$this`

getInstanceProperties

[Output Only] Properties of source instance

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

hasInstanceProperties

clearInstanceProperties

setInstanceProperties

[Output Only] Properties of source instance

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

Returns
Type	Description
`$this`

getKind

[Output Only] The resource type, which is always compute#machineImage for machine image.

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] The resource type, which is always compute#machineImage for machine image.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMachineImageEncryptionKey

Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

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

hasMachineImageEncryptionKey

clearMachineImageEncryptionKey

setMachineImageEncryptionKey

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

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.

Returns
Type	Description
`string`

hasName

clearName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSatisfiesPzs

[Output Only] Reserved for future use.

Returns
Type	Description
`bool`

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

[Output Only] Reserved for future use.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSavedDisks

An array of Machine Image specific properties for disks attached to the source instance

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

setSavedDisks

An array of Machine Image specific properties for disks attached to the source instance

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

Returns
Type	Description
`$this`

getSelfLink

[Output Only] The URL for this machine image. The server defines this URL.

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] The URL for this machine image. The server defines this URL.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceDiskEncryptionKeys

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

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

setSourceDiskEncryptionKeys

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

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

Returns
Type	Description
`$this`

getSourceInstance

The source instance used to create the machine image. 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 /instances/instance - projects/project/zones/zone/instances/instance

Returns
Type	Description
`string`

hasSourceInstance

clearSourceInstance

setSourceInstance

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceInstanceProperties

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

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

hasSourceInstanceProperties

clearSourceInstanceProperties

setSourceInstanceProperties

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

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

Returns
Type	Description
`$this`

getStatus

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.

Check the Status enum for the list of possible values.

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING.

Check the Status enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStorageLocations

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

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

setStorageLocations

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getTotalStorageBytes

[Output Only] Total size of the storage used by the machine image.

Returns
Type	Description
`int\|string`

hasTotalStorageBytes

clearTotalStorageBytes

setTotalStorageBytes

[Output Only] Total size of the storage used by the machine image.

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

Returns
Type	Description
`$this`