Compute V1 Client - Class Disk (1.13.0)

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

Represents a Persistent Disk resource. Google Compute Engine has two Disk resources: * Zonal * Regional Persistent disks are required for running your VM instances. Create both boot and non-boot (data) persistent disks. For more information, read Persistent Disks. For more storage options, read Storage options. The disks resource represents a zonal persistent disk. For more information, read Zonal persistent disks. The regionDisks resource represents a regional persistent disk. For more information, read Regional resources.

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

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 disk. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
`↳ async_primary_disk`	`Google\Cloud\Compute\V1\DiskAsyncReplication` Disk asynchronously replicated into this disk.
`↳ async_secondary_disks`	`array\|Google\Protobuf\Internal\MapField` [Output Only] A list of disks this disk is asynchronously replicated to.
`↳ creation_timestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`↳ description`	`string` An optional description of this resource. Provide this property when you create the resource.
`↳ disk_encryption_key`	`Google\Cloud\Compute\V1\CustomerEncryptionKey` Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.
`↳ guest_os_features`	`array<Google\Cloud\Compute\V1\GuestOsFeature>` A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.
`↳ id`	`int\|string` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`↳ kind`	`string` [Output Only] Type of the resource. Always compute#disk for disks.
`↳ label_fingerprint`	`string` A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.
`↳ labels`	`array\|Google\Protobuf\Internal\MapField` Labels to apply to this disk. These can be later modified by the setLabels method.
`↳ last_attach_timestamp`	`string` [Output Only] Last attach timestamp in RFC3339 text format.
`↳ last_detach_timestamp`	`string` [Output Only] Last detach timestamp in RFC3339 text format.
`↳ license_codes`	`array` Integer license codes indicating which licenses are attached to this disk.
`↳ licenses`	`array` A list of publicly visible licenses. Reserved for Google's use.
`↳ location_hint`	`string` An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.
`↳ name`	`string` Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
`↳ options`	`string` Internal use only.
`↳ params`	`Google\Cloud\Compute\V1\DiskParams` Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.
`↳ physical_block_size_bytes`	`int\|string` Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.
`↳ 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 be between 1 and 7,124.
`↳ region`	`string` [Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
`↳ replica_zones`	`array` URLs of the zones where the disk should be replicated to. Only applicable for regional resources.
`↳ resource_policies`	`array` Resource policies applied to this disk for automatic snapshot creations.
`↳ resource_status`	`Google\Cloud\Compute\V1\DiskResourceStatus` [Output Only] Status information for the disk resource.
`↳ satisfies_pzs`	`bool` [Output Only] Reserved for future use.
`↳ self_link`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`↳ size_gb`	`int\|string` Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.
`↳ source_consistency_group_policy`	`string` [Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
`↳ source_consistency_group_policy_id`	`string` [Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.
`↳ source_disk`	`string` The source disk used to create this disk. 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 /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk
`↳ source_disk_id`	`string` [Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.
`↳ source_image`	`string` The source image used to create this disk. If the source image is deleted, this field will not be set. 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
`↳ 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.
`↳ source_image_id`	`string` [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
`↳ source_snapshot`	`string` The source snapshot used to create this disk. 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 /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot
`↳ source_snapshot_encryption_key`	`Google\Cloud\Compute\V1\CustomerEncryptionKey` The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.
`↳ source_snapshot_id`	`string` [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
`↳ source_storage_object`	`string` The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.
`↳ status`	`string` [Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting. Check the Status enum for the list of possible values.
`↳ type`	`string` URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.
`↳ users`	`array` [Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance
`↳ zone`	`string` [Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

getArchitecture

The architecture of the 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 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`

getAsyncPrimaryDisk

Disk asynchronously replicated into this disk.

Returns
Type	Description
`Google\Cloud\Compute\V1\DiskAsyncReplication\|null`

hasAsyncPrimaryDisk

clearAsyncPrimaryDisk

setAsyncPrimaryDisk

Disk asynchronously replicated into this disk.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\DiskAsyncReplication`

Returns
Type	Description
`$this`

getAsyncSecondaryDisks

[Output Only] A list of disks this disk is asynchronously replicated to.

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

setAsyncSecondaryDisks

[Output Only] A list of disks this disk is asynchronously replicated to.

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

Returns
Type	Description
`$this`

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDiskEncryptionKey

Encrypts the disk using a customer-supplied encryption key or a customer-managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: "diskEncryptionKey.kmsKeyName": "projects/kms_project_id/locations/region/keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later.

Returns
Type	Description
`Google\Cloud\Compute\V1\CustomerEncryptionKey\|null`

hasDiskEncryptionKey

clearDiskEncryptionKey

setDiskEncryptionKey

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getGuestOsFeatures

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

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

setGuestOsFeatures

A list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Parameter
Name	Description
`var`	`array<Google\Cloud\Compute\V1\GuestOsFeature>`

Returns
Type	Description
`$this`

getId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns
Type	Description
`int\|string`

hasId

clearId

setId

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

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

Returns
Type	Description
`$this`

getKind

[Output Only] Type of the resource. Always compute#disk for disks.

Returns
Type	Description
`string`

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#disk for disks.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabelFingerprint

A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash in order to update or change labels, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve a disk.

Returns
Type	Description
`string`

hasLabelFingerprint

clearLabelFingerprint

setLabelFingerprint

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLabels

Labels to apply to this disk. These can be later modified by the setLabels method.

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

setLabels

Labels to apply to this disk. These can be later modified by the setLabels method.

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

Returns
Type	Description
`$this`

getLastAttachTimestamp

[Output Only] Last attach timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasLastAttachTimestamp

clearLastAttachTimestamp

setLastAttachTimestamp

[Output Only] Last attach timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLastDetachTimestamp

[Output Only] Last detach timestamp in RFC3339 text format.

Returns
Type	Description
`string`

hasLastDetachTimestamp

clearLastDetachTimestamp

setLastDetachTimestamp

[Output Only] Last detach timestamp in RFC3339 text format.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLicenseCodes

Integer license codes indicating which licenses are attached to this disk.

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

setLicenseCodes

Integer license codes indicating which licenses are attached to this disk.

Parameter
Name	Description
`var`	`int[]\|string[]\|Google\Protobuf\Internal\RepeatedField`

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`

getLocationHint

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

Returns
Type	Description
`string`

hasLocationHint

clearLocationHint

setLocationHint

An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type	Description
`string`

hasName

clearName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getOptions

Internal use only.

Returns
Type	Description
`string`

hasOptions

clearOptions

setOptions

Internal use only.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getParams

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

Returns
Type	Description
`Google\Cloud\Compute\V1\DiskParams\|null`

hasParams

clearParams

setParams

Input only. [Input Only] Additional params passed with the request, but not persisted as part of resource payload.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\DiskParams`

Returns
Type	Description
`$this`

getPhysicalBlockSizeBytes

Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, other sizes may be added in the future. If an unsupported value is requested, the error message will list the supported values for the caller's project.

Returns
Type	Description
`int\|string`

hasPhysicalBlockSizeBytes

clearPhysicalBlockSizeBytes

setPhysicalBlockSizeBytes

Parameter
Name	Description
`var`	`int\|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 be between 1 and 7,124.

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 be between 1 and 7,124.

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

Returns
Type	Description
`$this`

getRegion

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type	Description
`string`

hasRegion

clearRegion

setRegion

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getReplicaZones

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

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

setReplicaZones

URLs of the zones where the disk should be replicated to. Only applicable for regional resources.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getResourcePolicies

Resource policies applied to this disk for automatic snapshot creations.

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

setResourcePolicies

Resource policies applied to this disk for automatic snapshot creations.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getResourceStatus

[Output Only] Status information for the disk resource.

Returns
Type	Description
`Google\Cloud\Compute\V1\DiskResourceStatus\|null`

hasResourceStatus

clearResourceStatus

setResourceStatus

[Output Only] Status information for the disk resource.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\DiskResourceStatus`

Returns
Type	Description
`$this`

getSatisfiesPzs

[Output Only] Reserved for future use.

Returns
Type	Description
`bool`

hasSatisfiesPzs

clearSatisfiesPzs

setSatisfiesPzs

[Output Only] Reserved for future use.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getSelfLink

[Output Only] Server-defined fully-qualified URL for this resource.

Returns
Type	Description
`string`

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined fully-qualified URL for this resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSizeGb

Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are greater than 0.

Returns
Type	Description
`int\|string`

hasSizeGb

clearSizeGb

setSizeGb

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

Returns
Type	Description
`$this`

getSourceConsistencyGroupPolicy

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

Returns
Type	Description
`string`

hasSourceConsistencyGroupPolicy

clearSourceConsistencyGroupPolicy

setSourceConsistencyGroupPolicy

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceConsistencyGroupPolicyId

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

Returns
Type	Description
`string`

hasSourceConsistencyGroupPolicyId

clearSourceConsistencyGroupPolicyId

setSourceConsistencyGroupPolicyId

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceDisk

The source disk used to create this disk. 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 /disks/disk - https://www.googleapis.com/compute/v1/projects/project/regions/region /disks/disk - projects/project/zones/zone/disks/disk - projects/project/regions/region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk

Returns
Type	Description
`string`

hasSourceDisk

clearSourceDisk

setSourceDisk

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceDiskId

[Output Only] The unique ID of the disk used to create this disk. This value identifies the exact disk that was used to create this persistent disk. For example, if you created the persistent disk from a disk that was later deleted and recreated under the same name, the source disk ID would identify the exact version of the disk that was used.

Returns
Type	Description
`string`

hasSourceDiskId

clearSourceDiskId

setSourceDiskId

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceImage

The source image used to create this disk. If the source image is deleted, this field will not be set. 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

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.

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

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getSourceImageId

[Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.

Returns
Type	Description
`string`

hasSourceImageId

clearSourceImageId

setSourceImageId

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceSnapshot

The source snapshot used to create this disk. 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 /global/snapshots/snapshot - projects/project/global/snapshots/snapshot - global/snapshots/snapshot

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. Required if the source snapshot is protected by a customer-supplied encryption key.

Returns
Type	Description
`Google\Cloud\Compute\V1\CustomerEncryptionKey\|null`

hasSourceSnapshotEncryptionKey

clearSourceSnapshotEncryptionKey

setSourceSnapshotEncryptionKey

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Parameter
Name	Description
`var`	`Google\Cloud\Compute\V1\CustomerEncryptionKey`

Returns
Type	Description
`$this`

getSourceSnapshotId

[Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.

Returns
Type	Description
`string`

hasSourceSnapshotId

clearSourceSnapshotId

setSourceSnapshotId

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSourceStorageObject

The full Google Cloud Storage URI where the disk image is stored. This file must be a gzip-compressed tarball whose name ends in .tar.gz or virtual machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https://storage.googleapis.com/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead.

Returns
Type	Description
`string`

hasSourceStorageObject

clearSourceStorageObject

setSourceStorageObject

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStatus

[Output Only] The status of disk creation. - CREATING: Disk is provisioning. - RESTORING: Source data is being copied into the disk. - FAILED: Disk creation failed. - READY: Disk is ready for use. - DELETING: Disk is deleting.

Check the Status enum for the list of possible values.

Returns
Type	Description
`string`

hasStatus

clearStatus

setStatus

Check the Status enum for the list of possible values.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: projects/project /zones/zone/diskTypes/pd-ssd . See Persistent disk types.

Returns
Type	Description
`string`

hasType

clearType

setType

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getUsers

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

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

setUsers

[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getZone

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Returns
Type	Description
`string`

hasZone

clearZone

setZone

[Output Only] URL of the zone where the disk resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`