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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data | arrayOptional. Data for populating the Message object. |
↳ auto_delete | boolSpecifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance). |
↳ custom_image | stringThe custom source image to be used to restore this disk when instantiating this instance template. |
↳ device_name | stringSpecifies the device name of the disk to which the configurations apply to. |
↳ instantiate_from | stringSpecifies 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.
| Parameter | |
|---|---|
| Name | Description |
var | string |
| Returns | |
|---|---|
| Type | Description |
$this | |