Class Image (1.55.0)

public final class Image extends GeneratedMessageV3 implements ImageOrBuilder

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

Protobuf type google.cloud.compute.v1.Image

Implements

ImageOrBuilder

Static Fields

ARCHITECTURE_FIELD_NUMBER

public static final int ARCHITECTURE_FIELD_NUMBER
Field Value
Type Description
int

ARCHIVE_SIZE_BYTES_FIELD_NUMBER

public static final int ARCHIVE_SIZE_BYTES_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DEPRECATED_FIELD_NUMBER

public static final int DEPRECATED_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

DISK_SIZE_GB_FIELD_NUMBER

public static final int DISK_SIZE_GB_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_CONFIDENTIAL_COMPUTE_FIELD_NUMBER

public static final int ENABLE_CONFIDENTIAL_COMPUTE_FIELD_NUMBER
Field Value
Type Description
int

FAMILY_FIELD_NUMBER

public static final int FAMILY_FIELD_NUMBER
Field Value
Type Description
int

GUEST_OS_FEATURES_FIELD_NUMBER

public static final int GUEST_OS_FEATURES_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

IMAGE_ENCRYPTION_KEY_FIELD_NUMBER

public static final int IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

LICENSES_FIELD_NUMBER

public static final int LICENSES_FIELD_NUMBER
Field Value
Type Description
int

LICENSE_CODES_FIELD_NUMBER

public static final int LICENSE_CODES_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RAW_DISK_FIELD_NUMBER

public static final int RAW_DISK_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SHIELDED_INSTANCE_INITIAL_STATE_FIELD_NUMBER

public static final int SHIELDED_INSTANCE_INITIAL_STATE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_DISK_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SOURCE_DISK_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_DISK_FIELD_NUMBER

public static final int SOURCE_DISK_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_DISK_ID_FIELD_NUMBER

public static final int SOURCE_DISK_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SOURCE_IMAGE_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_IMAGE_FIELD_NUMBER

public static final int SOURCE_IMAGE_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_IMAGE_ID_FIELD_NUMBER

public static final int SOURCE_IMAGE_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_ENCRYPTION_KEY_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_SNAPSHOT_ID_FIELD_NUMBER

public static final int SOURCE_SNAPSHOT_ID_FIELD_NUMBER
Field Value
Type Description
int

SOURCE_TYPE_FIELD_NUMBER

public static final int SOURCE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_LOCATIONS_FIELD_NUMBER

public static final int STORAGE_LOCATIONS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Image getDefaultInstance()
Returns
Type Description
Image

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Image.Builder newBuilder()
Returns
Type Description
Image.Builder

newBuilder(Image prototype)

public static Image.Builder newBuilder(Image prototype)
Parameter
Name Description
prototype Image
Returns
Type Description
Image.Builder

parseDelimitedFrom(InputStream input)

public static Image parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Image parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Image parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Image parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Image parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Image parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Image parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Image
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Image> parser()
Returns
Type Description
Parser<Image>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels to apply to this image. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getArchitecture()

public String getArchitecture()

The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
String

The architecture.

getArchitectureBytes()

public ByteString getArchitectureBytes()

The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
ByteString

The bytes for architecture.

getArchiveSizeBytes()

public long getArchiveSizeBytes()

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

optional int64 archive_size_bytes = 381093450;

Returns
Type Description
long

The archiveSizeBytes.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Image getDefaultInstanceForType()
Returns
Type Description
Image

getDeprecated()

public DeprecationStatus getDeprecated()

The deprecation status associated with this image.

optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type Description
DeprecationStatus

The deprecated.

getDeprecatedOrBuilder()

public DeprecationStatusOrBuilder getDeprecatedOrBuilder()

The deprecation status associated with this image.

optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type Description
DeprecationStatusOrBuilder

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getDiskSizeGb()

public long getDiskSizeGb()

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

optional int64 disk_size_gb = 316263735;

Returns
Type Description
long

