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

Method Summary

Modifier and Type	Method and Description
AttachedDiskInitializeParams	clone()
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.
Map<String,String>	getLabels() Labels to apply to this 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	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	setLabels(Map<String,String> labels) Labels to apply to this 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, 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

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

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 the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

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 the disk with the instance name exists already in the given zone/region, a new name will be automatically generated.

Parameters:

diskName - diskName or null for none

getDiskSizeGb

public Long getDiskSizeGb()

Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB.

Returns:

value or null for none

setDiskSizeGb

public AttachedDiskInitializeParams setDiskSizeGb(Long diskSizeGb)

Specifies the size of the disk in base-2 GB. If not specified, the disk will be the same size as the image (usually 10GB). If specified, the size must be equal to or larger than 10GB.

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 Other values include pd-ssd and local-ssd. 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 Other values include pd-ssd and local-ssd. 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

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

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