Interface MachineImageOrBuilder (1.43.0)

Version 1.43.0

• 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 MachineImageOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCreationTimestamp()

public abstract String getCreationTimestamp()

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
String	The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
ByteString	The bytes for creationTimestamp.

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.

getGuestFlush()

public abstract boolean getGuestFlush()

[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

optional bool guest_flush = 385550813;

Returns
Type	Description
boolean	The guestFlush.

getId()

public abstract long getId()

[Output Only] A unique identifier for this machine image. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type	Description
long	The id.

getInstanceProperties()

public abstract InstanceProperties getInstanceProperties()

[Output Only] Properties of source instance

optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

Returns
Type	Description
InstanceProperties	The instanceProperties.

getInstancePropertiesOrBuilder()

public abstract InstancePropertiesOrBuilder getInstancePropertiesOrBuilder()

[Output Only] Properties of source instance

optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

Returns
Type	Description
InstancePropertiesOrBuilder

getKind()

public abstract String getKind()

[Output Only] The resource type, which is always compute#machineImage for machine image.

optional string kind = 3292052;

Returns
Type	Description
String	The kind.

getKindBytes()

public abstract ByteString getKindBytes()

[Output Only] The resource type, which is always compute#machineImage for machine image.

optional string kind = 3292052;

Returns
Type	Description
ByteString	The bytes for kind.

getMachineImageEncryptionKey()

public abstract CustomerEncryptionKey getMachineImageEncryptionKey()

Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

optional .google.cloud.compute.v1.CustomerEncryptionKey machine_image_encryption_key = 528089087;

Returns
Type	Description
CustomerEncryptionKey	The machineImageEncryptionKey.

getMachineImageEncryptionKeyOrBuilder()

public abstract CustomerEncryptionKeyOrBuilder getMachineImageEncryptionKeyOrBuilder()

Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

optional .google.cloud.compute.v1.CustomerEncryptionKey machine_image_encryption_key = 528089087;

Returns
Type	Description
CustomerEncryptionKeyOrBuilder

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.

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type	Description
boolean	The satisfiesPzs.

getSavedDisks(int index)

public abstract SavedDisk getSavedDisks(int index)

An array of Machine Image specific properties for disks attached to the source instance

repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

Parameter
Name	Description
index	int

Returns
Type	Description
SavedDisk

getSavedDisksCount()

public abstract int getSavedDisksCount()

An array of Machine Image specific properties for disks attached to the source instance

repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

Returns
Type	Description
int

getSavedDisksList()

public abstract List<SavedDisk> getSavedDisksList()

An array of Machine Image specific properties for disks attached to the source instance

repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

Returns
Type	Description
List<SavedDisk>

getSavedDisksOrBuilder(int index)

public abstract SavedDiskOrBuilder getSavedDisksOrBuilder(int index)

An array of Machine Image specific properties for disks attached to the source instance

repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

Parameter
Name	Description
index	int

Returns
Type	Description
SavedDiskOrBuilder

getSavedDisksOrBuilderList()

public abstract List<? extends SavedDiskOrBuilder> getSavedDisksOrBuilderList()

An array of Machine Image specific properties for disks attached to the source instance

repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

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

getSelfLink()

public abstract String getSelfLink()

[Output Only] The URL for this machine image. The server defines this URL.

optional string self_link = 456214797;

Returns
Type	Description
String	The selfLink.

getSelfLinkBytes()

public abstract ByteString getSelfLinkBytes()

[Output Only] The URL for this machine image. The server defines this URL.

optional string self_link = 456214797;

Returns
Type	Description
ByteString	The bytes for selfLink.

getSourceDiskEncryptionKeys(int index)

public abstract SourceDiskEncryptionKey getSourceDiskEncryptionKeys(int index)

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

repeated .google.cloud.compute.v1.SourceDiskEncryptionKey source_disk_encryption_keys = 370408498;

Parameter
Name	Description
index	int

Returns
Type	Description
SourceDiskEncryptionKey

getSourceDiskEncryptionKeysCount()

public abstract int getSourceDiskEncryptionKeysCount()

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

repeated .google.cloud.compute.v1.SourceDiskEncryptionKey source_disk_encryption_keys = 370408498;

Returns
Type	Description
int

getSourceDiskEncryptionKeysList()

public abstract List<SourceDiskEncryptionKey> getSourceDiskEncryptionKeysList()

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

repeated .google.cloud.compute.v1.SourceDiskEncryptionKey source_disk_encryption_keys = 370408498;

Returns
Type	Description
List<SourceDiskEncryptionKey>

getSourceDiskEncryptionKeysOrBuilder(int index)

public abstract SourceDiskEncryptionKeyOrBuilder getSourceDiskEncryptionKeysOrBuilder(int index)

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

repeated .google.cloud.compute.v1.SourceDiskEncryptionKey source_disk_encryption_keys = 370408498;

Parameter
Name	Description
index	int

Returns
Type	Description
SourceDiskEncryptionKeyOrBuilder

getSourceDiskEncryptionKeysOrBuilderList()

public abstract List<? extends SourceDiskEncryptionKeyOrBuilder> getSourceDiskEncryptionKeysOrBuilderList()

[Input Only] The customer-supplied encryption key of the disks attached to the source instance. Required if the source disk is protected by a customer-supplied encryption key.

repeated .google.cloud.compute.v1.SourceDiskEncryptionKey source_disk_encryption_keys = 370408498;

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

getSourceInstance()

public abstract String getSourceInstance()

The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type	Description
String	The sourceInstance.

getSourceInstanceBytes()

public abstract ByteString getSourceInstanceBytes()

The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type	Description
ByteString	The bytes for sourceInstance.

getSourceInstanceProperties()

public abstract SourceInstanceProperties getSourceInstanceProperties()

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

optional .google.cloud.compute.v1.SourceInstanceProperties source_instance_properties = 475195641;

Returns
Type	Description
SourceInstanceProperties	The sourceInstanceProperties.

getSourceInstancePropertiesOrBuilder()

public abstract SourceInstancePropertiesOrBuilder getSourceInstancePropertiesOrBuilder()

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

optional .google.cloud.compute.v1.SourceInstanceProperties source_instance_properties = 475195641;

Returns
Type	Description
SourceInstancePropertiesOrBuilder

getStatus()

public abstract String getStatus()

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. 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 machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. 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)

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

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 abstract ByteString getStorageLocationsBytes(int index)

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

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 abstract int getStorageLocationsCount()

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

