com.google.api.services.notebooks.v1.model

Class Disk

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.notebooks.v1.model.Disk

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Disk
extends GenericJson

An instance-attached disk resource.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Notebooks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Disk()

Method Summary

Modifier and Type	Method and Description
Disk	clone()
Boolean	getAutoDelete() Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Boolean	getBoot() Indicates that this is a boot disk.
String	getDeviceName() 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.
Long	getDiskSizeGb() Indicates the size of the disk in base-2 GB.
List<GuestOsFeature>	getGuestOsFeatures() Indicates a list of features to enable on the guest operating system.
Long	getIndex() A zero-based index to this disk, where 0 is reserved for the boot disk.
String	getInterface() Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME.
String	getKind() Type of the resource.
List<String>	getLicenses() A list of publicly visible licenses.
String	getMode() The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
String	getSource() Indicates a valid partial or full URL to an existing Persistent Disk resource.
String	getType() Indicates the type of the disk, either SCRATCH or PERSISTENT.
Disk	set(String fieldName, Object value)
Disk	setAutoDelete(Boolean autoDelete) Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
Disk	setBoot(Boolean boot) Indicates that this is a boot disk.
Disk	setDeviceName(String deviceName) 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.
Disk	setDiskSizeGb(Long diskSizeGb) Indicates the size of the disk in base-2 GB.
Disk	setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures) Indicates a list of features to enable on the guest operating system.
Disk	setIndex(Long index) A zero-based index to this disk, where 0 is reserved for the boot disk.
Disk	setInterface(String interface__) Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME.
Disk	setKind(String kind) Type of the resource.
Disk	setLicenses(List<String> licenses) A list of publicly visible licenses.
Disk	setMode(String mode) The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
Disk	setSource(String source) Indicates a valid partial or full URL to an existing Persistent Disk resource.
Disk	setType(String type) Indicates the type of the disk, either SCRATCH or PERSISTENT.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Disk

public Disk()

Method Detail

getAutoDelete

public Boolean getAutoDelete()

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

Returns:

value or null for none

setAutoDelete

public Disk setAutoDelete(Boolean autoDelete)

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

Parameters:

autoDelete - autoDelete or null for none

getBoot

public Boolean getBoot()

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

Returns:

value or null for none

setBoot

public Disk setBoot(Boolean boot)

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

Parameters:

boot - boot or null for none

getDeviceName

public String getDeviceName()

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:

value or null for none

setDeviceName

public Disk setDeviceName(String deviceName)

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.

Parameters:

deviceName - deviceName or null for none

getDiskSizeGb

public Long getDiskSizeGb()

Indicates the size of the disk in base-2 GB.

Returns:

value or null for none

setDiskSizeGb

public Disk setDiskSizeGb(Long diskSizeGb)

Indicates the size of the disk in base-2 GB.

Parameters:

diskSizeGb - diskSizeGb or null for none

getGuestOsFeatures

public List<GuestOsFeature> getGuestOsFeatures()

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:

value or null for none

setGuestOsFeatures

public Disk setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)

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.

Parameters:

guestOsFeatures - guestOsFeatures or null for none

getIndex

public Long getIndex()

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:

value or null for none

setIndex

public Disk setIndex(Long index)

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.

Parameters:

index - index or null for none

getInterface

public String getInterface()

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:

value or null for none

setInterface

public Disk setInterface(String interface__)

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

Parameters:

interface__ - interface__ or null for none

getKind

public String getKind()

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

Returns:

value or null for none

setKind

public Disk setKind(String kind)

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

Parameters:

kind - kind or null for none

getLicenses

public List<String> getLicenses()

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:

value or null for none

setLicenses

public Disk setLicenses(List<String> licenses)

A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

Parameters:

licenses - licenses or null for none

getMode

public String getMode()

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:

value or null for none

setMode

public Disk setMode(String mode)

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

Parameters:

mode - mode or null for none

getSource

public String getSource()

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

Returns:

value or null for none

setSource

public Disk setSource(String source)

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

Parameters:

source - source or null for none

getType

public String getType()

Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH

Returns:

value or null for none

setType

public Disk setType(String type)

Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values: * PERSISTENT * SCRATCH

Parameters:

type - type or null for none

set

public Disk set(String fieldName,
                Object value)

Overrides:

set in class GenericJson

clone

public Disk clone()

Overrides:

clone in class GenericJson