Compute V1 Client - Class AttachedDiskInitializeParams (1.21.0)

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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.
`↳ enable_confidential_compute`	`bool` Whether this disk is using confidential compute mode.
`↳ 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.
`↳ provisioned_throughput`	`int\|string` Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.
`↳ replica_zones`	`array` Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.
`↳ 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 boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. 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`	`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 boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. 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`	`CustomerEncryptionKey` The customer-supplied encryption key of the source snapshot.
`↳ storage_pool`	`string` The storage pool in which the new disk is created. 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 /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

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

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

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

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`string`

hasDiskName

clearDiskName

setDiskName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`int\|string`

hasDiskSizeGb

clearDiskSizeGb

setDiskSizeGb

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

Returns
Type	Description
`$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
Type	Description
`string`

hasDiskType

clearDiskType

setDiskType

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getEnableConfidentialCompute

Whether this disk is using confidential compute mode.

Returns
Type	Description
`bool`

hasEnableConfidentialCompute

clearEnableConfidentialCompute

setEnableConfidentialCompute

Whether this disk is using confidential compute mode.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$this`

getLicenses

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

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

setLicenses

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`int\|string`

hasProvisionedIops

clearProvisionedIops

setProvisionedIops

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

Returns
Type	Description
`$this`

getProvisionedThroughput

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.

Returns
Type	Description
`int\|string`

hasProvisionedThroughput

clearProvisionedThroughput

setProvisionedThroughput

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must greater than or equal to 1.

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

Returns
Type	Description
`$this`

getReplicaZones

Required for each regional disk associated with the instance. Specify the URLs of the zones where the disk should be replicated to. You must provide exactly two replica zones, and one zone must be the same as the instance zone.

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

setReplicaZones

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$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
Type	Description
`Google\Protobuf\Internal\MapField`

setResourceManagerTags

Parameter
Name	Description
`var`	`array\|Google\Protobuf\Internal\MapField`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getSourceImage

The source image to create this disk. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. 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
Type	Description
`string`

hasSourceImage

clearSourceImage

setSourceImage

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`CustomerEncryptionKey\|null`

hasSourceImageEncryptionKey

clearSourceImageEncryptionKey

setSourceImageEncryptionKey

Parameter
Name	Description
`var`	`CustomerEncryptionKey`

Returns
Type	Description
`$this`

getSourceSnapshot

The source snapshot to create this disk. When creating a new instance boot disk, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. 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
Type	Description
`string`

hasSourceSnapshot

clearSourceSnapshot

setSourceSnapshot

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot.

Returns
Type	Description
`CustomerEncryptionKey\|null`

hasSourceSnapshotEncryptionKey

clearSourceSnapshotEncryptionKey

setSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot.

Parameter
Name	Description
`var`	`CustomerEncryptionKey`

Returns
Type	Description
`$this`

getStoragePool

The storage pool in which the new disk is created. 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 /storagePools/storagePool - projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

Returns
Type	Description
`string`

hasStoragePool

clearStoragePool

setStoragePool

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`