Image (Google Cloud 0.119.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.Image

All Implemented Interfaces:: com.google.api.gax.httpjson.ApiMessage

@Generated(value="by GAPIC")
 @BetaApi
public final class Image
extends Object
implements com.google.api.gax.httpjson.ApiMessage

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Image.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`Image.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`com.google.api.gax.httpjson.ApiMessage`	`getApiMessageRequestBody()`
`String`	`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.
`static Image`	`getDefaultInstance()`
`DeprecationStatus`	`getDeprecated()` The deprecation status associated with this image.
`String`	`getDescription()` An optional description of this resource.
`String`	`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<String>`	`getFieldMask()`
`Object`	`getFieldValue(String fieldName)`
`List<GuestOsFeature>`	`getGuestOsFeaturesList()` A list of features to enable on the guest operating system.
`String`	`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>`	`getLabelsMap()` Labels to apply to this image.
`List<String>`	`getLicenseCodesList()` Integer license codes indicating which licenses are attached to this image.
`List<String>`	`getLicensesList()` Any applicable license URI.
`String`	`getName()` Name of the resource; provided by the client when the resource is created.
`RawDisk`	`getRawDisk()` The parameters of the raw disk image.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`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.
`int`	`hashCode()`
`static Image.Builder`	`newBuilder()`
`static Image.Builder`	`newBuilder(Image prototype)`
`Image.Builder`	`toBuilder()`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Method Detail
  - getFieldValue
```
public Object getFieldValue(String fieldName)
```
    Specified by:
    
    getFieldValue in interface com.google.api.gax.httpjson.ApiMessage
  - getApiMessageRequestBody
```
@Nullable
public com.google.api.gax.httpjson.ApiMessage getApiMessageRequestBody()
```
    Specified by:
    
    getApiMessageRequestBody in interface com.google.api.gax.httpjson.ApiMessage
  - getFieldMask
```
@Nullable
public List<String> getFieldMask()
```
    Specified by:
    
    getFieldMask in interface com.google.api.gax.httpjson.ApiMessage
  - getArchiveSizeBytes
```
public String getArchiveSizeBytes()
```
    Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDeprecated
```
public DeprecationStatus getDeprecated()
```
    The deprecation status associated with this image.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - getDiskSizeGb
```
public String getDiskSizeGb()
```
    Size of the image when restored onto a persistent disk (in GB).
  - 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.
  - getGuestOsFeaturesList
```
public List<GuestOsFeature> getGuestOsFeaturesList()
```
    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.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - 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.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#image for images.
  - 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.
  - getLabelsMap
```
public Map<String,String> getLabelsMap()
```
    Labels to apply to this image. These can be later modified by the setLabels method.
  - getLicenseCodesList
```
public List<String> getLicenseCodesList()
```
    Integer license codes indicating which licenses are attached to this image.
  - getLicensesList
```
public List<String> getLicensesList()
```
    Any applicable license URI.
  - 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.
  - getRawDisk
```
public RawDisk getRawDisk()
```
    The parameters of the raw disk image.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - getSourceDisk
```
public 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
  - 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.
  - 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.
  - getSourceImage
```
public 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.
  - 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.
  - 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.
  - getSourceSnapshot
```
public 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.
  - 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.
  - 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.
  - getSourceType
```
public String getSourceType()
```
    The type of the image used to create this disk. The default and only value is RAW
  - 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.
  - newBuilder
```
public static Image.Builder newBuilder()
```
  - newBuilder
```
public static Image.Builder newBuilder(Image prototype)
```
  - toBuilder
```
public Image.Builder toBuilder()
```
  - getDefaultInstance
```
public static Image getDefaultInstance()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Image

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldValue

getApiMessageRequestBody

getFieldMask

getArchiveSizeBytes

getCreationTimestamp

getDeprecated

getDescription

getDiskSizeGb

getFamily

getGuestOsFeaturesList

getId

getImageEncryptionKey

getKind

getLabelFingerprint

getLabelsMap

getLicenseCodesList

getLicensesList

getName

getRawDisk

getSelfLink

getSourceDisk

getSourceDiskEncryptionKey

getSourceDiskId

getSourceImage

getSourceImageEncryptionKey

getSourceImageId

getSourceSnapshot

getSourceSnapshotEncryptionKey

getSourceSnapshotId

getSourceType

getStatus

newBuilder

newBuilder

toBuilder

getDefaultInstance

toString

equals

hashCode