• Home
• com.google.apis
• google-api-services-compute
• beta-rev20220312-1.32.1
• source code
• Image.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.Image.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 Image



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class Image
extends GenericJson
Represents an Image resource. You can use images to create boot disks for your VM instances. For
 more information, read Images.

 
 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 

Modifier and Type
Class and Description


static class 
Image.RawDisk
The parameters of the raw disk image.







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


Image() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


Image
clone() 


byte[]
decodeLabelFingerprint()
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking.



Image
encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking.



Long
getArchiveSizeBytes()
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).



String
getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.



DeprecationStatus
getDeprecated()
The deprecation status associated with this image.



String
getDescription()
An optional description of this resource.



Long
getDiskSizeGb()
Size of the image when restored onto a persistent disk (in GB).



String
getFamily()
The name of the image family to which this image belongs.



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



BigInteger
getId()
[Output Only] The unique identifier for the resource.



CustomerEncryptionKey
getImageEncryptionKey()
Encrypts the image using a customer-supplied encryption key.



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



String
getLabelFingerprint()
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking.



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



List<Long>
getLicenseCodes()
Integer license codes indicating which licenses are attached to this image.



List<String>
getLicenses()
Any applicable license URI.



Boolean
getLocked()
A flag for marketplace VM disk created from the image, which is designed for marketplace VM
 disk to prevent the proprietary data on the disk from being accessed unwantedly.



String
getName()
Name of the resource; provided by the client when the resource is created.



Image.RawDisk
getRawDisk()
The parameters of the raw disk image.



RolloutPolicy
getRolloutOverride()
A rollout policy to apply to this image.



Boolean
getSatisfiesPzs()
[Output Only] Reserved for future use.



String
getSelfLink()
[Output Only] Server-defined URL for the resource.



InitialStateConfig
getShieldedInstanceInitialState()
Set the secure boot keys of shielded instance.



String
getSourceDisk()
URL of the source disk used to create this image.



CustomerEncryptionKey
getSourceDiskEncryptionKey()
The customer-supplied encryption key of the source disk.



String
getSourceDiskId()
[Output Only] The ID value of the disk used to create this image.



String
getSourceImage()
URL of the source image used to create this image.



CustomerEncryptionKey
getSourceImageEncryptionKey()
The customer-supplied encryption key of the source image.



String
getSourceImageId()
[Output Only] The ID value of the image used to create this image.



String
getSourceSnapshot()
URL of the source snapshot used to create this image.



CustomerEncryptionKey
getSourceSnapshotEncryptionKey()
The customer-supplied encryption key of the source snapshot.



String
getSourceSnapshotId()
[Output Only] The ID value of the snapshot used to create this image.



String
getSourceType()
The type of the image used to create this disk.



String
getStatus()
[Output Only] The status of the image.



List<String>
getStorageLocations()
Cloud Storage bucket storage location of the image (regional or multi-regional).



List<String>
getUserLicenses()
A list of publicly visible user-licenses.



Image
set(String fieldName,
   Object value) 


Image
setArchiveSizeBytes(Long archiveSizeBytes)
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).



Image
setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.



Image
setDeprecated(DeprecationStatus deprecated)
The deprecation status associated with this image.



Image
setDescription(String description)
An optional description of this resource.



Image
setDiskSizeGb(Long diskSizeGb)
Size of the image when restored onto a persistent disk (in GB).



Image
setFamily(String family)
The name of the image family to which this image belongs.



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



Image
setId(BigInteger id)
[Output Only] The unique identifier for the resource.



Image
setImageEncryptionKey(CustomerEncryptionKey imageEncryptionKey)
Encrypts the image using a customer-supplied encryption key.



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



Image
setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking.



Image
setLabels(Map<String,String> labels)
Labels to apply to this image.



Image
setLicenseCodes(List<Long> licenseCodes)
Integer license codes indicating which licenses are attached to this image.



