Package com.google.cloud.compute.v1

Interface MachineImageOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
MachineImage, MachineImage.Builder
@Generated public interface MachineImageOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasCreationTimestamp

      boolean hasCreationTimestamp()
       Output only. [Output Only] The creation timestamp for this machine image inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      Whether the creationTimestamp field is set.

    • getCreationTimestamp

      String getCreationTimestamp()
       Output only. [Output Only] The creation timestamp for this machine image inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The creationTimestamp.

    • getCreationTimestampBytes

      com.google.protobuf.ByteString getCreationTimestampBytes()
       Output only. [Output Only] The creation timestamp for this machine image inRFC3339
 text format.
      optional string creation_timestamp = 30525366;
      Returns:
      The bytes for creationTimestamp.

    • hasDescription

      boolean hasDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      Whether the description field is set.

    • getDescription

      String getDescription()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The description.

    • getDescriptionBytes

      com.google.protobuf.ByteString getDescriptionBytes()
       An optional description of this resource. Provide this property when you
 create the resource.
      optional string description = 422937596;
      Returns:
      The bytes for description.

    • hasGuestFlush

      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:
      Whether the guestFlush field is set.

    • getGuestFlush

      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:
      The guestFlush.

    • hasId

      boolean hasId()
       Output only. [Output Only] A unique identifier for this machine image. The server
 defines this identifier.
      optional uint64 id = 3355;
      Returns:
      Whether the id field is set.

    • getId

      long getId()
       Output only. [Output Only] A unique identifier for this machine image. The server
 defines this identifier.
      optional uint64 id = 3355;
      Returns:
      The id.

    • hasInstanceProperties

      boolean hasInstanceProperties()
       [Output Only] Properties of source instance
      optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;
      Returns:
      Whether the instanceProperties field is set.

    • getInstanceProperties

      InstanceProperties getInstanceProperties()
       [Output Only] Properties of source instance
      optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;
      Returns:
      The instanceProperties.

    • getInstancePropertiesOrBuilder

      InstancePropertiesOrBuilder getInstancePropertiesOrBuilder()
       [Output Only] Properties of source instance
      optional .google.cloud.compute.v1.InstanceProperties instance_properties = 215355165;

    • hasKind

      boolean hasKind()
       Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.

    • getKind

      String getKind()
       Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
      optional string kind = 3292052;
      Returns:
      The kind.

    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] The resource type, which is alwayscompute#machineImage for machine image.
      optional string kind = 3292052;
      Returns:
      The bytes for kind.

    • hasLabelFingerprint

      boolean hasLabelFingerprint()
       A fingerprint for the labels being applied to this machine image, which is
 essentially a hash of the labels set 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.

 To see the latest fingerprint, make get() request to the
 machine image.
      optional string label_fingerprint = 178124825;
      Returns:
      Whether the labelFingerprint field is set.

    • getLabelFingerprint

      String getLabelFingerprint()
       A fingerprint for the labels being applied to this machine image, which is
 essentially a hash of the labels set 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.

 To see the latest fingerprint, make get() request to the
 machine image.
      optional string label_fingerprint = 178124825;
      Returns:
      The labelFingerprint.

    • getLabelFingerprintBytes

      com.google.protobuf.ByteString getLabelFingerprintBytes()
       A fingerprint for the labels being applied to this machine image, which is
 essentially a hash of the labels set 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.

 To see the latest fingerprint, make get() request to the
 machine image.
      optional string label_fingerprint = 178124825;
      Returns:
      The bytes for labelFingerprint.

    • getLabelsCount

      int getLabelsCount()
       Labels to apply to this machine image. These can be later modified by
 the setLabels method.
      map<string, string> labels = 500195327;

    • containsLabels

      boolean containsLabels(String key)
       Labels to apply to this machine image. These can be later modified by
 the setLabels method.
      map<string, string> labels = 500195327;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       Labels to apply to this machine image. These can be later modified by
 the setLabels method.
      map<string, string> labels = 500195327;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       Labels to apply to this machine image. These can be later modified by
 the setLabels method.
      map<string, string> labels = 500195327;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       Labels to apply to this machine image. These can be later modified by
 the setLabels method.
      map<string, string> labels = 500195327;

    • hasMachineImageEncryptionKey

      boolean hasMachineImageEncryptionKey()
       Encrypts the machine image using acustomer-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:
      Whether the machineImageEncryptionKey field is set.

    • getMachineImageEncryptionKey

      CustomerEncryptionKey getMachineImageEncryptionKey()
       Encrypts the machine image using acustomer-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:
      The machineImageEncryptionKey.

    • getMachineImageEncryptionKeyOrBuilder

      CustomerEncryptionKeyOrBuilder getMachineImageEncryptionKeyOrBuilder()
       Encrypts the machine image using acustomer-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;

    • hasName

      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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be
 a dash, lowercase letter, or digit, except the last character, which cannot
 be a dash.
      optional string name = 3373707;
      Returns:
      Whether the name field is set.

    • getName

      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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be
 a dash, lowercase letter, or digit, except the last character, which cannot
 be a dash.
      optional string name = 3373707;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.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 withRFC1035.
 Specifically, the name must be 1-63 characters long and match the regular
 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first
 character must be a lowercase letter, and all following characters must be
 a dash, lowercase letter, or digit, except the last character, which cannot
 be a dash.
      optional string name = 3373707;
      Returns:
      The bytes for name.

    • hasParams

      boolean hasParams()
       Input only. [Input Only] Additional parameters that are passed in the request, but are
 not persisted in the resource.
      optional .google.cloud.compute.v1.MachineImageParams params = 78313862;
      Returns:
      Whether the params field is set.

    • getParams

      MachineImageParams getParams()
       Input only. [Input Only] Additional parameters that are passed in the request, but are
 not persisted in the resource.
      optional .google.cloud.compute.v1.MachineImageParams params = 78313862;
      Returns:
      The params.

    • getParamsOrBuilder

      MachineImageParamsOrBuilder getParamsOrBuilder()
       Input only. [Input Only] Additional parameters that are passed in the request, but are
 not persisted in the resource.
      optional .google.cloud.compute.v1.MachineImageParams params = 78313862;

    • hasSatisfiesPzi

      boolean hasSatisfiesPzi()
       Output only. Reserved for future use.
      optional bool satisfies_pzi = 480964257;
      Returns:
      Whether the satisfiesPzi field is set.

    • getSatisfiesPzi

      boolean getSatisfiesPzi()
       Output only. Reserved for future use.
      optional bool satisfies_pzi = 480964257;
      Returns:
      The satisfiesPzi.

    • hasSatisfiesPzs

      boolean hasSatisfiesPzs()
       Output only. [Output Only] Reserved for future use.
      optional bool satisfies_pzs = 480964267;
      Returns:
      Whether the satisfiesPzs field is set.

    • getSatisfiesPzs

      boolean getSatisfiesPzs()
       Output only. [Output Only] Reserved for future use.
      optional bool satisfies_pzs = 480964267;
      Returns:
      The satisfiesPzs.

    • getSavedDisksList

      List<SavedDisk> getSavedDisksList()
       Output only. An array of Machine Image specific properties for disks attached to the
 source instance
      repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

    • getSavedDisks

      SavedDisk getSavedDisks(int index)
       Output only. An array of Machine Image specific properties for disks attached to the
 source instance
      repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

    • getSavedDisksCount

      int getSavedDisksCount()
       Output only. An array of Machine Image specific properties for disks attached to the
 source instance
      repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

    • getSavedDisksOrBuilderList

      List<? extends SavedDiskOrBuilder> getSavedDisksOrBuilderList()
       Output only. An array of Machine Image specific properties for disks attached to the
 source instance
      repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

    • getSavedDisksOrBuilder

      SavedDiskOrBuilder getSavedDisksOrBuilder(int index)
       Output only. An array of Machine Image specific properties for disks attached to the
 source instance
      repeated .google.cloud.compute.v1.SavedDisk saved_disks = 397424318;

    • hasSelfLink

      boolean hasSelfLink()
       Output only. [Output Only] The URL for this machine image. The server defines this URL.
      optional string self_link = 456214797;
      Returns:
      Whether the selfLink field is set.

    • getSelfLink

      String getSelfLink()
       Output only. [Output Only] The URL for this machine image. The server defines this URL.
      optional string self_link = 456214797;
      Returns:
      The selfLink.

    • getSelfLinkBytes

      com.google.protobuf.ByteString getSelfLinkBytes()
       Output only. [Output Only] The URL for this machine image. The server defines this URL.
      optional string self_link = 456214797;
      Returns:
      The bytes for selfLink.

    • getSourceDiskEncryptionKeysList

      List<SourceDiskEncryptionKey> getSourceDiskEncryptionKeysList()
       [Input Only] Thecustomer-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;

    • getSourceDiskEncryptionKeys

      SourceDiskEncryptionKey getSourceDiskEncryptionKeys(int index)
       [Input Only] Thecustomer-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;

    • getSourceDiskEncryptionKeysCount

      int getSourceDiskEncryptionKeysCount()
       [Input Only] Thecustomer-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;

    • getSourceDiskEncryptionKeysOrBuilderList

      List<? extends SourceDiskEncryptionKeyOrBuilder> getSourceDiskEncryptionKeysOrBuilderList()
       [Input Only] Thecustomer-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;

    • getSourceDiskEncryptionKeysOrBuilder

      SourceDiskEncryptionKeyOrBuilder getSourceDiskEncryptionKeysOrBuilder(int index)
       [Input Only] Thecustomer-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;

    • hasSourceInstance

      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:
      Whether the sourceInstance field is set.

    • getSourceInstance

      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:
      The sourceInstance.

    • getSourceInstanceBytes

      com.google.protobuf.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:
      The bytes for sourceInstance.

    • hasSourceInstanceProperties

      boolean hasSourceInstanceProperties()
       Output only. [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:
      Whether the sourceInstanceProperties field is set.

    • getSourceInstanceProperties

      SourceInstanceProperties getSourceInstanceProperties()
       Output only. [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:
      The sourceInstanceProperties.

    • getSourceInstancePropertiesOrBuilder

      SourceInstancePropertiesOrBuilder getSourceInstancePropertiesOrBuilder()
       Output only. [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;

    • hasStatus

      boolean hasStatus()
       Output only. [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:
      Whether the status field is set.

    • getStatus

      String getStatus()
       Output only. [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:
      The status.

    • getStatusBytes

      com.google.protobuf.ByteString getStatusBytes()
       Output only. [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:
      The bytes for status.

    • getStorageLocationsList

      List<String> getStorageLocationsList()
       The regional or multi-regional Cloud Storage bucket location where themachine image is
 stored.
      repeated string storage_locations = 328005274;
      Returns:
      A list containing the storageLocations.

    • getStorageLocationsCount

      int getStorageLocationsCount()
       The regional or multi-regional Cloud Storage bucket location where themachine image is
 stored.
      repeated string storage_locations = 328005274;
      Returns:
      The count of storageLocations.

    • getStorageLocations

      String getStorageLocations(int index)
       The regional or multi-regional Cloud Storage bucket location where themachine image is
 stored.
      repeated string storage_locations = 328005274;
      Parameters:
      index - The index of the element to return.
      Returns:
      The storageLocations at the given index.

    • getStorageLocationsBytes

      com.google.protobuf.ByteString getStorageLocationsBytes(int index)
       The regional or multi-regional Cloud Storage bucket location where themachine image is
 stored.
      repeated string storage_locations = 328005274;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the storageLocations at the given index.

    • hasTotalStorageBytes

      boolean hasTotalStorageBytes()
       Output only. [Output Only] Total size of the storage used by the machine image.
      optional int64 total_storage_bytes = 81855468;
      Returns:
      Whether the totalStorageBytes field is set.

    • getTotalStorageBytes

      long getTotalStorageBytes()
       Output only. [Output Only] Total size of the storage used by the machine image.
      optional int64 total_storage_bytes = 81855468;
      Returns:
      The totalStorageBytes.