Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#description
defdescription()->::String
Returns
(::String) — Optional. Provide this property when creating the disk.
#description=
defdescription=(value)->::String
Parameter
value (::String) — Optional. Provide this property when creating the disk.
Returns
(::String) — Optional. Provide this property when creating the disk.
#disk_name
defdisk_name()->::String
Returns
(::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_name=
defdisk_name=(value)->::String
Parameter
value (::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.
Returns
(::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
defdisk_size_gb()->::Integer
Returns
(::Integer) — 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_size_gb=
defdisk_size_gb=(value)->::Integer
Parameter
value (::Integer) — 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
(::Integer) — 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.
(::Google::Protobuf::Map{::String => ::String}) — 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.
value (::Google::Protobuf::Map{::String => ::String}) — 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.
Returns
(::Google::Protobuf::Map{::String => ::String}) — 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-08-28 UTC."],[],[],null,["# AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::LocalDiskInitializeParams (v1.1.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.1.0 (latest)](/ruby/docs/reference/google-cloud-notebooks-v1/latest/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [1.0.1](/ruby/docs/reference/google-cloud-notebooks-v1/1.0.1/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.11.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.11.0/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.10.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.10.0/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.9.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.9.1/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.8.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.8.2/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.7.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.7.0/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.6.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.6.1/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.5.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.5.0/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.4.2](/ruby/docs/reference/google-cloud-notebooks-v1/0.4.2/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.3.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.3.0/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.2.1](/ruby/docs/reference/google-cloud-notebooks-v1/0.2.1/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams)\n- [0.1.0](/ruby/docs/reference/google-cloud-notebooks-v1/0.1.0/Google-Cloud-Notebooks-V1-LocalDiskInitializeParams) \nReference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::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.\nThis property is mutually exclusive with the source property; you can only\ndefine one or the other, but not both. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #description\n\n def description() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Optional. Provide this property when creating the disk.\n\n### #description=\n\n def description=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Optional. Provide this property when creating the disk. \n**Returns**\n\n- (::String) --- Optional. Provide this property when creating the disk.\n\n### #disk_name\n\n def disk_name() -\u003e ::String\n\n**Returns**\n\n- (::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.\n\n### #disk_name=\n\n def disk_name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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. \n**Returns**\n\n- (::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.\n\n### #disk_size_gb\n\n def disk_size_gb() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- 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.\n\n### #disk_size_gb=\n\n def disk_size_gb=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- 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. \n**Returns**\n\n- (::Integer) --- 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.\n\n### #disk_type\n\n def disk_type() -\u003e ::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams::DiskType\n\n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams::DiskType](./Google-Cloud-Notebooks-V1-LocalDiskInitializeParams-DiskType)) --- Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).\n\n### #disk_type=\n\n def disk_type=(value) -\u003e ::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams::DiskType\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams::DiskType](./Google-Cloud-Notebooks-V1-LocalDiskInitializeParams-DiskType)) --- Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`). \n**Returns**\n\n- ([::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams::DiskType](./Google-Cloud-Notebooks-V1-LocalDiskInitializeParams-DiskType)) --- Input only. The type of the boot disk attached to this instance, defaults to standard persistent disk (`PD_STANDARD`).\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- 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.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- 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. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- 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."]]