Image
setLicenses(List<String> licenses)
Any applicable license URI.



Image
setLocked(Boolean locked)
A flag for marketplace VM disk created from the image, which is designed for marketplace VM
 disk to prevent the proprietary data on the disk from being accessed unwantedly.



Image
setName(String name)
Name of the resource; provided by the client when the resource is created.



Image
setRawDisk(Image.RawDisk rawDisk)
The parameters of the raw disk image.



Image
setRolloutOverride(RolloutPolicy rolloutOverride)
A rollout policy to apply to this image.



Image
setSatisfiesPzs(Boolean satisfiesPzs)
[Output Only] Reserved for future use.



Image
setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.



Image
setShieldedInstanceInitialState(InitialStateConfig shieldedInstanceInitialState)
Set the secure boot keys of shielded instance.



Image
setSourceDisk(String sourceDisk)
URL of the source disk used to create this image.



Image
setSourceDiskEncryptionKey(CustomerEncryptionKey sourceDiskEncryptionKey)
The customer-supplied encryption key of the source disk.



Image
setSourceDiskId(String sourceDiskId)
[Output Only] The ID value of the disk used to create this image.



Image
setSourceImage(String sourceImage)
URL of the source image used to create this image.



Image
setSourceImageEncryptionKey(CustomerEncryptionKey sourceImageEncryptionKey)
The customer-supplied encryption key of the source image.



Image
setSourceImageId(String sourceImageId)
[Output Only] The ID value of the image used to create this image.



Image
setSourceSnapshot(String sourceSnapshot)
URL of the source snapshot used to create this image.



Image
setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)
The customer-supplied encryption key of the source snapshot.



Image
setSourceSnapshotId(String sourceSnapshotId)
[Output Only] The ID value of the snapshot used to create this image.



Image
setSourceType(String sourceType)
The type of the image used to create this disk.



Image
setStatus(String status)
[Output Only] The status of the image.



Image
setStorageLocations(List<String> storageLocations)
Cloud Storage bucket storage location of the image (regional or multi-regional).



Image
setUserLicenses(List<String> userLicenses)
A list of publicly visible user-licenses.







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





Image
public Image()









Method Detail





getArchiveSizeBytes
public Long getArchiveSizeBytes()
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Returns:
value or null for none








setArchiveSizeBytes
public Image setArchiveSizeBytes(Long archiveSizeBytes)
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Parameters:
archiveSizeBytes - archiveSizeBytes or null for none








getCreationTimestamp
public String getCreationTimestamp()
[Output Only] Creation timestamp in RFC3339 text format.

Returns:
value or null for none








setCreationTimestamp
public Image setCreationTimestamp(String creationTimestamp)
[Output Only] Creation timestamp in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp or null for none








getDeprecated
public DeprecationStatus getDeprecated()
The deprecation status associated with this image.

Returns:
value or null for none








setDeprecated
public Image setDeprecated(DeprecationStatus deprecated)
The deprecation status associated with this image.

Parameters:
deprecated - deprecated or null for none








getDescription
public String getDescription()
An optional description of this resource. Provide this property when you create the resource.

Returns:
value or null for none








setDescription
public Image setDescription(String description)
An optional description of this resource. Provide this property when you create the resource.

Parameters:
description - description or null for none








getDiskSizeGb
public Long getDiskSizeGb()
Size of the image when restored onto a persistent disk (in GB).

Returns:
value or null for none








setDiskSizeGb
public Image setDiskSizeGb(Long diskSizeGb)
Size of the image when restored onto a persistent disk (in GB).

Parameters:
diskSizeGb - diskSizeGb or null for none








getFamily
public String getFamily()
The name of the image family to which this image belongs. You can create disks by specifying an
 image family instead of a specific image name. The image family always returns its latest image
 that is not deprecated. The name of the image family must comply with RFC1035.

Returns:
value or null for none








