Reference documentation and code samples for the Google Cloud Notebooks V2 Client class BootDisk.
The definition of a boot disk.
Generated from protobuf messagegoogle.cloud.notebooks.v2.BootDisk
Namespace
Google \ Cloud \ Notebooks \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ disk_size_gb
int|string
Optional. The size of the boot disk in GB attached to this instance, up to a maximum of 64000 GB (64 TB). If not specified, this defaults to the recommended value of 150GB.
↳ disk_type
int
Optional. Indicates the type of the disk.
↳ disk_encryption
int
Optional. Input only. Disk encryption method used on the boot and data disks, defaults to GMEK.
↳ kms_key
string
Optional. Input only. The KMS key used to encrypt the disks, only applicable if disk_encryption is CMEK. Format:projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}Learn more about using your own encryption keys.
getDiskSizeGb
Optional. The size of the boot disk in GB attached to this instance, up to
a maximum of 64000 GB (64 TB). If not specified, this defaults to the
recommended value of 150GB.
Returns
Type
Description
int|string
setDiskSizeGb
Optional. The size of the boot disk in GB attached to this instance, up to
a maximum of 64000 GB (64 TB). If not specified, this defaults to the
recommended value of 150GB.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getDiskType
Optional. Indicates the type of the disk.
Returns
Type
Description
int
setDiskType
Optional. Indicates the type of the disk.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getDiskEncryption
Optional. Input only. Disk encryption method used on the boot and data
disks, defaults to GMEK.
Returns
Type
Description
int
setDiskEncryption
Optional. Input only. Disk encryption method used on the boot and data
disks, defaults to GMEK.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getKmsKey
Optional. Input only. The KMS key used to encrypt the disks, only
applicable if disk_encryption is CMEK. Format:projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}Learn more about using your own encryption keys.
Returns
Type
Description
string
setKmsKey
Optional. Input only. The KMS key used to encrypt the disks, only
applicable if disk_encryption is CMEK. Format:projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}Learn more about using your own encryption keys.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Notebooks V2 Client - Class BootDisk (1.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.5 (latest)](/php/docs/reference/cloud-notebooks/latest/V2.BootDisk)\n- [1.0.4](/php/docs/reference/cloud-notebooks/1.0.4/V2.BootDisk)\n- [0.7.5](/php/docs/reference/cloud-notebooks/0.7.5/V2.BootDisk)\n- [0.6.2](/php/docs/reference/cloud-notebooks/0.6.2/V2.BootDisk)\n- [0.5.0](/php/docs/reference/cloud-notebooks/0.5.0/V2.BootDisk)\n- [0.4.1](/php/docs/reference/cloud-notebooks/0.4.1/V2.BootDisk)\n- [0.3.6](/php/docs/reference/cloud-notebooks/0.3.6/V2.BootDisk) \nReference documentation and code samples for the Google Cloud Notebooks V2 Client class BootDisk.\n\nThe definition of a boot disk.\n\nGenerated from protobuf message `google.cloud.notebooks.v2.BootDisk`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Notebooks \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDiskSizeGb\n\nOptional. The size of the boot disk in GB attached to this instance, up to\na maximum of 64000 GB (64 TB). If not specified, this defaults to the\nrecommended value of 150GB.\n\n### setDiskSizeGb\n\nOptional. The size of the boot disk in GB attached to this instance, up to\na maximum of 64000 GB (64 TB). If not specified, this defaults to the\nrecommended value of 150GB.\n\n### getDiskType\n\nOptional. Indicates the type of the disk.\n\n### setDiskType\n\nOptional. Indicates the type of the disk.\n\n### getDiskEncryption\n\nOptional. Input only. Disk encryption method used on the boot and data\ndisks, defaults to GMEK.\n\n### setDiskEncryption\n\nOptional. Input only. Disk encryption method used on the boot and data\ndisks, defaults to GMEK.\n\n### getKmsKey\n\nOptional. Input only. The KMS key used to encrypt the disks, only\napplicable if disk_encryption is CMEK. Format:\n`projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`\nLearn more about using your own encryption keys.\n\n### setKmsKey\n\nOptional. Input only. The KMS key used to encrypt the disks, only\napplicable if disk_encryption is CMEK. Format:\n`projects/{project_id}/locations/{location}/keyRings/{key_ring_id}/cryptoKeys/{key_id}`\nLearn more about using your own encryption keys."]]
