AttachedDiskInitializeParams (Compute Engine API beta-rev20220726-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class AttachedDiskInitializeParams
extends GenericJson
```
[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 field is persisted and returned for instanceTemplate and not returned in the context of instance. This property is mutually exclusive with the source property; you can only define one or the other, but not both.
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
  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

AttachedDiskInitializeParams()

Constructors
Constructor and Description
`AttachedDiskInitializeParams()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AttachedDiskInitializeParams`	`clone()`
`String`	`getArchitecture()` The architecture of the attached disk.
`String`	`getDescription()` An optional description.
`String`	`getDiskName()` Specifies the disk name.
`Long`	`getDiskSizeGb()` Specifies the size of the disk in base-2 GB.
`String`	`getDiskType()` Specifies the disk type to use to create the instance.
`List<GuestOsFeature>`	`getGuestOsFeatures()` A list of features to enable on the guest operating system.
`Map<String,String>`	`getLabels()` Labels to apply to this disk.
`List<String>`	`getLicenses()` A list of publicly visible licenses.
`Boolean`	`getMultiWriter()` Indicates whether or not the disk can be read/write attached to more than one instance.
`String`	`getOnUpdateAction()` Specifies which action to take on instance update with this disk.
`Long`	`getProvisionedIops()` Indicates how many IOPS to provision for the disk.
`Map<String,String>`	`getResourceManagerTags()` Resource manager tags to be bound to the disk.
`List<String>`	`getResourcePolicies()` Resource policies applied to this disk for automatic snapshot creations.
`String`	`getSourceImage()` The source image to create this disk.
`CustomerEncryptionKey`	`getSourceImageEncryptionKey()` The customer-supplied encryption key of the source image.
`String`	`getSourceSnapshot()` The source snapshot to create this disk.
`CustomerEncryptionKey`	`getSourceSnapshotEncryptionKey()` The customer-supplied encryption key of the source snapshot.
`AttachedDiskInitializeParams`	`set(String fieldName, Object value)`
`AttachedDiskInitializeParams`	`setArchitecture(String architecture)` The architecture of the attached disk.
`AttachedDiskInitializeParams`	`setDescription(String description)` An optional description.
`AttachedDiskInitializeParams`	`setDiskName(String diskName)` Specifies the disk name.
`AttachedDiskInitializeParams`	`setDiskSizeGb(Long diskSizeGb)` Specifies the size of the disk in base-2 GB.
`AttachedDiskInitializeParams`	`setDiskType(String diskType)` Specifies the disk type to use to create the instance.
`AttachedDiskInitializeParams`	`setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)` A list of features to enable on the guest operating system.
`AttachedDiskInitializeParams`	`setLabels(Map<String,String> labels)` Labels to apply to this disk.
`AttachedDiskInitializeParams`	`setLicenses(List<String> licenses)` A list of publicly visible licenses.
`AttachedDiskInitializeParams`	`setMultiWriter(Boolean multiWriter)` Indicates whether or not the disk can be read/write attached to more than one instance.
`AttachedDiskInitializeParams`	`setOnUpdateAction(String onUpdateAction)` Specifies which action to take on instance update with this disk.
`AttachedDiskInitializeParams`	`setProvisionedIops(Long provisionedIops)` Indicates how many IOPS to provision for the disk.
`AttachedDiskInitializeParams`	`setResourceManagerTags(Map<String,String> resourceManagerTags)` Resource manager tags to be bound to the disk.
`AttachedDiskInitializeParams`	`setResourcePolicies(List<String> resourcePolicies)` Resource policies applied to this disk for automatic snapshot creations.
`AttachedDiskInitializeParams`	`setSourceImage(String sourceImage)` The source image to create this disk.
`AttachedDiskInitializeParams`	`setSourceImageEncryptionKey(CustomerEncryptionKey sourceImageEncryptionKey)` The customer-supplied encryption key of the source image.
`AttachedDiskInitializeParams`	`setSourceSnapshot(String sourceSnapshot)` The source snapshot to create this disk.
`AttachedDiskInitializeParams`	`setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)` The customer-supplied encryption key of the source snapshot.

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
  - AttachedDiskInitializeParams
```
public AttachedDiskInitializeParams()
```
- Method Detail
  - getArchitecture
```
public String getArchitecture()
```
    The architecture of the attached disk. Valid values are arm64 or x86_64.
    
    Returns:
    
    value or null for none
  - setArchitecture
```
public AttachedDiskInitializeParams setArchitecture(String architecture)
```
    The architecture of the attached disk. Valid values are arm64 or x86_64.
    
    Parameters:
    
    architecture - architecture or null for none
  - getDescription
```
public String getDescription()
```
    An optional description. Provide this property when creating the disk.
    
    Returns:
    
    value or null for none
  - setDescription
```
public AttachedDiskInitializeParams setDescription(String description)
```
    An optional description. Provide this property when creating the disk.
    
    Parameters:
    
    description - description or null for none
  - getDiskName
```
public String getDiskName()
```
    Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
    
    Returns:
    
    value or null for none
  - setDiskName
```
public AttachedDiskInitializeParams setDiskName(String diskName)
```
    Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.
    
    Parameters:
    
    diskName - diskName or null for none
  - getDiskSizeGb
```
public Long getDiskSizeGb()
```
    Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
    
    Returns:
    
    value or null for none
  - setDiskSizeGb
```
public AttachedDiskInitializeParams setDiskSizeGb(Long diskSizeGb)
```
    Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.
    
    Parameters:
    
    diskSizeGb - diskSizeGb or null for none
  - getDiskType
```
public String getDiskType()
```
    Specifies the disk type to use to create the instance. If not specified, the default is pd- standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
    
    Returns:
    
    value or null for none
  - setDiskType
```
public AttachedDiskInitializeParams setDiskType(String diskType)
```
    Specifies the disk type to use to create the instance. If not specified, the default is pd- standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you define this field, you can provide either the full or partial URL. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this is the name of the disk type, not URL.
    
    Parameters:
    
    diskType - diskType 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
    
    Returns:
    
    value or null for none
  - setGuestOsFeatures
```
public AttachedDiskInitializeParams 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. Guest OS features are applied by merging initializeParams.guestOsFeatures and disks.guestOsFeatures
    
    Parameters:
    
    guestOsFeatures - guestOsFeatures or null for none
  - getLabels