setFamily
public Image setFamily(String family)
The name of the image family to which this image belongs. You can create disks by specifying an
 image family instead of a specific image name. The image family always returns its latest image
 that is not deprecated. The name of the image family must comply with RFC1035.

Parameters:
family - family 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. To see a list of available options, see the guestOSfeatures[].type parameter.

Returns:
value or null for none








setGuestOsFeatures
public Image setGuestOsFeatures(List<GuestOsFeature> guestOsFeatures)
A list of features to enable on the guest operating system. Applicable only for bootable
 images. To see a list of available options, see the guestOSfeatures[].type parameter.

Parameters:
guestOsFeatures - guestOsFeatures or null for none








getId
public BigInteger getId()
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Returns:
value or null for none








setId
public Image setId(BigInteger id)
[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Parameters:
id - id or null for none








getImageEncryptionKey
public CustomerEncryptionKey getImageEncryptionKey()
Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a
 customer-supplied key, you must provide the same key if you use the image later (e.g. to create
 a disk from the image). Customer-supplied encryption keys do not protect access to metadata of
 the disk. If you do not provide an encryption key when creating the image, then the disk will
 be encrypted using an automatically generated key and you do not need to provide a key to use
 the image later.

Returns:
value or null for none








setImageEncryptionKey
public Image setImageEncryptionKey(CustomerEncryptionKey imageEncryptionKey)
Encrypts the image using a customer-supplied encryption key. After you encrypt an image with a
 customer-supplied key, you must provide the same key if you use the image later (e.g. to create
 a disk from the image). Customer-supplied encryption keys do not protect access to metadata of
 the disk. If you do not provide an encryption key when creating the image, then the disk will
 be encrypted using an automatically generated key and you do not need to provide a key to use
 the image later.

Parameters:
imageEncryptionKey - imageEncryptionKey or null for none








getKind
public String getKind()
[Output Only] Type of the resource. Always compute#image for images.

Returns:
value or null for none








setKind
public Image setKind(String kind)
[Output Only] Type of the resource. Always compute#image for images.

Parameters:
kind - kind or null for none








getLabelFingerprint
public String getLabelFingerprint()
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking. The fingerprint is initially generated by Compute Engine
 and changes after every request to modify or update labels. You must always provide an up-to-
 date fingerprint hash in order to update or change labels, otherwise the request will fail with
 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an
 image.

Returns:
value or null for none
See Also:
decodeLabelFingerprint()








decodeLabelFingerprint
public byte[] decodeLabelFingerprint()
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking. The fingerprint is initially generated by Compute Engine
 and changes after every request to modify or update labels. You must always provide an up-to-
 date fingerprint hash in order to update or change labels, otherwise the request will fail with
 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an
 image.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getLabelFingerprint()








setLabelFingerprint
public Image setLabelFingerprint(String labelFingerprint)
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking. The fingerprint is initially generated by Compute Engine
 and changes after every request to modify or update labels. You must always provide an up-to-
 date fingerprint hash in order to update or change labels, otherwise the request will fail with
 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an
 image.

Parameters:
labelFingerprint - labelFingerprint or null for none
See Also:
#encodeLabelFingerprint()








encodeLabelFingerprint
public Image encodeLabelFingerprint(byte[] labelFingerprint)
A fingerprint for the labels being applied to this image, which is essentially a hash of the
 labels used for optimistic locking. The fingerprint is initially generated by Compute Engine
 and changes after every request to modify or update labels. You must always provide an up-to-
 date fingerprint hash in order to update or change labels, otherwise the request will fail with
 error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an
 image.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getLabels
public Map<String,String> getLabels()
Labels to apply to this image. These can be later modified by the setLabels method.

Returns:
value or null for none








setLabels
public Image setLabels(Map<String,String> labels)
Labels to apply to this image. These can be later modified by the setLabels method.

Parameters:
labels - labels or null for none








getLicenseCodes
public List<Long> getLicenseCodes()
Integer license codes indicating which licenses are attached to this image.

Returns:
value or null for none








setLicenseCodes
public Image setLicenseCodes(List<Long> licenseCodes)
Integer license codes indicating which licenses are attached to this image.

Parameters:
licenseCodes - licenseCodes or null for none








getLicenses
public List<String> getLicenses()
Any applicable license URI.

Returns:
value or null for none








setLicenses
public Image setLicenses(List<String> licenses)
Any applicable license URI.

Parameters:
licenses - licenses or null for none








getLocked
public Boolean getLocked()
A flag for marketplace VM disk created from the image, which is designed for marketplace VM
 disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will
 be inherited by the disk created from the image. The disk with locked flag set to true will be
 prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if
 disk is created via create-on-create - Create images - Create snapshots - Create disk clone
 (create disk from the current disk) The image with the locked field set to true will be
 prohibited from performing the operations below: - Create images from the current image -
 Update the locked field for the current image The instance with at least one disk with locked
 flag set to true will be prohibited from performing the operations below: - Secondary disk
 attach - Create instant snapshot - Create machine images - Create instance template - Delete
 the instance with --keep-disk parameter set to true

Returns:
value or null for none








setLocked
public Image setLocked(Boolean locked)
A flag for marketplace VM disk created from the image, which is designed for marketplace VM
 disk to prevent the proprietary data on the disk from being accessed unwantedly. The flag will
 be inherited by the disk created from the image. The disk with locked flag set to true will be
 prohibited from performing the operations below: - R/W or R/O disk attach - Disk detach, if
 disk is created via create-on-create - Create images - Create snapshots - Create disk clone
 (create disk from the current disk) The image with the locked field set to true will be
 prohibited from performing the operations below: - Create images from the current image -
 Update the locked field for the current image The instance with at least one disk with locked
 flag set to true will be prohibited from performing the operations below: - Secondary disk
 attach - Create instant snapshot - Create machine images - Create instance template - Delete
 the instance with --keep-disk parameter set to true

Parameters:
locked - locked or null for none








getName
public String getName()
Name of the resource; provided by the client when the resource is created. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Returns:
value or null for none








setName
public Image setName(String name)
Name of the resource; provided by the client when the resource is created. The name must be
 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters
 long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be a dash, lowercase
 letter, or digit, except the last character, which cannot be a dash.

Parameters:
name - name or null for none








getRawDisk
public Image.RawDisk getRawDisk()
The parameters of the raw disk image.

Returns:
value or null for none








setRawDisk
public Image setRawDisk(Image.RawDisk rawDisk)
The parameters of the raw disk image.

Parameters:
rawDisk - rawDisk or null for none








getRolloutOverride
public RolloutPolicy getRolloutOverride()
A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone
 references to the image via the associated image family. The rollout policy restricts the zones
 where this image is accessible when using a zonal image family reference. When the rollout
 policy does not include the user specified zone, or if the zone is rolled out, this image is
 accessible. The rollout policy for this image is read-only, except for allowlisted users. This
 field might not be configured. To view the latest non-deprecated image in a specific zone, use
 the imageFamilyViews.get method.

Returns:
value or null for none








setRolloutOverride
public Image setRolloutOverride(RolloutPolicy rolloutOverride)
A rollout policy to apply to this image. When specified, the rollout policy overrides per-zone
 references to the image via the associated image family. The rollout policy restricts the zones
 where this image is accessible when using a zonal image family reference. When the rollout
 policy does not include the user specified zone, or if the zone is rolled out, this image is
 accessible. The rollout policy for this image is read-only, except for allowlisted users. This
 field might not be configured. To view the latest non-deprecated image in a specific zone, use
 the imageFamilyViews.get method.

Parameters:
rolloutOverride - rolloutOverride or null for none








getSatisfiesPzs
public Boolean getSatisfiesPzs()
[Output Only] Reserved for future use.

Returns:
value or null for none








setSatisfiesPzs
public Image setSatisfiesPzs(Boolean satisfiesPzs)
[Output Only] Reserved for future use.

Parameters:
satisfiesPzs - satisfiesPzs or null for none








getSelfLink
public String getSelfLink()
[Output Only] Server-defined URL for the resource.

Returns:
value or null for none








setSelfLink
public Image setSelfLink(String selfLink)
[Output Only] Server-defined URL for the resource.

Parameters:
selfLink - selfLink or null for none








getShieldedInstanceInitialState
public InitialStateConfig getShieldedInstanceInitialState()
Set the secure boot keys of shielded instance.

Returns:
value or null for none








setShieldedInstanceInitialState
public Image setShieldedInstanceInitialState(InitialStateConfig shieldedInstanceInitialState)
Set the secure boot keys of shielded instance.

Parameters:
shieldedInstanceInitialState - shieldedInstanceInitialState or null for none








getSourceDisk
public String getSourceDisk()
URL of the source disk used to create this image. For example, the following are valid values:
 - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk -
 projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you
 must provide the full or partial URL of one of the following: - The rawDisk.source URL - The
 sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Returns:
value or null for none








setSourceDisk
public Image setSourceDisk(String sourceDisk)
URL of the source disk used to create this image. For example, the following are valid values:
 - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk -
 projects/project/zones/zone/disks/disk - zones/zone/disks/disk In order to create an image, you
 must provide the full or partial URL of one of the following: - The rawDisk.source URL - The
 sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Parameters:
sourceDisk - sourceDisk or null for none








getSourceDiskEncryptionKey
public CustomerEncryptionKey getSourceDiskEncryptionKey()
The customer-supplied encryption key of the source disk. Required if the source disk is
 protected by a customer-supplied encryption key.

Returns:
value or null for none








setSourceDiskEncryptionKey
public Image setSourceDiskEncryptionKey(CustomerEncryptionKey sourceDiskEncryptionKey)
The customer-supplied encryption key of the source disk. Required if the source disk is
 protected by a customer-supplied encryption key.

Parameters:
sourceDiskEncryptionKey - sourceDiskEncryptionKey or null for none








getSourceDiskId
public String getSourceDiskId()
[Output Only] The ID value of the disk used to create this image. This value may be used to
 determine whether the image was taken from the current or a previous instance of a given disk
 name.

Returns:
value or null for none








setSourceDiskId
public Image setSourceDiskId(String sourceDiskId)
[Output Only] The ID value of the disk used to create this image. This value may be used to
 determine whether the image was taken from the current or a previous instance of a given disk
 name.

Parameters:
sourceDiskId - sourceDiskId or null for none








getSourceImage
public String getSourceImage()
URL of the source image used to create this image. The following are valid formats for the URL:
 - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name -
 projects/project_id/global/images/image_name In order to create an image, you must provide the
 full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL -
 The sourceImage URL - The sourceSnapshot URL

Returns:
value or null for none








setSourceImage
public Image setSourceImage(String sourceImage)
URL of the source image used to create this image. The following are valid formats for the URL:
 - https://www.googleapis.com/compute/v1/projects/project_id/global/ images/image_name -
 projects/project_id/global/images/image_name In order to create an image, you must provide the
 full or partial URL of one of the following: - The rawDisk.source URL - The sourceDisk URL -
 The sourceImage URL - The sourceSnapshot URL

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.

Returns:
value or null for none








setSourceImageEncryptionKey
public Image 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.

Parameters:
sourceImageEncryptionKey - sourceImageEncryptionKey or null for none








getSourceImageId
public String getSourceImageId()
[Output Only] The ID value of the image used to create this image. This value may be used to
 determine whether the image was taken from the current or a previous instance of a given image
 name.

Returns:
value or null for none








setSourceImageId
public Image setSourceImageId(String sourceImageId)
[Output Only] The ID value of the image used to create this image. This value may be used to
 determine whether the image was taken from the current or a previous instance of a given image
 name.

Parameters:
sourceImageId - sourceImageId or null for none








getSourceSnapshot
public String getSourceSnapshot()
URL of the source snapshot used to create this image. The following are valid formats for the
 URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/
 snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create
 an image, you must provide the full or partial URL of one of the following: - The
 rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Returns:
value or null for none








setSourceSnapshot
public Image setSourceSnapshot(String sourceSnapshot)
URL of the source snapshot used to create this image. The following are valid formats for the
 URL: - https://www.googleapis.com/compute/v1/projects/project_id/global/
 snapshots/snapshot_name - projects/project_id/global/snapshots/snapshot_name In order to create
 an image, you must provide the full or partial URL of one of the following: - The
 rawDisk.source URL - The sourceDisk URL - The sourceImage URL - The sourceSnapshot URL

Parameters:
sourceSnapshot - sourceSnapshot or null for none








getSourceSnapshotEncryptionKey
public CustomerEncryptionKey getSourceSnapshotEncryptionKey()
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is
 protected by a customer-supplied encryption key.

Returns:
value or null for none








setSourceSnapshotEncryptionKey
public Image setSourceSnapshotEncryptionKey(CustomerEncryptionKey sourceSnapshotEncryptionKey)
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is
 protected by a customer-supplied encryption key.

Parameters:
sourceSnapshotEncryptionKey - sourceSnapshotEncryptionKey or null for none








getSourceSnapshotId
public String getSourceSnapshotId()
[Output Only] The ID value of the snapshot used to create this image. This value may be used to
 determine whether the snapshot was taken from the current or a previous instance of a given
 snapshot name.

Returns:
value or null for none








setSourceSnapshotId
public Image setSourceSnapshotId(String sourceSnapshotId)
[Output Only] The ID value of the snapshot used to create this image. This value may be used to
 determine whether the snapshot was taken from the current or a previous instance of a given
 snapshot name.

Parameters:
sourceSnapshotId - sourceSnapshotId or null for none








getSourceType
public String getSourceType()
The type of the image used to create this disk. The default and only value is RAW

Returns:
value or null for none








setSourceType
public Image setSourceType(String sourceType)
The type of the image used to create this disk. The default and only value is RAW

Parameters:
sourceType - sourceType or null for none








getStatus
public String getStatus()
[Output Only] The status of the image. An image can be used to create other resources, such as
 instances, only after the image has been successfully created and the status is set to READY.
 Possible values are FAILED, PENDING, or READY.

Returns:
value or null for none








setStatus
public Image setStatus(String status)
[Output Only] The status of the image. An image can be used to create other resources, such as
 instances, only after the image has been successfully created and the status is set to READY.
 Possible values are FAILED, PENDING, or READY.

Parameters:
status - status or null for none








getStorageLocations
public List<String> getStorageLocations()
Cloud Storage bucket storage location of the image (regional or multi-regional).

Returns:
value or null for none








setStorageLocations
public Image setStorageLocations(List<String> storageLocations)
Cloud Storage bucket storage location of the image (regional or multi-regional).

Parameters:
storageLocations - storageLocations or null for none








getUserLicenses
public List<String> getUserLicenses()
A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can
 be modified after the disk is created. This includes a list of URLs to the license resource.
 For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects
 /debian-cloud/global/licenses/debian-9-stretch

Returns:
value or null for none








setUserLicenses
public Image setUserLicenses(List<String> userLicenses)
A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can
 be modified after the disk is created. This includes a list of URLs to the license resource.
 For example, to provide a debian license: https://www.googleapis.com/compute/v1/projects
 /debian-cloud/global/licenses/debian-9-stretch

Parameters:
userLicenses - userLicenses or null for none








set
public Image set(String fieldName,
                 Object value)

Overrides:
set in class GenericJson








clone
public Image clone()

Overrides:
clone in class 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–2022 Google. All rights reserved.