- 1.65.0 (latest)
- 1.64.0
- 1.63.0
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public interface ImageOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsLabels(String key)
public abstract 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 | |
getArchitecture()
public abstract 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 abstract 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 abstract 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 abstract String getCreationTimestamp()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public abstract ByteString getCreationTimestampBytes()[Output Only] Creation timestamp in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creationTimestamp. |
getDeprecated()
public abstract 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 abstract DeprecationStatusOrBuilder getDeprecatedOrBuilder()The deprecation status associated with this image.
optional .google.cloud.compute.v1.DeprecationStatus deprecated = 515138995;
| Returns | |
|---|---|
| Type | Description |
DeprecationStatusOrBuilder | |
getDescription()
public abstract 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 abstract 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 abstract 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. |
getFamily()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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()
public abstract Map<String,String> getLabels()Use #getLabelsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> | |
getLabelsCount()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract long getLicenseCodes(int index)Integer license codes indicating which licenses are attached to this image.
repeated int64 license_codes = 45482664;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
long | The licenseCodes at the given index. |
getLicenseCodesCount()
public abstract 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 abstract 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 abstract String getLicenses(int index)Any applicable license URI.
repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The licenses at the given index. |
getLicensesBytes(int index)
public abstract ByteString getLicensesBytes(int index)Any applicable license URI.
repeated string licenses = 337642578;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the licenses at the given index. |
getLicensesCount()
public abstract int getLicensesCount()Any applicable license URI.
repeated string licenses = 337642578;
| Returns | |
|---|---|
| Type | Description |
int | The count of licenses. |
getLicensesList()
public abstract List<String> getLicensesList()Any applicable license URI.
repeated string licenses = 337642578;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the licenses. |
getName()
public abstract 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 abstract 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. |
getRawDisk()
public abstract 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 abstract RawDiskOrBuilder getRawDiskOrBuilder()The parameters of the raw disk image.
optional .google.cloud.compute.v1.RawDisk raw_disk = 503113556;
| Returns | |
|---|---|
| Type | Description |
RawDiskOrBuilder | |
getSatisfiesPzs()
public abstract boolean getSatisfiesPzs()[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Returns | |
|---|---|
| Type | Description |
boolean | The satisfiesPzs. |
getSelfLink()
public abstract String getSelfLink()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public abstract ByteString getSelfLinkBytes()[Output Only] Server-defined URL for the resource.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for selfLink. |
getShieldedInstanceInitialState()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The storageLocations at the given index. |
getStorageLocationsBytes(int index)
public abstract 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 | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the storageLocations at the given index. |
getStorageLocationsCount()
public abstract 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 abstract List<String> getStorageLocationsList()Cloud Storage bucket storage location of the image (regional or multi-regional).
repeated string storage_locations = 328005274;
| Returns | |
|---|---|
| Type | Description |
List<String> | A list containing the storageLocations. |
hasArchitecture()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
hasFamily()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |
hasSatisfiesPzs()
public abstract boolean hasSatisfiesPzs()[Output Only] Reserved for future use.
optional bool satisfies_pzs = 480964267;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the satisfiesPzs field is set. |
hasSelfLink()
public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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. |