The diskSizeGb.

getEnableConfidentialCompute()

public boolean getEnableConfidentialCompute()

Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

The enableConfidentialCompute.

getFamily()

public String getFamily()

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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.

optional string family = 328751972;

Returns
Type Description
String

The family.

getFamilyBytes()

public ByteString getFamilyBytes()

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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.

optional string family = 328751972;

Returns
Type Description
ByteString

The bytes for family.

getGuestOsFeatures(int index)

public GuestOsFeature getGuestOsFeatures(int index)

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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name Description
index int
Returns
Type Description
GuestOsFeature

getGuestOsFeaturesCount()

public int getGuestOsFeaturesCount()

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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
int

getGuestOsFeaturesList()

public List<GuestOsFeature> getGuestOsFeaturesList()

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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
List<GuestOsFeature>

getGuestOsFeaturesOrBuilder(int index)

public GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Parameter
Name Description
index int
Returns
Type Description
GuestOsFeatureOrBuilder

getGuestOsFeaturesOrBuilderList()

public List<? extends GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()

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.

repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

Returns
Type Description
List<? extends com.google.cloud.compute.v1.GuestOsFeatureOrBuilder>

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

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.

optional .google.cloud.compute.v1.CustomerEncryptionKey image_encryption_key = 379512583;

Returns
Type Description
CustomerEncryptionKey

The imageEncryptionKey.

getImageEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getImageEncryptionKeyOrBuilder()

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.

optional .google.cloud.compute.v1.CustomerEncryptionKey image_encryption_key = 379512583;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

getKind()

public String getKind()

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

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

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

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels to apply to this image. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels to apply to this image. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels to apply to this image. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels to apply to this image. These can be later modified by the setLabels method.

map<string, string> labels = 500195327;

Parameter
Name Description
key String
Returns
Type Description
String

getLicenseCodes(int index)

public long getLicenseCodes(int index)

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

repeated int64 license_codes = 45482664;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
long

The licenseCodes at the given index.

getLicenseCodesCount()

public int getLicenseCodesCount()

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

repeated int64 license_codes = 45482664;

Returns
Type Description
int

The count of licenseCodes.

getLicenseCodesList()

public List<Long> getLicenseCodesList()

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

repeated int64 license_codes = 45482664;

Returns
Type Description
List<Long>

A list containing the licenseCodes.

getLicenses(int index)

public String getLicenses(int index)

Any applicable license URI.

repeated string licenses = 337642578;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The licenses at the given index.

getLicensesBytes(int index)

public ByteString getLicensesBytes(int index)

Any applicable license URI.

repeated string licenses = 337642578;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the licenses at the given index.

getLicensesCount()

public int getLicensesCount()

Any applicable license URI.

repeated string licenses = 337642578;

Returns
Type Description
int

The count of licenses.

getLicensesList()

public ProtocolStringList getLicensesList()

Any applicable license URI.

repeated string licenses = 337642578;

Returns
Type Description
ProtocolStringList

A list containing the licenses.

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

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Image> getParserForType()
Returns
Type Description
Parser<Image>
Overrides

getRawDisk()

public RawDisk getRawDisk()

The parameters of the raw disk image.

optional .google.cloud.compute.v1.RawDisk raw_disk = 503113556;

Returns
Type Description
RawDisk

The rawDisk.

getRawDiskOrBuilder()

public RawDiskOrBuilder getRawDiskOrBuilder()

The parameters of the raw disk image.

optional .google.cloud.compute.v1.RawDisk raw_disk = 503113556;

Returns
Type Description
RawDiskOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

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

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getShieldedInstanceInitialState()

public InitialStateConfig getShieldedInstanceInitialState()

Set the secure boot keys of shielded instance.

optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;

Returns
Type Description
InitialStateConfig

The shieldedInstanceInitialState.

getShieldedInstanceInitialStateOrBuilder()

public InitialStateConfigOrBuilder getShieldedInstanceInitialStateOrBuilder()

