Reference documentation and code samples for the Compute V1 Client class SavedAttachedDisk.
DEPRECATED: Please use compute#savedDisk instead. An instance-attached disk resource.
Generated from protobuf message google.cloud.compute.v1.SavedAttachedDisk
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). |
↳ boot |
bool
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem. |
↳ device_name |
string
Specifies the name of the disk attached to the source instance. |
↳ disk_encryption_key |
Google\Cloud\Compute\V1\CustomerEncryptionKey
The encryption key for the disk. |
↳ disk_size_gb |
int|string
The size of the disk in base-2 GB. |
↳ disk_type |
string
[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd |
↳ 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. |
↳ index |
int
Specifies zero-based index of the disk that is attached to the source instance. |
↳ interface |
string
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. Check the Interface enum for the list of possible values. |
↳ kind |
string
[Output Only] Type of the resource. Always compute#attachedDisk for attached disks. |
↳ licenses |
array
[Output Only] Any valid publicly visible licenses. |
↳ mode |
string
The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY. Check the Mode enum for the list of possible values. |
↳ source |
string
Specifies a URL of the disk attached to the source instance. |
↳ storage_bytes |
int|string
[Output Only] A size of the storage used by the disk's snapshot by this machine image. |
↳ storage_bytes_status |
string
[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Check the StorageBytesStatus enum for the list of possible values. |
↳ type |
string
Specifies the type of the attached disk, either SCRATCH or PERSISTENT. Check the Type 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 | |
getBoot
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
Generated from protobuf field optional bool boot = 3029746;
| Returns | |
|---|---|
| Type | Description |
bool | |
hasBoot
clearBoot
setBoot
Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
Generated from protobuf field optional bool boot = 3029746;
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDeviceName
Specifies the name of the disk attached to the source instance.
Generated from protobuf field optional string device_name = 67541716;
| Returns | |
|---|---|
| Type | Description |
string | |
hasDeviceName
clearDeviceName
setDeviceName
Specifies the name of the disk attached to the source instance.
Generated from protobuf field optional string device_name = 67541716;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiskEncryptionKey
The encryption key for the disk.
Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\CustomerEncryptionKey|null | |
hasDiskEncryptionKey
clearDiskEncryptionKey
setDiskEncryptionKey
The encryption key for the disk.
Generated from protobuf field optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\CustomerEncryptionKey
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiskSizeGb
The size of the disk in base-2 GB.
Generated from protobuf field optional int64 disk_size_gb = 316263735;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasDiskSizeGb
clearDiskSizeGb
setDiskSizeGb
The size of the disk in base-2 GB.
Generated from protobuf field optional int64 disk_size_gb = 316263735;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDiskType
[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd
Generated from protobuf field optional string disk_type = 93009052;
| Returns | |
|---|---|
| Type | Description |
string | |
hasDiskType
clearDiskType
setDiskType
[Output Only] URL of the disk type resource. For example: projects/project /zones/zone/diskTypes/pd-standard or pd-ssd
Generated from protobuf field optional string disk_type = 93009052;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| 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.
Generated from protobuf field repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| 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.
Generated from protobuf field repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Compute\V1\GuestOsFeature>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIndex
Specifies zero-based index of the disk that is attached to the source instance.
Generated from protobuf field optional int32 index = 100346066;
| Returns | |
|---|---|
| Type | Description |
int | |
hasIndex
clearIndex
setIndex
Specifies zero-based index of the disk that is attached to the source instance.
Generated from protobuf field optional int32 index = 100346066;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInterface
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
Check the Interface enum for the list of possible values.
Generated from protobuf field optional string interface = 502623545;
| Returns | |
|---|---|
| Type | Description |
string | |
hasInterface
clearInterface
setInterface
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
Check the Interface enum for the list of possible values.
Generated from protobuf field optional string interface = 502623545;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKind
[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
Generated from protobuf field optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
string | |
hasKind
clearKind
setKind
[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
Generated from protobuf field optional string kind = 3292052;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLicenses
[Output Only] Any valid publicly visible licenses.
Generated from protobuf field repeated string licenses = 337642578;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setLicenses
[Output Only] Any valid publicly visible licenses.
Generated from protobuf field repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMode
The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.
Check the Mode enum for the list of possible values.
Generated from protobuf field optional string mode = 3357091;
| Returns | |
|---|---|
| Type | Description |
string | |
hasMode
clearMode
setMode
The mode in which this disk is attached to the source instance, either READ_WRITE or READ_ONLY.
Check the Mode enum for the list of possible values.
Generated from protobuf field optional string mode = 3357091;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
Specifies a URL of the disk attached to the source instance.
Generated from protobuf field optional string source = 177235995;
| Returns | |
|---|---|
| Type | Description |
string | |
hasSource
clearSource
setSource
Specifies a URL of the disk attached to the source instance.
Generated from protobuf field optional string source = 177235995;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStorageBytes
[Output Only] A size of the storage used by the disk's snapshot by this machine image.
Generated from protobuf field optional int64 storage_bytes = 424631719;
| Returns | |
|---|---|
| Type | Description |
int|string | |
hasStorageBytes
clearStorageBytes
setStorageBytes
[Output Only] A size of the storage used by the disk's snapshot by this machine image.
Generated from protobuf field optional int64 storage_bytes = 424631719;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStorageBytesStatus
[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
Check the StorageBytesStatus enum for the list of possible values.
Generated from protobuf field optional string storage_bytes_status = 490739082;
| Returns | |
|---|---|
| Type | Description |
string | |
hasStorageBytesStatus
clearStorageBytesStatus
setStorageBytesStatus
[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
Check the StorageBytesStatus enum for the list of possible values.
Generated from protobuf field optional string storage_bytes_status = 490739082;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getType
Specifies the type of the attached disk, either SCRATCH or PERSISTENT.
Check the Type enum for the list of possible values.
Generated from protobuf field optional string type = 3575610;
| Returns | |
|---|---|
| Type | Description |
string | |
hasType
clearType
setType
Specifies the type of the attached disk, either SCRATCH or PERSISTENT.
Check the Type enum for the list of possible values.
Generated from protobuf field optional string type = 3575610;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |