Google Cloud Notebooks V1 Client - Class LocalDiskInitializeParams (0.6.2)

Version 0.6.2

• 1.0.1 (latest)
• 1.0.0
• 0.7.5
• 0.6.2
• 0.5.0
• 0.4.1
• 0.3.6

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 message google.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).
↳ labels	array|Google\Protobuf\Internal\MapField 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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this