Set the secure boot keys of shielded instance.

optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;

Returns
Type Description
InitialStateConfigOrBuilder

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

optional string source_disk = 451753793;

Returns
Type Description
String

The sourceDisk.

getSourceDiskBytes()

public ByteString getSourceDiskBytes()

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

optional string source_disk = 451753793;

Returns
Type Description
ByteString

The bytes for sourceDisk.

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.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type Description
CustomerEncryptionKey

The sourceDiskEncryptionKey.

getSourceDiskEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getSourceDiskEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

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.

optional string source_disk_id = 454190809;

Returns
Type Description
String

The sourceDiskId.

getSourceDiskIdBytes()

public ByteString getSourceDiskIdBytes()

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

optional string source_disk_id = 454190809;

Returns
Type Description
ByteString

The bytes for sourceDiskId.

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

optional string source_image = 50443319;

Returns
Type Description
String

The sourceImage.

getSourceImageBytes()

public ByteString getSourceImageBytes()

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

optional string source_image = 50443319;

Returns
Type Description
ByteString

The bytes for sourceImage.

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.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type Description
CustomerEncryptionKey

The sourceImageEncryptionKey.

getSourceImageEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getSourceImageEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

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.

optional string source_image_id = 55328291;

Returns
Type Description
String

The sourceImageId.

getSourceImageIdBytes()

public ByteString getSourceImageIdBytes()

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

optional string source_image_id = 55328291;

Returns
Type Description
ByteString

The bytes for sourceImageId.

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

optional string source_snapshot = 126061928;

Returns
Type Description
String

The sourceSnapshot.

getSourceSnapshotBytes()

public ByteString getSourceSnapshotBytes()

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

optional string source_snapshot = 126061928;

Returns
Type Description
ByteString

The bytes for sourceSnapshot.

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.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type Description
CustomerEncryptionKey

The sourceSnapshotEncryptionKey.

getSourceSnapshotEncryptionKeyOrBuilder()

public CustomerEncryptionKeyOrBuilder getSourceSnapshotEncryptionKeyOrBuilder()

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type Description
CustomerEncryptionKeyOrBuilder

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.

optional string source_snapshot_id = 98962258;

Returns
Type Description
String

The sourceSnapshotId.

getSourceSnapshotIdBytes()

public ByteString getSourceSnapshotIdBytes()

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

optional string source_snapshot_id = 98962258;

Returns
Type Description
ByteString

The bytes for sourceSnapshotId.

getSourceType()

public String getSourceType()

The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.

optional string source_type = 452245726;

Returns
Type Description
String

The sourceType.

getSourceTypeBytes()

public ByteString getSourceTypeBytes()

The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.

optional string source_type = 452245726;

Returns
Type Description
ByteString

The bytes for sourceType.

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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

getStorageLocations(int index)

public String getStorageLocations(int index)

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

repeated string storage_locations = 328005274;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The storageLocations at the given index.

getStorageLocationsBytes(int index)

public ByteString getStorageLocationsBytes(int index)

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

repeated string storage_locations = 328005274;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the storageLocations at the given index.

getStorageLocationsCount()

public int getStorageLocationsCount()

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

repeated string storage_locations = 328005274;

Returns
Type Description
int

The count of storageLocations.

getStorageLocationsList()

public ProtocolStringList getStorageLocationsList()

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

repeated string storage_locations = 328005274;

Returns
Type Description
ProtocolStringList

A list containing the storageLocations.

hasArchitecture()

public boolean hasArchitecture()

The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

optional string architecture = 302803283;

Returns
Type Description
boolean

Whether the architecture field is set.

hasArchiveSizeBytes()

public boolean hasArchiveSizeBytes()

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

optional int64 archive_size_bytes = 381093450;

Returns
Type Description
boolean

Whether the archiveSizeBytes field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDeprecated()

public boolean hasDeprecated()

The deprecation status associated with this image.

optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;

Returns
Type Description
boolean

Whether the deprecated field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDiskSizeGb()

public boolean hasDiskSizeGb()

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

optional int64 disk_size_gb = 316263735;

Returns
Type Description
boolean

Whether the diskSizeGb field is set.

hasEnableConfidentialCompute()

public boolean hasEnableConfidentialCompute()

Whether this image is created from a confidential compute mode disk. [Output Only]: This field is not set by user, but from source disk.

optional bool enable_confidential_compute = 102135228;

Returns
Type Description
boolean

Whether the enableConfidentialCompute field is set.

hasFamily()

public boolean hasFamily()

The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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.

optional string family = 328751972;

Returns
Type Description
boolean

Whether the family field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasImageEncryptionKey()

public boolean hasImageEncryptionKey()

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.

optional .google.cloud.compute.v1.CustomerEncryptionKey image_encryption_key = 379512583;

Returns
Type Description
boolean

Whether the imageEncryptionKey field is set.

hasKind()

public boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasLabelFingerprint()

public boolean hasLabelFingerprint()

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.

optional string label_fingerprint = 178124825;

Returns
Type Description
boolean

Whether the labelFingerprint field is set.

hasName()

public boolean hasName()

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

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasRawDisk()

public boolean hasRawDisk()

The parameters of the raw disk image.

optional .google.cloud.compute.v1.RawDisk raw_disk = 503113556;

Returns
Type Description
boolean

Whether the rawDisk field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasShieldedInstanceInitialState()

public boolean hasShieldedInstanceInitialState()

Set the secure boot keys of shielded instance.

optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;

Returns
Type Description
boolean

Whether the shieldedInstanceInitialState field is set.

hasSourceDisk()

public boolean hasSourceDisk()

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

optional string source_disk = 451753793;

Returns
Type Description
boolean

Whether the sourceDisk field is set.

hasSourceDiskEncryptionKey()

public boolean hasSourceDiskEncryptionKey()

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_disk_encryption_key = 531501153;

Returns
Type Description
boolean

Whether the sourceDiskEncryptionKey field is set.

hasSourceDiskId()

public boolean hasSourceDiskId()

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

optional string source_disk_id = 454190809;

Returns
Type Description
boolean

Whether the sourceDiskId field is set.

hasSourceImage()

public boolean hasSourceImage()

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

optional string source_image = 50443319;

Returns
Type Description
boolean

Whether the sourceImage field is set.

hasSourceImageEncryptionKey()

public boolean hasSourceImageEncryptionKey()

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_image_encryption_key = 381503659;

Returns
Type Description
boolean

Whether the sourceImageEncryptionKey field is set.

hasSourceImageId()

public boolean hasSourceImageId()

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

optional string source_image_id = 55328291;

Returns
Type Description
boolean

Whether the sourceImageId field is set.

hasSourceSnapshot()

public boolean hasSourceSnapshot()

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

optional string source_snapshot = 126061928;

Returns
Type Description
boolean

Whether the sourceSnapshot field is set.

hasSourceSnapshotEncryptionKey()

public boolean hasSourceSnapshotEncryptionKey()

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

optional .google.cloud.compute.v1.CustomerEncryptionKey source_snapshot_encryption_key = 303679322;

Returns
Type Description
boolean

Whether the sourceSnapshotEncryptionKey field is set.

hasSourceSnapshotId()

public boolean hasSourceSnapshotId()

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

optional string source_snapshot_id = 98962258;

Returns
Type Description
boolean

Whether the sourceSnapshotId field is set.

hasSourceType()

public boolean hasSourceType()

The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.

optional string source_type = 452245726;

Returns
Type Description
boolean

Whether the sourceType field is set.

hasStatus()

public boolean hasStatus()

[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. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Image.Builder newBuilderForType()
Returns
Type Description
Image.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Image.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Image.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Image.Builder toBuilder()
Returns
Type Description
Image.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException