AI Platform Notebooks V1 API - Class Google::Cloud::Notebooks::V1::Instance::Disk (v0.2.1)

Reference documentation and code samples for the AI Platform Notebooks V1 API class Google::Cloud::Notebooks::V1::Instance::Disk.

An instance-attached disk resource.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#auto_delete

def auto_delete() -> ::Boolean

Returns

(::Boolean) — Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

#auto_delete=

def auto_delete=(value) -> ::Boolean

Parameter

value (::Boolean) — Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Returns

(::Boolean) — Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

#boot

def boot() -> ::Boolean

Returns

(::Boolean) — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

#boot=

def boot=(value) -> ::Boolean

Parameter

value (::Boolean) — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Returns

(::Boolean) — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

#device_name

def device_name() -> ::String

Returns

(::String) — Indicates 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.

#device_name=

def device_name=(value) -> ::String

Parameter

value (::String) — Indicates 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.

Returns

(::String) — Indicates 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.

#disk_size_gb

def disk_size_gb() -> ::Integer

Returns

(::Integer) — Indicates the size of the disk in base-2 GB.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer

Parameter

value (::Integer) — Indicates the size of the disk in base-2 GB.

Returns

(::Integer) — Indicates the size of the disk in base-2 GB.

#guest_os_features

def guest_os_features() -> ::Array<::Google::Cloud::Notebooks::V1::Instance::Disk::GuestOsFeature>

Returns

(::Array<::Google::Cloud::Notebooks::V1::Instance::Disk::GuestOsFeature>) — 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.

#guest_os_features=

def guest_os_features=(value) -> ::Array<::Google::Cloud::Notebooks::V1::Instance::Disk::GuestOsFeature>

Parameter

value (::Array<::Google::Cloud::Notebooks::V1::Instance::Disk::GuestOsFeature>) — 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.

Returns

(::Array<::Google::Cloud::Notebooks::V1::Instance::Disk::GuestOsFeature>) — 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.

#index

def index() -> ::Integer

Returns

(::Integer) — 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.

#index=

def index=(value) -> ::Integer

Parameter

value (::Integer) — 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.

Returns

(::Integer) — 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.

#interface

def interface() -> ::String

Returns

(::String) —
Indicates 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

#interface=

def interface=(value) -> ::String

Parameter

value (::String) —
Indicates 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

Returns

(::String) —
Indicates 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

#kind

def kind() -> ::String

Returns

(::String) — Type of the resource. Always compute#attachedDisk for attached disks.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — Type of the resource. Always compute#attachedDisk for attached disks.

Returns

(::String) — Type of the resource. Always compute#attachedDisk for attached disks.

#licenses

def licenses() -> ::Array<::String>

Returns

(::Array<::String>) — A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

#licenses=

def licenses=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

Returns

(::Array<::String>) — A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

#mode

def mode() -> ::String

Returns

(::String) —
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

#mode=

def mode=(value) -> ::String

Parameter

value (::String) —
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

Returns

(::String) —
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

#source

def source() -> ::String

Returns

(::String) — Indicates a valid partial or full URL to an existing Persistent Disk resource.

#source=

def source=(value) -> ::String

Parameter

value (::String) — Indicates a valid partial or full URL to an existing Persistent Disk resource.

Returns

(::String) — Indicates a valid partial or full URL to an existing Persistent Disk resource.

#type

def type() -> ::String

Returns

(::String) —
Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:
- PERSISTENT
- SCRATCH

#type=

def type=(value) -> ::String

Parameter

value (::String) —
Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:
- PERSISTENT
- SCRATCH

Returns

(::String) —
Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:
- PERSISTENT
- SCRATCH