com.google.api.services.compute.model

Class Image

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.compute.model.Image

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Image
extends com.google.api.client.json.GenericJson

Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images. (== resource_for {$api_version}.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

com.google.api.client.util.GenericData.Flags

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Image()

Method Summary

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.
java.lang.Long	getArchiveSizeBytes() Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
java.lang.String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
DeprecationStatus	getDeprecated() The deprecation status associated with this image.
java.lang.String	getDescription() An optional description of this resource.
java.lang.Long	getDiskSizeGb() Size of the image when restored onto a persistent disk (in GB).
java.lang.String	getFamily() The name of the image family to which this image belongs.
java.util.List<GuestOsFeature>	getGuestOsFeatures() A list of features to enable on the guest operating system.
java.math.BigInteger	getId() [Output Only] The unique identifier for the resource.
CustomerEncryptionKey	getImageEncryptionKey() Encrypts the image using a customer-supplied encryption key.
java.lang.String	getKind() [Output Only] Type of the resource.
java.lang.String	getLabelFingerprint() A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Labels to apply to this image.
java.util.List<java.lang.Long>	getLicenseCodes() Integer license codes indicating which licenses are attached to this image.
java.util.List<java.lang.String>	getLicenses() Any applicable license URI.
java.lang.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.
java.lang.String	getSelfLink() [Output Only] Server-defined URL for the resource.
java.lang.String	getSourceDisk() URL of the source disk used to create this image.
CustomerEncryptionKey	getSourceDiskEncryptionKey() The customer-supplied encryption key of the source disk.
java.lang.String	getSourceDiskId() [Output Only] The ID value of the disk used to create this image.
java.lang.String	getSourceImage() URL of the source image used to create this image.
CustomerEncryptionKey	getSourceImageEncryptionKey() The customer-supplied encryption key of the source image.
java.lang.String	getSourceImageId() [Output Only] The ID value of the image used to create this image.
java.lang.String	getSourceSnapshot() URL of the source snapshot used to create this image.
CustomerEncryptionKey	getSourceSnapshotEncryptionKey() The customer-supplied encryption key of the source snapshot.
java.lang.String	getSourceSnapshotId() [Output Only] The ID value of the snapshot used to create this image.
java.lang.String	getSourceType() The type of the image used to create this disk.
java.lang.String	getStatus() [Output Only] The status of the image.
java.util.List<java.lang.String>	getStorageLocations() Cloud Storage bucket storage location of the image (regional or multi-regional).
Image	set(java.lang.String fieldName, java.lang.Object value)
Image	setArchiveSizeBytes(java.lang.Long archiveSizeBytes) Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
Image	setCreationTimestamp(java.lang.String creationTimestamp) [Output Only] Creation timestamp in RFC3339 text format.
Image	setDeprecated(DeprecationStatus deprecated) The deprecation status associated with this image.
Image	setDescription(java.lang.String description) An optional description of this resource.
Image	setDiskSizeGb(java.lang.Long diskSizeGb) Size of the image when restored onto a persistent disk (in GB).
Image	setFamily(java.lang.String family) The name of the image family to which this image belongs.
Image	setGuestOsFeatures(java.util.List<GuestOsFeature> guestOsFeatures) A list of features to enable on the guest operating system.
Image	setId(java.math.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(java.lang.String kind) [Output Only] Type of the resource.
Image	setLabelFingerprint(java.lang.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(java.util.Map<java.lang.String,java.lang.String> labels) Labels to apply to this image.
Image	setLicenseCodes(java.util.List<java.lang.Long> licenseCodes) Integer license codes indicating which licenses are attached to this image.
Image	setLicenses(java.util.List<java.lang.String> licenses) Any applicable license URI.
Image	setName(java.lang.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	setSelfLink(java.lang.String selfLink) [Output Only] Server-defined URL for the resource.
Image	setSourceDisk(java.lang.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(java.lang.String sourceDiskId) [Output Only] The ID value of the disk used to create this image.
Image	setSourceImage(java.lang.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(java.lang.String sourceImageId) [Output Only] The ID value of the image used to create this image.
Image	setSourceSnapshot(java.lang.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(java.lang.String sourceSnapshotId) [Output Only] The ID value of the snapshot used to create this image.
Image	setSourceType(java.lang.String sourceType) The type of the image used to create this disk.
Image	setStatus(java.lang.String status) [Output Only] The status of the image.
Image	setStorageLocations(java.util.List<java.lang.String> storageLocations) Cloud Storage bucket storage location of the image (regional or multi-regional).

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

Image

public Image()

Method Detail

getArchiveSizeBytes

public java.lang.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(java.lang.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 java.lang.String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

Returns:

value or null for none

setCreationTimestamp

public Image setCreationTimestamp(java.lang.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 java.lang.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(java.lang.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 java.lang.Long getDiskSizeGb()

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

Returns:

value or null for none

setDiskSizeGb

public Image setDiskSizeGb(java.lang.Long diskSizeGb)

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

Parameters:

diskSizeGb - diskSizeGb or null for none

getFamily

public java.lang.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(java.lang.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 java.util.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.

Returns:

value or null for none

setGuestOsFeatures

public Image setGuestOsFeatures(java.util.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.

Parameters:

guestOsFeatures - guestOsFeatures or null for none

getId

public java.math.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(java.math.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 java.lang.String getKind()

[Output Only] Type of the resource. Always compute#image for images.

Returns:

value or null for none

setKind

public Image setKind(java.lang.String kind)

[Output Only] Type of the resource. Always compute#image for images.

Parameters:

kind - kind or null for none

getLabelFingerprint

public java.lang.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(java.lang.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 java.util.Map<java.lang.String,java.lang.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(java.util.Map<java.lang.String,java.lang.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 java.util.List<java.lang.Long> getLicenseCodes()

Integer license codes indicating which licenses are attached to this image.

Returns:

value or null for none

setLicenseCodes

public Image setLicenseCodes(java.util.List<java.lang.Long> licenseCodes)

Integer license codes indicating which licenses are attached to this image.

Parameters:

licenseCodes - licenseCodes or null for none

getLicenses

public java.util.List<java.lang.String> getLicenses()

Any applicable license URI.

Returns:

value or null for none

setLicenses

public Image setLicenses(java.util.List<java.lang.String> licenses)

Any applicable license URI.

Parameters:

licenses - licenses or null for none

getName

public java.lang.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(java.lang.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

getSelfLink

public java.lang.String getSelfLink()

[Output Only] Server-defined URL for the resource.

Returns:

value or null for none

setSelfLink

public Image setSelfLink(java.lang.String selfLink)

[Output Only] Server-defined URL for the resource.

Parameters:

selfLink - selfLink or null for none

getSourceDisk

public java.lang.String getSourceDisk()

URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an 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

Returns:

value or null for none

setSourceDisk

public Image setSourceDisk(java.lang.String sourceDisk)

URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an 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

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 java.lang.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(java.lang.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 java.lang.String getSourceImage()

URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image.

Returns:

value or null for none

setSourceImage

public Image setSourceImage(java.lang.String sourceImage)

URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image.

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 java.lang.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(java.lang.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 java.lang.String getSourceSnapshot()

URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image.

Returns:

value or null for none

setSourceSnapshot

public Image setSourceSnapshot(java.lang.String sourceSnapshot)

URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of: - this property, or - the sourceImage property, or - the rawDisk.source property, or - the sourceDisk property in order to create an image.

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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.List<java.lang.String> getStorageLocations()

Cloud Storage bucket storage location of the image (regional or multi-regional).

Returns:

value or null for none

setStorageLocations

public Image setStorageLocations(java.util.List<java.lang.String> storageLocations)

Cloud Storage bucket storage location of the image (regional or multi-regional).

Parameters:

storageLocations - storageLocations or null for none

set

public Image set(java.lang.String fieldName,
                 java.lang.Object value)

Overrides:

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

clone

public Image clone()

Overrides:

clone in class com.google.api.client.json.GenericJson