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

An Image resource.

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

Methods

Modifier and Type	Method and Description
Image	clone()
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.math.BigInteger	getId() [Output Only] The unique identifier for the resource.
java.lang.String	getKind() [Output Only] Type of the resource.
java.util.List<java.lang.String>	getLicenses() Any applicable publicly visible licenses.
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 The source disk used to create this image.
java.lang.String	getSourceDiskId() The ID value of the disk 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.
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	setId(java.math.BigInteger id) [Output Only] The unique identifier for the resource.
Image	setKind(java.lang.String kind) [Output Only] Type of the resource.
Image	setLicenses(java.util.List<java.lang.String> licenses) Any applicable publicly visible licenses.
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 The source disk used to create this image.
Image	setSourceDiskId(java.lang.String sourceDiskId) The ID value of the disk 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.

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

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

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

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

getLicenses

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

Any applicable publicly visible licenses.

Returns:

value or null for none

setLicenses

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

Any applicable publicly visible licenses.

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 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/disk/disk - projects/project/zones/zone/disk/disk - zones/zone/disks/disk

Returns:

value or null for none

setSourceDisk

public Image setSourceDisk(java.lang.String sourceDisk)

URL of the 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/disk/disk - projects/project/zones/zone/disk/disk - zones/zone/disks/disk

Parameters:

sourceDisk - sourceDisk or null for none

getSourceDiskId

public java.lang.String getSourceDiskId()

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)

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

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

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