AI Platform Notebooks v1 API - Class LocalDisk (2.3.0)

public sealed class LocalDisk : IMessage<LocalDisk>, IEquatable<LocalDisk>, IDeepCloneable<LocalDisk>, IBufferMessage, IMessage

Reference documentation and code samples for the AI Platform Notebooks v1 API class LocalDisk.

A Local attached disk resource.

Inheritance

object > LocalDisk

Namespace

Google.Cloud.Notebooks.V1

Assembly

Google.Cloud.Notebooks.V1.dll

Constructors

LocalDisk()

public LocalDisk()

LocalDisk(LocalDisk)

public LocalDisk(LocalDisk other)
Parameter
NameDescription
otherLocalDisk

Properties

AutoDelete

public bool AutoDelete { get; set; }

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

Property Value
TypeDescription
bool

Boot

public bool Boot { get; set; }

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

Property Value
TypeDescription
bool

DeviceName

public string DeviceName { get; set; }

Optional. Output only. Specifies a unique device name of your choice that is reflected into the /dev/disk/by-id/google-* tree of a Linux operating system running within the instance. This name can be used to reference the device for mounting, resizing, and so on, from within the instance.

If not specified, the server chooses a default device name to apply to this disk, in the form persistent-disk-x, where x is a number assigned by Google Compute Engine. This field is only applicable for persistent disks.

Property Value
TypeDescription
string

GuestOsFeatures

public RepeatedField<LocalDisk.Types.RuntimeGuestOsFeature> GuestOsFeatures { get; }

Output only. Indicates a list of features to enable on the guest operating system. Applicable only for bootable images. Read Enabling guest operating system features to see a list of available options.

Property Value
TypeDescription
RepeatedFieldLocalDiskTypesRuntimeGuestOsFeature

Index

public int Index { get; set; }

Output only. A zero-based index to this disk, where 0 is reserved for the boot disk. If you have many disks attached to an instance, each disk would have a unique index number.

Property Value
TypeDescription
int

InitializeParams

public LocalDiskInitializeParams InitializeParams { get; set; }

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 instance.

This property is mutually exclusive with the source property; you can only define one or the other, but not both.

Property Value
TypeDescription
LocalDiskInitializeParams

Interface

public string Interface { get; set; }

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. Persistent disks must always use SCSI and the request will fail if you attempt to attach a persistent disk in any other format than SCSI. Local SSDs can use either NVME or SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance. Valid values:

  • NVME
  • SCSI
Property Value
TypeDescription
string

Kind

public string Kind { get; set; }

Output only. Type of the resource. Always compute#attachedDisk for attached disks.

Property Value
TypeDescription
string

Licenses

public RepeatedField<string> Licenses { get; }

Output only. Any valid publicly visible licenses.

Property Value
TypeDescription
RepeatedFieldstring

Mode

public string Mode { get; set; }

The mode in which to attach this disk, either READ_WRITE or READ_ONLY. If not specified, the default is to attach the disk in READ_WRITE mode. Valid values:

  • READ_ONLY
  • READ_WRITE
Property Value
TypeDescription
string

Source

public string Source { get; set; }

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

Property Value
TypeDescription
string

Type

public string Type { get; set; }

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values:

  • PERSISTENT
  • SCRATCH
Property Value
TypeDescription
string