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
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).
Generated from protobuf field optional bool auto_delete = 464761403;
| 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).
Generated from protobuf field optional bool auto_delete = 464761403;
| 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.
Generated from protobuf field optional string custom_image = 184123149;
| Returns | |
|---|---|
| Type | Description |
string | |
hasCustomImage
clearCustomImage
setCustomImage
The custom source image to be used to restore this disk when instantiating this instance template.
Generated from protobuf field optional string custom_image = 184123149;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeviceName
Specifies the device name of the disk to which the configurations apply to.
Generated from protobuf field optional string device_name = 67541716;
| Returns | |
|---|---|
| Type | Description |
string | |
hasDeviceName
clearDeviceName
setDeviceName
Specifies the device name of the disk to which the configurations apply to.
Generated from protobuf field optional string device_name = 67541716;
| 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.
Generated from protobuf field optional string instantiate_from = 393383903;
| 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.
Generated from protobuf field optional string instantiate_from = 393383903;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |