AttachedDisk.Builder (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.AttachedDisk.Builder

Enclosing class:: AttachedDisk

public static class AttachedDisk.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachedDisk.Builder`	`addAllGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)` A list of features to enable on the guest operating system.
`AttachedDisk.Builder`	`addAllLicenses(List<String> licenses)` [Output Only] Any valid publicly visible licenses.
`AttachedDisk.Builder`	`addGuestOsFeatures(GuestOsFeature guestOsFeatures)` A list of features to enable on the guest operating system.
`AttachedDisk.Builder`	`addLicenses(String licenses)` [Output Only] Any valid publicly visible licenses.
`AttachedDisk`	`build()`
`AttachedDisk.Builder`	`clone()`
`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.
`List<GuestOsFeature>`	`getGuestOsFeaturesList()` 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>`	`getLicensesList()` [Output Only] Any valid publicly visible licenses.
`String`	`getMode()` The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
`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.Builder`	`mergeFrom(AttachedDisk other)`
`AttachedDisk.Builder`	`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.Builder`	`setBoot(Boolean boot)` Indicates that this is a boot disk.
`AttachedDisk.Builder`	`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.Builder`	`setDiskEncryptionKey(CustomerEncryptionKey diskEncryptionKey)` Encrypts or decrypts a disk using a customer-supplied encryption key.
`AttachedDisk.Builder`	`setIndex(Integer index)` [Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk.
`AttachedDisk.Builder`	`setInitializeParams(AttachedDiskInitializeParams initializeParams)` [Input Only] Specifies the parameters for a new disk that will be created alongside the new instance.
`AttachedDisk.Builder`	`setInterface(String interface2)` Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
`AttachedDisk.Builder`	`setKind(String kind)` [Output Only] Type of the resource.
`AttachedDisk.Builder`	`setMode(String mode)` The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
`AttachedDisk.Builder`	`setSource(String source)` Specifies a valid partial or full URL to an existing Persistent Disk resource.
`AttachedDisk.Builder`	`setType(String type)` Specifies the type of the disk, either SCRATCH or PERSISTENT.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - mergeFrom
```
public AttachedDisk.Builder mergeFrom(AttachedDisk other)
```
  - 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).
  - setAutoDelete
```
public AttachedDisk.Builder 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).
  - 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.
  - setBoot
```
public AttachedDisk.Builder 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.
  - 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.
  - setDeviceName
```
public AttachedDisk.Builder 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.
  - 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.
    Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
  - setDiskEncryptionKey
```
public AttachedDisk.Builder 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.
    Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group.
  - getGuestOsFeaturesList
```
public List<GuestOsFeature> getGuestOsFeaturesList()
```
    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.
  - addAllGuestOsFeatures
```
public AttachedDisk.Builder addAllGuestOsFeatures(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.
  - addGuestOsFeatures
```
public AttachedDisk.Builder addGuestOsFeatures(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.
  - 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.
  - setIndex
```
public AttachedDisk.Builder 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.
  - 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.
  - setInitializeParams
```
public AttachedDisk.Builder 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.
  - getInterface
```
public 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. TODO(b/131765817): Update documentation when NVME is supported.
  - setInterface
```
public AttachedDisk.Builder setInterface(String interface2)
```
    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. TODO(b/131765817): Update documentation when NVME is supported.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
  - setKind
```
public AttachedDisk.Builder setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.
  - getLicensesList
```
public List<String> getLicensesList()
```
    [Output Only] Any valid publicly visible licenses.
  - addAllLicenses
```
public AttachedDisk.Builder addAllLicenses(List<String> licenses)
```
    [Output Only] Any valid publicly visible licenses.
  - addLicenses
```
public AttachedDisk.Builder addLicenses(String licenses)
```
    [Output Only] Any valid publicly visible licenses.
  - 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.
  - setMode
```
public AttachedDisk.Builder 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.
  - getSource
```
public String getSource()
```
    Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
    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, not the URL for the disk.
  - setSource
```
public AttachedDisk.Builder setSource(String source)
```
    Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD.
    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, not the URL for the disk.
  - getType
```
public String getType()
```
    Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
  - setType
```
public AttachedDisk.Builder setType(String type)
```
    Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT.
  - build
```
public AttachedDisk build()
```
  - clone
```
public AttachedDisk.Builder clone()
```
    Overrides:
    
    clone in class Object

Class AttachedDisk.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getAutoDelete

setAutoDelete

getBoot

setBoot

getDeviceName

setDeviceName

getDiskEncryptionKey

setDiskEncryptionKey

getGuestOsFeaturesList

addAllGuestOsFeatures

addGuestOsFeatures

getIndex

setIndex

getInitializeParams

setInitializeParams

getInterface

setInterface

getKind

setKind

getLicensesList

addAllLicenses

addLicenses

getMode

setMode

getSource

setSource

getType

setType

build

clone