```
public Map<String,String> getLabels()
```
    Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
    
    Returns:
    
    value or null for none
  - setLabels
```
public AttachedDiskInitializeParams setLabels(Map<String,String> labels)
```
    Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.
    
    Parameters:
    
    labels - labels or null for none
  - getLicenses
```
public List<String> getLicenses()
```
    A list of publicly visible licenses. Reserved for Google's use.
    
    Returns:
    
    value or null for none
  - setLicenses
```
public AttachedDiskInitializeParams setLicenses(List<String> licenses)
```
    A list of publicly visible licenses. Reserved for Google's use.
    
    Parameters:
    
    licenses - licenses or null for none
  - getMultiWriter
```
public Boolean getMultiWriter()
```
    Indicates whether or not the disk can be read/write attached to more than one instance.
    
    Returns:
    
    value or null for none
  - setMultiWriter
```
public AttachedDiskInitializeParams setMultiWriter(Boolean multiWriter)
```
    Indicates whether or not the disk can be read/write attached to more than one instance.
    
    Parameters:
    
    multiWriter - multiWriter or null for none
  - getOnUpdateAction
```
public String getOnUpdateAction()
```
    Specifies which action to take on instance update with this disk. Default is to use the existing disk.
    
    Returns:
    
    value or null for none
  - setOnUpdateAction
```
public AttachedDiskInitializeParams setOnUpdateAction(String onUpdateAction)
```
    Specifies which action to take on instance update with this disk. Default is to use the existing disk.
    
    Parameters:
    
    onUpdateAction - onUpdateAction or null for none
  - getProvisionedIops
