Compute V1 Client - Class AttachedDiskInitializeParams (1.8.3)

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

[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance. Use initialization parameters to create boot disks or local SSDs attached to the new instance. This field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ architecture string

The architecture of the attached disk. Valid values are arm64 or x86_64. Check the Architecture enum for the list of possible values.

↳ description string

An optional description. Provide this property when creating the disk.

↳ disk_name string

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

↳ disk_size_gb int|string

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

↳ disk_type string

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

↳ labels array|Google\Protobuf\Internal\MapField

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

↳ licenses array

A list of publicly visible licenses. Reserved for Google's use.

↳ on_update_action string

Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

↳ provisioned_iops int|string

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

↳ resource_manager_tags array|Google\Protobuf\Internal\MapField

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

↳ resource_policies array

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

↳ source_image string

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

↳ 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. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

↳ source_snapshot string

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

↳ source_snapshot_encryption_key Google\Cloud\Compute\V1\CustomerEncryptionKey

The customer-supplied encryption key of the source snapshot.

getArchitecture

The architecture of the attached disk. Valid values are arm64 or x86_64.

Check the Architecture enum for the list of possible values.

Returns
TypeDescription
string

hasArchitecture

clearArchitecture

setArchitecture

The architecture of the attached disk. Valid values are arm64 or x86_64.

Check the Architecture enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

An optional description. Provide this property when creating the disk.

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

An optional description. Provide this property when creating the disk.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDiskName

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

Returns
TypeDescription
string

hasDiskName

clearDiskName

setDiskName

Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDiskSizeGb

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

Returns
TypeDescription
int|string

hasDiskSizeGb

clearDiskSizeGb

setDiskSizeGb

Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getDiskType

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

Returns
TypeDescription
string

hasDiskType

clearDiskType

setDiskType

Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLabels

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLicenses

A list of publicly visible licenses. Reserved for Google's use.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setLicenses

A list of publicly visible licenses. Reserved for Google's use.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getOnUpdateAction

Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Check the OnUpdateAction enum for the list of possible values.

Returns
TypeDescription
string

hasOnUpdateAction

clearOnUpdateAction

setOnUpdateAction

Specifies which action to take on instance update with this disk. Default is to use the existing disk.

Check the OnUpdateAction enum for the list of possible values.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getProvisionedIops

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Returns
TypeDescription
int|string

hasProvisionedIops

clearProvisionedIops

setProvisionedIops

Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getResourceManagerTags

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setResourceManagerTags

Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getResourcePolicies

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setResourcePolicies

Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getSourceImage

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

Returns
TypeDescription
string

hasSourceImage

clearSourceImage

setSourceImage

The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceImageEncryptionKey

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Returns
TypeDescription
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. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Parameter
NameDescription
var Google\Cloud\Compute\V1\CustomerEncryptionKey
Returns
TypeDescription
$this

getSourceSnapshot

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Returns
TypeDescription
string

hasSourceSnapshot

clearSourceSnapshot

setSourceSnapshot

The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot.

Returns
TypeDescription
Google\Cloud\Compute\V1\CustomerEncryptionKey|null

hasSourceSnapshotEncryptionKey

clearSourceSnapshotEncryptionKey

setSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot.

Parameter
NameDescription
var Google\Cloud\Compute\V1\CustomerEncryptionKey
Returns
TypeDescription
$this