• Home
• com.google.apis
• google-api-services-compute
• v1-rev20250320-2.0.0
• source code
• AttachedDiskInitializeParams.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

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 AttachedDiskInitializeParams



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 com.google.api.client.json.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
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


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.



Boolean
getEnableConfidentialCompute()
Whether this disk is using confidential compute mode.



Map<String,String>
getLabels()
Labels to apply to this disk.



List<String>
getLicenses()
A list of publicly visible licenses.



String
getOnUpdateAction()
Specifies which action to take on instance update with this disk.



Long
getProvisionedIops()
Indicates how many IOPS to provision for the disk.



Long
getProvisionedThroughput()
Indicates how much throughput to provision for the disk.



List<String>
getReplicaZones()
Required for each regional disk associated with the instance.



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.



String
getStoragePool()
The storage pool in which the new disk is created.



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
setEnableConfidentialCompute(Boolean enableConfidentialCompute)
Whether this disk is using confidential compute mode.



AttachedDiskInitializeParams
setLabels(Map<String,String> labels)
Labels to apply to this disk.



AttachedDiskInitializeParams
setLicenses(List<String> licenses)
A list of publicly visible licenses.



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
setProvisionedThroughput(Long provisionedThroughput)
Indicates how much throughput to provision for the disk.



AttachedDiskInitializeParams
setReplicaZones(List<String> replicaZones)
Required for each regional disk associated with the instance.



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.



AttachedDiskInitializeParams
setStoragePool(String storagePool)
The storage pool in which the new disk is created.







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 specify this field when
 creating a VM, you can provide either the full or partial URL. For example, the following
 values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone
 /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType -
 zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance
 template or all-instances configuration, specify the type of the disk, not the URL. For
 example: pd-standard.

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 specify this field when
 creating a VM, you can provide either the full or partial URL. For example, the following
 values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone
 /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType -
 zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance
 template or all-instances configuration, specify the type of the disk, not the URL. For
 example: pd-standard.

Parameters:
diskType - diskType or null for none








getEnableConfidentialCompute
public Boolean getEnableConfidentialCompute()
Whether this disk is using confidential compute mode.

Returns:
value or null for none








setEnableConfidentialCompute
public AttachedDiskInitializeParams setEnableConfidentialCompute(Boolean enableConfidentialCompute)
Whether this disk is using confidential compute mode.

Parameters:
enableConfidentialCompute - enableConfidentialCompute 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








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








getProvisionedThroughput
public Long getProvisionedThroughput()
Indicates how much throughput to provision for the disk. This sets the number of throughput mb
 per second that the disk can handle. Values must greater than or equal to 1.

Returns:
value or null for none








setProvisionedThroughput
public AttachedDiskInitializeParams setProvisionedThroughput(Long provisionedThroughput)
Indicates how much throughput to provision for the disk. This sets the number of throughput mb
 per second that the disk can handle. Values must greater than or equal to 1.

Parameters:
provisionedThroughput - provisionedThroughput or null for none








getReplicaZones
public List<String> getReplicaZones()
Required for each regional disk associated with the instance. Specify the URLs of the zones
 where the disk should be replicated to. You must provide exactly two replica zones, and one
 zone must be the same as the instance zone.

Returns:
value or null for none








setReplicaZones
public AttachedDiskInitializeParams setReplicaZones(List<String> replicaZones)
Required for each regional disk associated with the instance. Specify the URLs of the zones
 where the disk should be replicated to. You must provide exactly two replica zones, and one
 zone must be the same as the instance zone.

Parameters:
replicaZones - replicaZones 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 boot disk, one of
 initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. 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 boot disk, one of
 initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. 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. InstanceTemplate and InstancePropertiesPatch
 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. InstanceTemplate and InstancePropertiesPatch
 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 boot disk, one of
 initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. 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. Note: You cannot create VMs in bulk using a snapshot as the source. Use an image
 instead when you create VMs using the bulk insert method.

Returns:
value or null for none








setSourceSnapshot
public AttachedDiskInitializeParams setSourceSnapshot(String sourceSnapshot)
The source snapshot to create this disk. When creating a new instance boot disk, one of
 initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required. 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. Note: You cannot create VMs in bulk using a snapshot as the source. Use an image
 instead when you create VMs using the bulk insert method.

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








getStoragePool
public String getStoragePool()
The storage pool in which the new disk is created. You can provide this as a partial or full
 URL to the resource. For example, the following are valid values: -
 https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool -
 projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

Returns:
value or null for none








setStoragePool
public AttachedDiskInitializeParams setStoragePool(String storagePool)
The storage pool in which the new disk is created. You can provide this as a partial or full
 URL to the resource. For example, the following are valid values: -
 https://www.googleapis.com/compute/v1/projects/project/zones/zone /storagePools/storagePool -
 projects/project/zones/zone/storagePools/storagePool - zones/zone/storagePools/storagePool

Parameters:
storagePool - storagePool or null for none








set
public AttachedDiskInitializeParams set(String fieldName,
                                        Object value)

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








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