target.apidocs.com.google.api.services.compute.model.AttachedDisk.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

The newest version!







AttachedDisk (Compute Engine API v1-rev20250320-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








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



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


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













All Implemented Interfaces:
Cloneable, Map<String,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
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


AttachedDisk() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AttachedDisk
clone() 


String
getArchitecture()
[Output Only] The architecture of the attached disk.



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



Boolean
getBoot()
Indicates that this is a boot disk.



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.



CustomerEncryptionKey
getDiskEncryptionKey()
Encrypts or decrypts a disk using a customer-supplied encryption key.



Long
getDiskSizeGb()
The size of the disk in GB.



Boolean
getForceAttach()
[Input Only] Whether to force attach the regional disk even if it's currently attached to
 another instance.



List<GuestOsFeature>
getGuestOsFeatures()
A list of features to enable on the guest operating system.



Integer
getIndex()
[Output Only] 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.



String
getInterface()
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.



String
getKind()
[Output Only] Type of the resource.



List<String>
getLicenses()
[Output Only] Any valid publicly visible licenses.



String
getMode()
The mode in which to attach this disk, either READ_WRITE or READ_ONLY.



String
getSavedState()
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to
 PRESERVED if the LocalSSD data has been saved to a persistent location by customer request.



InitialStateConfig
getShieldedInstanceInitialState()
[Output Only] shielded vm initial state stored on disk



String
getSource()
Specifies a valid partial or full URL to an existing Persistent Disk resource.



String
getType()
Specifies the type of the disk, either SCRATCH or PERSISTENT.



AttachedDisk
set(String fieldName,
   Object value) 


AttachedDisk
setArchitecture(String architecture)
[Output Only] The architecture of the attached disk.



AttachedDisk
setAutoDelete(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(Boolean boot)
Indicates that this is a boot disk.



AttachedDisk
setDeviceName(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
setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)
Encrypts or decrypts a disk using a customer-supplied encryption key.



AttachedDisk
setDiskSizeGb(Long diskSizeGb)
The size of the disk in GB.



AttachedDisk
setForceAttach(Boolean forceAttach)
[Input Only] Whether to force attach the regional disk even if it's currently attached to
 another instance.



AttachedDisk
setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)
A list of features to enable on the guest operating system.



AttachedDisk
setIndex(Integer index)
[Output Only] 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(String interface__)
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.



AttachedDisk
setKind(String kind)
[Output Only] Type of the resource.



AttachedDisk
setLicenses(List<String> licenses)
[Output Only] Any valid publicly visible licenses.



AttachedDisk
setMode(String mode)
The mode in which to attach this disk, either READ_WRITE or READ_ONLY.



AttachedDisk
setSavedState(String savedState)
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to
 PRESERVED if the LocalSSD data has been saved to a persistent location by customer request.



AttachedDisk
setShieldedInstanceInitialState(InitialStateConfig shieldedInstanceInitialState)
[Output Only] shielded vm initial state stored on disk



AttachedDisk
setSource(String source)
Specifies a valid partial or full URL to an existing Persistent Disk resource.



AttachedDisk
setType(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, 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





AttachedDisk
public AttachedDisk()









Method Detail





getArchitecture
public String getArchitecture()
[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.

Returns:
value or null for none








setArchitecture
public AttachedDisk setArchitecture(String architecture)
[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64.

Parameters:
architecture - architecture or null for none








getAutoDelete
public 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(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 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(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()
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.

Returns:
value or null for none








setDeviceName
public AttachedDisk setDeviceName(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-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








getDiskEncryptionKey
public CustomerEncryptionKey getDiskEncryptionKey()
Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new
 disk, this field encrypts the new disk using an encryption key that you provide. If you are
 attaching an existing disk that is already encrypted, this field decrypts the disk using the
 customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must
 provide the same key again when you attempt to use this resource at a later time. For example,
 you must provide the key when you create a snapshot or an image from the disk or when you
 attach the disk to a virtual machine instance. If you do not provide an encryption key, then
 the disk will be encrypted using an automatically generated key and you do not need to provide
 a key to use the disk later. Note: Instance templates do not store customer-supplied encryption
 keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot
 create VMs that have disks with customer-supplied keys using the bulk insert method.

Returns:
value or null for none








setDiskEncryptionKey
public AttachedDisk setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)
Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new
 disk, this field encrypts the new disk using an encryption key that you provide. If you are
 attaching an existing disk that is already encrypted, this field decrypts the disk using the
 customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must
 provide the same key again when you attempt to use this resource at a later time. For example,
 you must provide the key when you create a snapshot or an image from the disk or when you
 attach the disk to a virtual machine instance. If you do not provide an encryption key, then
 the disk will be encrypted using an automatically generated key and you do not need to provide
 a key to use the disk later. Note: Instance templates do not store customer-supplied encryption
 keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot
 create VMs that have disks with customer-supplied keys using the bulk insert method.

Parameters:
diskEncryptionKey - diskEncryptionKey or null for none








getDiskSizeGb
public Long getDiskSizeGb()
The size of the disk in GB.

Returns:
value or null for none








setDiskSizeGb
public AttachedDisk setDiskSizeGb(Long diskSizeGb)
The size of the disk in GB.

Parameters:
diskSizeGb - diskSizeGb or null for none








getForceAttach
public Boolean getForceAttach()
[Input Only] Whether to force attach the regional disk even if it's currently attached to
 another instance. If you try to force attach a zonal disk to an instance, you will receive an
 error.

Returns:
value or null for none








setForceAttach
public AttachedDisk setForceAttach(Boolean forceAttach)
[Input Only] Whether to force attach the regional disk even if it's currently attached to
 another instance. If you try to force attach a zonal disk to an instance, you will receive an
 error.

Parameters:
forceAttach - forceAttach or null for none








getGuestOsFeatures
public List<GuestOsFeature> getGuestOsFeatures()
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 AttachedDisk setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)
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 Integer getIndex()
[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.

Returns:
value or null for none








setIndex
public AttachedDisk setIndex(Integer index)
[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.

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 String getInterface()
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For
 most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain
 configurations, persistent disks can use NVMe. For more information, see About persistent
 disks.

Returns:
value or null for none








setInterface
public AttachedDisk setInterface(String interface__)
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For
 most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain
 configurations, persistent disks can use NVMe. For more information, see About persistent
 disks.

Parameters:
interface__ - interface__ or null for none








getKind
public String getKind()
[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

Returns:
value or null for none








setKind
public AttachedDisk setKind(String kind)
[Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

Parameters:
kind - kind or null for none








getLicenses
public List<String> getLicenses()
[Output Only] Any valid publicly visible licenses.

Returns:
value or null for none








setLicenses
public AttachedDisk setLicenses(List<String> licenses)
[Output Only] Any valid publicly visible licenses.

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.

Returns:
value or null for none








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

Parameters:
mode - mode or null for none








getSavedState
public String getSavedState()
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to
 PRESERVED if the LocalSSD data has been saved to a persistent location by customer request.
 (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

Returns:
value or null for none








setSavedState
public AttachedDisk setSavedState(String savedState)
For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to
 PRESERVED if the LocalSSD data has been saved to a persistent location by customer request.
 (see the discard_local_ssd option on Stop/Suspend). Read-only in the api.

Parameters:
savedState - savedState or null for none








getShieldedInstanceInitialState
public InitialStateConfig getShieldedInstanceInitialState()
[Output Only] shielded vm initial state stored on disk

Returns:
value or null for none








setShieldedInstanceInitialState
public AttachedDisk setShieldedInstanceInitialState(InitialStateConfig shieldedInstanceInitialState)
[Output Only] shielded vm initial state stored on disk

Parameters:
shieldedInstanceInitialState - shieldedInstanceInitialState or null for none








getSource
public String getSource()
Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a
 new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot
 or disks.source is required. If desired, you can also attach existing non-root persistent disks
 using this property. This field is only applicable for persistent disks. Note that for
 InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.

Returns:
value or null for none








setSource
public AttachedDisk setSource(String source)
Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a
 new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot
 or disks.source is required. If desired, you can also attach existing non-root persistent disks
 using this property. This field is only applicable for persistent disks. Note that for
 InstanceTemplate, specify the disk name for zonal disk, and the URL for regional disk.

Parameters:
source - source or null for none








getType
public 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(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(String fieldName,
                        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














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2025 Google. All rights reserved.

Modifier and Type	Method and Description
`AttachedDisk`	`clone()`
`String`	`getArchitecture()` [Output Only] The architecture of the attached disk.
`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).
`Boolean`	`getBoot()` Indicates that this is a boot disk.
`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.
`CustomerEncryptionKey`	`getDiskEncryptionKey()` Encrypts or decrypts a disk using a customer-supplied encryption key.
`Long`	`getDiskSizeGb()` The size of the disk in GB.
`Boolean`	`getForceAttach()` [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance.
`List<GuestOsFeature>`	`getGuestOsFeatures()` A list of features to enable on the guest operating system.
`Integer`	`getIndex()` [Output Only] 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.
`String`	`getInterface()` Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
`String`	`getKind()` [Output Only] Type of the resource.
`List<String>`	`getLicenses()` [Output Only] Any valid publicly visible licenses.
`String`	`getMode()` The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
`String`	`getSavedState()` For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request.
`InitialStateConfig`	`getShieldedInstanceInitialState()` [Output Only] shielded vm initial state stored on disk
`String`	`getSource()` Specifies a valid partial or full URL to an existing Persistent Disk resource.
`String`	`getType()` Specifies the type of the disk, either SCRATCH or PERSISTENT.
`AttachedDisk`	`set(String fieldName, Object value)`
`AttachedDisk`	`setArchitecture(String architecture)` [Output Only] The architecture of the attached disk.
`AttachedDisk`	`setAutoDelete(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(Boolean boot)` Indicates that this is a boot disk.
`AttachedDisk`	`setDeviceName(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`	`setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)` Encrypts or decrypts a disk using a customer-supplied encryption key.
`AttachedDisk`	`setDiskSizeGb(Long diskSizeGb)` The size of the disk in GB.
`AttachedDisk`	`setForceAttach(Boolean forceAttach)` [Input Only] Whether to force attach the regional disk even if it's currently attached to another instance.
`AttachedDisk`	`setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)` A list of features to enable on the guest operating system.
`AttachedDisk`	`setIndex(Integer index)` [Output Only] 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(String interface__)` Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
`AttachedDisk`	`setKind(String kind)` [Output Only] Type of the resource.
`AttachedDisk`	`setLicenses(List<String> licenses)` [Output Only] Any valid publicly visible licenses.
`AttachedDisk`	`setMode(String mode)` The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
`AttachedDisk`	`setSavedState(String savedState)` For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request.
`AttachedDisk`	`setShieldedInstanceInitialState(InitialStateConfig shieldedInstanceInitialState)` [Output Only] shielded vm initial state stored on disk
`AttachedDisk`	`setSource(String source)` Specifies a valid partial or full URL to an existing Persistent Disk resource.
`AttachedDisk`	`setType(String type)` Specifies the type of the disk, either SCRATCH or PERSISTENT.