Reference documentation and code samples for the Google Cloud Notebooks V1 Client class LocalDiskInitializeParams.
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 runtime.
This property is mutually exclusive with the source property; you can only
define one or the other, but not both.
Generated from protobuf messagegoogle.cloud.notebooks.v1.LocalDiskInitializeParams
Namespace
Google \ Cloud \ Notebooks \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ description
string
Optional. Provide this property when creating the disk.
↳ disk_name
string
Optional. Specifies the disk name. If not specified, the default is to use the name of the instance. If the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.
↳ disk_size_gb
int|string
Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB. Default 100 GB.
↳ disk_type
int
Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (PD_STANDARD).
Optional. Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
getDescription
Optional. Provide this property when creating the disk.
Returns
Type
Description
string
setDescription
Optional. Provide this property when creating the disk.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDiskName
Optional. Specifies the disk name. If not specified, the default is to use the name
of the instance. If the disk with the instance name exists already in the
given zone/region, a new name will be automatically generated.
Returns
Type
Description
string
setDiskName
Optional. Specifies the disk name. If not specified, the default is to use the name
of the instance. If the disk with the instance name exists already in the
given zone/region, a new name will be automatically generated.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getDiskSizeGb
Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk
will be the same size as the image (usually 10GB). If specified, the size
must be equal to or larger than 10GB. Default 100 GB.
Returns
Type
Description
int|string
setDiskSizeGb
Optional. Specifies the size of the disk in base-2 GB. If not specified, the disk
will be the same size as the image (usually 10GB). If specified, the size
must be equal to or larger than 10GB. Default 100 GB.
Parameter
Name
Description
var
int|string
Returns
Type
Description
$this
getDiskType
Input only. The type of the boot disk attached to this instance, defaults to
standard persistent disk (PD_STANDARD).
Returns
Type
Description
int
setDiskType
Input only. The type of the boot disk attached to this instance, defaults to
standard persistent disk (PD_STANDARD).
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getLabels
Optional. Labels to apply to this disk. These can be later modified by the
disks.setLabels method. This field is only applicable for persistent disks.
[[["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 V1 Client - Class LocalDiskInitializeParams (1.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.5 (latest)](/php/docs/reference/cloud-notebooks/latest/V1.LocalDiskInitializeParams)\n- [1.0.4](/php/docs/reference/cloud-notebooks/1.0.4/V1.LocalDiskInitializeParams)\n- [0.7.5](/php/docs/reference/cloud-notebooks/0.7.5/V1.LocalDiskInitializeParams)\n- [0.6.2](/php/docs/reference/cloud-notebooks/0.6.2/V1.LocalDiskInitializeParams)\n- [0.5.0](/php/docs/reference/cloud-notebooks/0.5.0/V1.LocalDiskInitializeParams)\n- [0.4.1](/php/docs/reference/cloud-notebooks/0.4.1/V1.LocalDiskInitializeParams)\n- [0.3.6](/php/docs/reference/cloud-notebooks/0.3.6/V1.LocalDiskInitializeParams) \nReference documentation and code samples for the Google Cloud Notebooks V1 Client class LocalDiskInitializeParams.\n\nInput only. Specifies the parameters for a new disk that will be created\nalongside the new instance. Use initialization parameters to create boot\ndisks or local SSDs attached to the new runtime.\n\nThis property is mutually exclusive with the source property; you can only\ndefine one or the other, but not both.\n\nGenerated from protobuf message `google.cloud.notebooks.v1.LocalDiskInitializeParams`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Notebooks \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDescription\n\nOptional. Provide this property when creating the disk.\n\n### setDescription\n\nOptional. Provide this property when creating the disk.\n\n### getDiskName\n\nOptional. Specifies the disk name. If not specified, the default is to use the name\nof the instance. If the disk with the instance name exists already in the\ngiven zone/region, a new name will be automatically generated.\n\n### setDiskName\n\nOptional. Specifies the disk name. If not specified, the default is to use the name\nof the instance. If the disk with the instance name exists already in the\ngiven zone/region, a new name will be automatically generated.\n\n### getDiskSizeGb\n\nOptional. Specifies the size of the disk in base-2 GB. If not specified, the disk\nwill be the same size as the image (usually 10GB). If specified, the size\nmust be equal to or larger than 10GB. Default 100 GB.\n\n### setDiskSizeGb\n\nOptional. Specifies the size of the disk in base-2 GB. If not specified, the disk\nwill be the same size as the image (usually 10GB). If specified, the size\nmust be equal to or larger than 10GB. Default 100 GB.\n\n### getDiskType\n\nInput only. The type of the boot disk attached to this instance, defaults to\nstandard persistent disk (`PD_STANDARD`).\n\n### setDiskType\n\nInput only. The type of the boot disk attached to this instance, defaults to\nstandard persistent disk (`PD_STANDARD`).\n\n### getLabels\n\nOptional. Labels to apply to this disk. These can be later modified by the\ndisks.setLabels method. This field is only applicable for persistent disks.\n\n### setLabels\n\nOptional. Labels to apply to this disk. These can be later modified by the\ndisks.setLabels method. This field is only applicable for persistent disks."]]
