Google Cloud Backup Dr V1 Client - Class AttachedDisk (0.4.2)

Reference documentation and code samples for the Google Cloud Backup Dr V1 Client class AttachedDisk.

An instance-attached disk resource.

Generated from protobuf message google.cloud.backupdr.v1.AttachedDisk

Namespace

Google \ Cloud \ BackupDR \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ initialize_params`	`AttachedDisk\InitializeParams` Optional. Specifies the parameters to initialize this disk.
`↳ device_name`	`string` Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)
`↳ kind`	`string` Optional. Type of the resource.
`↳ disk_type_deprecated`	`int` Specifies the type of the disk.
`↳ mode`	`int` Optional. The mode in which to attach this disk.
`↳ source`	`string` Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.
`↳ index`	`int\|string` Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.
`↳ boot`	`bool` Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.
`↳ auto_delete`	`bool` Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
`↳ license`	`array` Optional. Any valid publicly visible licenses.
`↳ disk_interface`	`int` Optional. Specifies the disk interface to use for attaching this disk.
`↳ guest_os_feature`	`array<GuestOsFeature>` Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
`↳ disk_encryption_key`	`CustomerEncryptionKey` Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.
`↳ disk_size_gb`	`int\|string` Optional. The size of the disk in GB.
`↳ saved_state`	`int` Optional. Output only. The state of the disk.
`↳ disk_type`	`string` Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
`↳ type`	`int` Optional. Specifies the type of the disk.

getInitializeParams

Optional. Specifies the parameters to initialize this disk.

Returns
Type	Description
`AttachedDisk\InitializeParams\|null`

hasInitializeParams

clearInitializeParams

setInitializeParams

Optional. Specifies the parameters to initialize this disk.

Parameter
Name	Description
`var`	`AttachedDisk\InitializeParams`

Returns
Type	Description
`$this`

getDeviceName

Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)

Returns
Type	Description
`string`

hasDeviceName

clearDeviceName

setDeviceName

Optional. This is used as an identifier for the disks. This is the unique name has to provided to modify disk parameters like disk_name and replica_zones (in case of RePDs)

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getKind

Optional. Type of the resource.

Returns
Type	Description
`string`

hasKind

clearKind

setKind

Optional. Type of the resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getDiskTypeDeprecated

Specifies the type of the disk.

Returns
Type	Description
`int`

hasDiskTypeDeprecated

clearDiskTypeDeprecated

setDiskTypeDeprecated

Specifies the type of the disk.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getMode

Optional. The mode in which to attach this disk.

Returns
Type	Description
`int`

hasMode

clearMode

setMode

Optional. The mode in which to attach this disk.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getSource

Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.

Returns
Type	Description
`string`

hasSource

clearSource

setSource

Optional. Specifies a valid partial or full URL to an existing Persistent Disk resource.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getIndex

Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.

Returns
Type	Description
`int\|string`

hasIndex

clearIndex

setIndex

Optional. A zero-based index to this disk, where 0 is reserved for the boot disk.

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

Returns
Type	Description
`$this`

getBoot

Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Returns
Type	Description
`bool`

hasBoot

clearBoot

setBoot

Optional. Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAutoDelete

Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Returns
Type	Description
`bool`

hasAutoDelete

clearAutoDelete

setAutoDelete

Optional. Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getLicense

Optional. Any valid publicly visible licenses.

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

setLicense

Optional. Any valid publicly visible licenses.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDiskInterface

Optional. Specifies the disk interface to use for attaching this disk.

Returns
Type	Description
`int`

hasDiskInterface

clearDiskInterface

setDiskInterface

Optional. Specifies the disk interface to use for attaching this disk.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getGuestOsFeature

Optional. A list of features to enable on the guest operating system.

Applicable only for bootable images.

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

setGuestOsFeature

Optional. A list of features to enable on the guest operating system.

Applicable only for bootable images.

Parameter
Name	Description
`var`	`array<GuestOsFeature>`

Returns
Type	Description
`$this`

getDiskEncryptionKey

Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.

Returns
Type	Description
`CustomerEncryptionKey\|null`

hasDiskEncryptionKey

clearDiskEncryptionKey

setDiskEncryptionKey

Optional. Encrypts or decrypts a disk using a customer-supplied encryption key.

Parameter
Name	Description
`var`	`CustomerEncryptionKey`

Returns
Type	Description
`$this`

getDiskSizeGb

Optional. The size of the disk in GB.

Returns
Type	Description
`int\|string`

hasDiskSizeGb

clearDiskSizeGb

setDiskSizeGb

Optional. The size of the disk in GB.

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

Returns
Type	Description
`$this`

getSavedState

Optional. Output only. The state of the disk.

Returns
Type	Description
`int`

hasSavedState

clearSavedState

setSavedState

Optional. Output only. The state of the disk.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getDiskType

Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd

Returns
Type	Description
`string`

hasDiskType

clearDiskType

setDiskType

Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getType

Optional. Specifies the type of the disk.

Returns
Type	Description
`int`

hasType

clearType

setType

Optional. Specifies the type of the disk.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`