Reference documentation and code samples for the Compute V1 Client class DiskInstantiationConfig.
A specification of the desired way to instantiate a disk in the instance template when its created from a source instance.
Generated from protobuf message google.cloud.compute.v1.DiskInstantiationConfig
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ auto_delete
bool
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
↳ custom_image
string
The custom source image to be used to restore this disk when instantiating this instance template.
↳ device_name
string
Specifies the device name of the disk to which the configurations apply to.
↳ instantiate_from
string
Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks. Check the InstantiateFrom enum for the list of possible values.
getAutoDelete
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Returns
Type
Description
bool
hasAutoDelete
clearAutoDelete
setAutoDelete
Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getCustomImage
The custom source image to be used to restore this disk when instantiating this instance template.
Returns
Type
Description
string
hasCustomImage
clearCustomImage
setCustomImage
The custom source image to be used to restore this disk when instantiating this instance template.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDeviceName
Specifies the device name of the disk to which the configurations apply to.
Returns
Type
Description
string
hasDeviceName
clearDeviceName
setDeviceName
Specifies the device name of the disk to which the configurations apply to.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getInstantiateFrom
Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.
Check the InstantiateFrom enum for the list of possible values.
Returns
Type
Description
string
hasInstantiateFrom
clearInstantiateFrom
setInstantiateFrom
Specifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.
Check the InstantiateFrom enum for the list of possible values.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class DiskInstantiationConfig (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.DiskInstantiationConfig)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.DiskInstantiationConfig)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.DiskInstantiationConfig)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.DiskInstantiationConfig)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.DiskInstantiationConfig)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.DiskInstantiationConfig)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.DiskInstantiationConfig)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.DiskInstantiationConfig)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.DiskInstantiationConfig)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.DiskInstantiationConfig)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.DiskInstantiationConfig)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.DiskInstantiationConfig)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.DiskInstantiationConfig)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.DiskInstantiationConfig)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.DiskInstantiationConfig)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.DiskInstantiationConfig)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.DiskInstantiationConfig)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.DiskInstantiationConfig)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.DiskInstantiationConfig)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.DiskInstantiationConfig)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.DiskInstantiationConfig)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.DiskInstantiationConfig)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.DiskInstantiationConfig)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.DiskInstantiationConfig)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.DiskInstantiationConfig)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.DiskInstantiationConfig)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.DiskInstantiationConfig)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.DiskInstantiationConfig)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.DiskInstantiationConfig)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.DiskInstantiationConfig) \nReference documentation and code samples for the Compute V1 Client class DiskInstantiationConfig.\n\nA specification of the desired way to instantiate a disk in the instance template when its created from a source instance.\n\nGenerated from protobuf message `google.cloud.compute.v1.DiskInstantiationConfig`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAutoDelete\n\nSpecifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).\n\n### hasAutoDelete\n\n### clearAutoDelete\n\n### setAutoDelete\n\nSpecifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).\n\n### getCustomImage\n\nThe custom source image to be used to restore this disk when instantiating this instance template.\n\n### hasCustomImage\n\n### clearCustomImage\n\n### setCustomImage\n\nThe custom source image to be used to restore this disk when instantiating this instance template.\n\n### getDeviceName\n\nSpecifies the device name of the disk to which the configurations apply to.\n\n### hasDeviceName\n\n### clearDeviceName\n\n### setDeviceName\n\nSpecifies the device name of the disk to which the configurations apply to.\n\n### getInstantiateFrom\n\nSpecifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.\n\nCheck the InstantiateFrom enum for the list of possible values.\n\n### hasInstantiateFrom\n\n### clearInstantiateFrom\n\n### setInstantiateFrom\n\nSpecifies whether to include the disk and what image to use. Possible values are: - source-image: to use the same image that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - source-image-family: to use the same image family that was used to create the source instance's corresponding disk. Applicable to the boot disk and additional read-write disks. - custom-image: to use a user-provided image url for disk creation. Applicable to the boot disk and additional read-write disks. - attach-read-only: to attach a read-only disk. Applicable to read-only disks. - do-not-include: to exclude a disk from the template. Applicable to additional read-write disks, local SSDs, and read-only disks.\n\nCheck the InstantiateFrom enum for the list of possible values."]]