repeated string storage_locations = 328005274;

Returns
Type	Description
int	The count of storageLocations.

getStorageLocationsList()

public abstract List<String> getStorageLocationsList()

The regional or multi-regional Cloud Storage bucket location where the machine image is stored.

repeated string storage_locations = 328005274;

Returns
Type	Description
List<String>	A list containing the storageLocations.

getTotalStorageBytes()

public abstract long getTotalStorageBytes()

[Output Only] Total size of the storage used by the machine image.

optional int64 total_storage_bytes = 81855468;

Returns
Type	Description
long	The totalStorageBytes.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] The creation timestamp for this machine image in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
boolean	Whether the creationTimestamp 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.

hasGuestFlush()

public abstract boolean hasGuestFlush()

[Input Only] Whether to attempt an application consistent machine image by informing the OS to prepare for the snapshot process.

optional bool guest_flush = 385550813;

Returns
Type	Description
boolean	Whether the guestFlush field is set.

hasId()

public abstract boolean hasId()

[Output Only] A unique identifier for this machine image. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type	Description
boolean	Whether the id field is set.

hasInstanceProperties()

public abstract boolean hasInstanceProperties()

[Output Only] Properties of source instance

optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

Returns
Type	Description
boolean	Whether the instanceProperties field is set.

hasKind()

public abstract boolean hasKind()

[Output Only] The resource type, which is always compute#machineImage for machine image.

optional string kind = 3292052;

Returns
Type	Description
boolean	Whether the kind field is set.

hasMachineImageEncryptionKey()

public abstract boolean hasMachineImageEncryptionKey()

Encrypts the machine image using a customer-supplied encryption key. After you encrypt a machine image using a customer-supplied key, you must provide the same key if you use the machine image later. For example, you must provide the encryption key when you create an instance from the encrypted machine image in a future request. Customer-supplied encryption keys do not protect access to metadata of the machine image. If you do not provide an encryption key when creating the machine image, then the machine image will be encrypted using an automatically generated key and you do not need to provide a key to use the machine image later.

optional .google.cloud.compute.v1.CustomerEncryptionKey machine_image_encryption_key = 528089087;

Returns
Type	Description
boolean	Whether the machineImageEncryptionKey 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.

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] The URL for this machine image. The server defines this URL.

optional string self_link = 456214797;

Returns
Type	Description
boolean	Whether the selfLink field is set.

hasSourceInstance()

public abstract boolean hasSourceInstance()

The source instance used to create the machine image. You can provide this as a partial or full URL to the resource. For example, the following are valid values: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance

optional string source_instance = 396315705;

Returns
Type	Description
boolean	Whether the sourceInstance field is set.

hasSourceInstanceProperties()

public abstract boolean hasSourceInstanceProperties()

[Output Only] DEPRECATED: Please use instance_properties instead for source instance related properties. New properties will not be added to this field.

optional .google.cloud.compute.v1.SourceInstanceProperties source_instance_properties = 475195641;

Returns
Type	Description
boolean	Whether the sourceInstanceProperties field is set.

hasStatus()

public abstract boolean hasStatus()

[Output Only] The status of the machine image. One of the following values: INVALID, CREATING, READY, DELETING, and UPLOADING. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type	Description
boolean	Whether the status field is set.

hasTotalStorageBytes()

public abstract boolean hasTotalStorageBytes()

[Output Only] Total size of the storage used by the machine image.

optional int64 total_storage_bytes = 81855468;

Returns
Type	Description
boolean	Whether the totalStorageBytes field is set.