com.google.api.services.compute.model

Class AttachedDisk

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.AttachedDisk

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class AttachedDisk
extends com.google.api.client.json.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 Compute Engine 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

com.google.api.client.util.GenericData.Flags

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

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

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
AttachedDisk()

Method Summary

Methods

Modifier and Type	Method and Description
AttachedDisk	clone()
java.lang.Boolean	getAutoDelete() Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
java.lang.Boolean	getBoot() Indicates that this is a boot disk.
java.lang.String	getDeviceName() 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.
java.lang.Integer	getIndex() Assigns a zero-based index to this disk, where 0 is reserved for the boot disk.
AttachedDiskInitializeParams	getInitializeParams() [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance.
java.lang.String	getInterface() Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
java.lang.String	getKind() [Output Only] Type of the resource.
java.util.List<java.lang.String>	getLicenses() [Output Only] Any valid publicly visible licenses.
java.lang.String	getMode() The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
java.lang.String	getSource() Specifies a valid partial or full URL to an existing Persistent Disk resource.
java.lang.String	getType() Specifies the type of the disk, either SCRATCH or PERSISTENT.
AttachedDisk	set(java.lang.String fieldName, java.lang.Object value)
AttachedDisk	setAutoDelete(java.lang.Boolean autoDelete) Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
AttachedDisk	setBoot(java.lang.Boolean boot) Indicates that this is a boot disk.
AttachedDisk	setDeviceName(java.lang.String deviceName) 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.
AttachedDisk	setIndex(java.lang.Integer index) Assigns a zero-based index to this disk, where 0 is reserved for the boot disk.
AttachedDisk	setInitializeParams(AttachedDiskInitializeParams initializeParams) [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance.
AttachedDisk	setInterface(java.lang.String interface__) Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
AttachedDisk	setKind(java.lang.String kind) [Output Only] Type of the resource.
AttachedDisk	setLicenses(java.util.List<java.lang.String> licenses) [Output Only] Any valid publicly visible licenses.
AttachedDisk	setMode(java.lang.String mode) The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
AttachedDisk	setSource(java.lang.String source) Specifies a valid partial or full URL to an existing Persistent Disk resource.
AttachedDisk	setType(java.lang.String type) Specifies 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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AttachedDisk

public AttachedDisk()

Method Detail

getAutoDelete

public java.lang.Boolean getAutoDelete()

Specifies 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 AttachedDisk setAutoDelete(java.lang.Boolean autoDelete)

Specifies 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 java.lang.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 AttachedDisk setBoot(java.lang.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 java.lang.String getDeviceName()

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-disks-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 AttachedDisk setDeviceName(java.lang.String deviceName)

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-disks-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

getIndex

public java.lang.Integer getIndex()

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.

Returns:

value or null for none

setIndex

public AttachedDisk setIndex(java.lang.Integer index)

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value.

Parameters:

index - index or null for none

getInitializeParams

public AttachedDiskInitializeParams getInitializeParams()

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

Returns:

value or null for none

setInitializeParams

public AttachedDisk setInitializeParams(AttachedDiskInitializeParams initializeParams)

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

Parameters:

initializeParams - initializeParams or null for none

getInterface

public java.lang.String getInterface()

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.

Returns:

value or null for none

setInterface

public AttachedDisk setInterface(java.lang.String interface__)

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.

Parameters:

interface__ - interface__ or null for none

getKind

public java.lang.String getKind()

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

Returns:

value or null for none

setKind

public AttachedDisk setKind(java.lang.String kind)

[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

Parameters:

kind - kind or null for none

getLicenses

public java.util.List<java.lang.String> getLicenses()

[Output Only] Any valid publicly visible licenses.

Returns:

value or null for none

setLicenses

public AttachedDisk setLicenses(java.util.List<java.lang.String> licenses)

[Output Only] Any valid publicly visible licenses.

Parameters:

licenses - licenses or null for none

getMode

public java.lang.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.

Returns:

value or null for none

setMode

public AttachedDisk setMode(java.lang.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.

Parameters:

mode - mode or null for none

getSource

public java.lang.String getSource()

Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

Returns:

value or null for none

setSource

public AttachedDisk setSource(java.lang.String source)

Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks.

Parameters:

source - source or null for none

getType

public java.lang.String getType()

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

Returns:

value or null for none

setType

public AttachedDisk setType(java.lang.String type)

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

Parameters:

type - type or null for none

set

public AttachedDisk set(java.lang.String fieldName,
               java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public AttachedDisk clone()

Overrides:

clone in class com.google.api.client.json.GenericJson