```
public Long getProvisionedIops()
```
    Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
    
    Returns:
    
    value or null for none
  - setProvisionedIops
```
public AttachedDiskInitializeParams setProvisionedIops(Long provisionedIops)
```
    Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.
    
    Parameters:
    
    provisionedIops - provisionedIops or null for none
  - getResourceManagerTags
```
public Map<String,String> getResourceManagerTags()
```
    Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
    
    Returns:
    
    value or null for none
  - setResourceManagerTags
```
public AttachedDiskInitializeParams setResourceManagerTags(Map<String,String> resourceManagerTags)
```
    Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format `tagKeys/{tag_key_id}`, and values are in the format `tagValues/456`. The field is ignored (both PUT & PATCH) when empty.
    
    Parameters:
    
    resourceManagerTags - resourceManagerTags or null for none
  - getResourcePolicies
```
public List<String> getResourcePolicies()
```
    Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
    
    Returns:
    
    value or null for none
  - setResourcePolicies
```
public AttachedDiskInitializeParams setResourcePolicies(List<String> resourcePolicies)
```
    Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.
    
    Parameters:
    
    resourcePolicies - resourcePolicies or null for none
  - getSourceImage
```
public String getSourceImage()
```
    The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9 -stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.
    
    Returns:
    
    value or null for none
  - setSourceImage
```
public AttachedDiskInitializeParams setSourceImage(String sourceImage)
```
    The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9 -stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.
    
    Parameters:
    
    sourceImage - sourceImage or null for none
  - getSourceImageEncryptionKey
```
public CustomerEncryptionKey getSourceImageEncryptionKey()
```
    The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer- supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
    
    Returns:
    
    value or null for none
  - setSourceImageEncryptionKey
```
public AttachedDiskInitializeParams setSourceImageEncryptionKey(CustomerEncryptionKey sourceImageEncryptionKey)
```
    The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Instance templates do not store customer- supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.
    
    Parameters:
    
    sourceImageEncryptionKey - sourceImageEncryptionKey or null for none
  - getSourceSnapshot
```
public String getSourceSnapshot()
```
    The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.
    
    Returns:
    
    value or null for none
  - setSourceSnapshot
```
public AttachedDiskInitializeParams setSourceSnapshot(String sourceSnapshot)
```
    The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.
    
    Parameters:
    
    sourceSnapshot - sourceSnapshot or null for none
  - getSourceSnapshotEncryptionKey
```
public CustomerEncryptionKey getSourceSnapshotEncryptionKey()
```
    The customer-supplied encryption key of the source snapshot.
    
    Returns:
    
    value or null for none
  - setSourceSnapshotEncryptionKey
```
public AttachedDiskInitializeParams setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)
```
    The customer-supplied encryption key of the source snapshot.
    
    Parameters:
    
    sourceSnapshotEncryptionKey - sourceSnapshotEncryptionKey or null for none
  - set
```
public AttachedDiskInitializeParams set(String fieldName,
                                        Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public AttachedDiskInitializeParams clone()
```
    Overrides:
    
    clone in class GenericJson

Class AttachedDiskInitializeParams

Nested Class Summary

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

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

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AttachedDiskInitializeParams

Method Detail

getArchitecture

setArchitecture

getDescription

setDescription

getDiskName

setDiskName

getDiskSizeGb

setDiskSizeGb

getDiskType

setDiskType

getGuestOsFeatures

setGuestOsFeatures

getLabels

setLabels

getLicenses

setLicenses

getMultiWriter

setMultiWriter

getOnUpdateAction

setOnUpdateAction

getProvisionedIops

setProvisionedIops

getResourceManagerTags

setResourceManagerTags

getResourcePolicies

setResourcePolicies

getSourceImage

setSourceImage

getSourceImageEncryptionKey

setSourceImageEncryptionKey

getSourceSnapshot

setSourceSnapshot

getSourceSnapshotEncryptionKey

setSourceSnapshotEncryptionKey

set

clone