Package com.google.cloud.compute.v1

Interface AttachedDiskOrBuilder

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

  • Method Details

    • hasArchitecture

      boolean hasArchitecture()
       Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
 or X86_64.
 Check the Architecture enum for the list of possible values.
      optional string architecture = 302803283;
      Returns:
      Whether the architecture field is set.

    • getArchitecture

      String getArchitecture()
       Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
 or X86_64.
 Check the Architecture enum for the list of possible values.
      optional string architecture = 302803283;
      Returns:
      The architecture.

    • getArchitectureBytes

      com.google.protobuf.ByteString getArchitectureBytes()
       Output only. [Output Only] The architecture of the attached disk. Valid values are ARM64
 or X86_64.
 Check the Architecture enum for the list of possible values.
      optional string architecture = 302803283;
      Returns:
      The bytes for architecture.

    • hasAutoDelete

      boolean hasAutoDelete()
       Specifies whether the disk will be auto-deleted when the instance is
 deleted (but not when the disk is detached from the instance).
      optional bool auto_delete = 464761403;
      Returns:
      Whether the autoDelete field is set.

    • getAutoDelete

      boolean getAutoDelete()
       Specifies whether the disk will be auto-deleted when the instance is
 deleted (but not when the disk is detached from the instance).
      optional bool auto_delete = 464761403;
      Returns:
      The autoDelete.

    • hasBoot

      boolean hasBoot()
       Indicates that this is a boot disk. The virtual machine will use the first
 partition of the disk for its root filesystem.
      optional bool boot = 3029746;
      Returns:
      Whether the boot field is set.

    • getBoot

      boolean getBoot()
       Indicates that this is a boot disk. The virtual machine will use the first
 partition of the disk for its root filesystem.
      optional bool boot = 3029746;
      Returns:
      The boot.

    • hasDeviceName

      boolean hasDeviceName()
       Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
 running within the instance. This name can be used to reference the device
 for mounting, resizing, and so on, from within the instance.

 If not specified, the server chooses a default device name to apply to this
 disk, in the form persistent-disk-x, where x is a number
 assigned by Google Compute Engine. This field is only applicable for
 persistent disks.
      optional string device_name = 67541716;
      Returns:
      Whether the deviceName field is set.

    • getDeviceName

      String getDeviceName()
       Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
 running within the instance. This name can be used to reference the device
 for mounting, resizing, and so on, from within the instance.

 If not specified, the server chooses a default device name to apply to this
 disk, in the form persistent-disk-x, where x is a number
 assigned by Google Compute Engine. This field is only applicable for
 persistent disks.
      optional string device_name = 67541716;
      Returns:
      The deviceName.

    • getDeviceNameBytes

      com.google.protobuf.ByteString getDeviceNameBytes()
       Specifies a unique device name of your choice that is reflected into the/dev/disk/by-id/google-* tree of a Linux operating system
 running within the instance. This name can be used to reference the device
 for mounting, resizing, and so on, from within the instance.

 If not specified, the server chooses a default device name to apply to this
 disk, in the form persistent-disk-x, where x is a number
 assigned by Google Compute Engine. This field is only applicable for
 persistent disks.
      optional string device_name = 67541716;
      Returns:
      The bytes for deviceName.

    • hasDiskEncryptionKey

      boolean hasDiskEncryptionKey()
       Encrypts or decrypts a disk using acustomer-supplied
 encryption key.

 If you are creating a new disk, this field encrypts the new disk using
 an encryption key that you provide. If you are attaching an existing
 disk that is already encrypted, this field decrypts the disk using
 the customer-supplied encryption key.

 If you encrypt a disk using a customer-supplied key, you must provide the
 same key again when you attempt to use this resource at a later time. For
 example, you must provide the key when you create a snapshot or an image
 from the disk or when you attach the disk to a virtual machine instance.

 If you do not provide an encryption key, then the disk will be encrypted
 using an automatically generated key and you do not need to provide a key
 to use the disk later.

 Note:

 Instance templates do not storecustomer-supplied
 encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.

 You cannot create VMs that have disks with customer-supplied keys using
 the bulk
 insert method.
      optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
      Returns:
      Whether the diskEncryptionKey field is set.

    • getDiskEncryptionKey

      CustomerEncryptionKey getDiskEncryptionKey()
       Encrypts or decrypts a disk using acustomer-supplied
 encryption key.

 If you are creating a new disk, this field encrypts the new disk using
 an encryption key that you provide. If you are attaching an existing
 disk that is already encrypted, this field decrypts the disk using
 the customer-supplied encryption key.

 If you encrypt a disk using a customer-supplied key, you must provide the
 same key again when you attempt to use this resource at a later time. For
 example, you must provide the key when you create a snapshot or an image
 from the disk or when you attach the disk to a virtual machine instance.

 If you do not provide an encryption key, then the disk will be encrypted
 using an automatically generated key and you do not need to provide a key
 to use the disk later.

 Note:

 Instance templates do not storecustomer-supplied
 encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.

 You cannot create VMs that have disks with customer-supplied keys using
 the bulk
 insert method.
      optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;
      Returns:
      The diskEncryptionKey.

    • getDiskEncryptionKeyOrBuilder

      CustomerEncryptionKeyOrBuilder getDiskEncryptionKeyOrBuilder()
       Encrypts or decrypts a disk using acustomer-supplied
 encryption key.

 If you are creating a new disk, this field encrypts the new disk using
 an encryption key that you provide. If you are attaching an existing
 disk that is already encrypted, this field decrypts the disk using
 the customer-supplied encryption key.

 If you encrypt a disk using a customer-supplied key, you must provide the
 same key again when you attempt to use this resource at a later time. For
 example, you must provide the key when you create a snapshot or an image
 from the disk or when you attach the disk to a virtual machine instance.

 If you do not provide an encryption key, then the disk will be encrypted
 using an automatically generated key and you do not need to provide a key
 to use the disk later.

 Note:

 Instance templates do not storecustomer-supplied
 encryption keys, so you cannot use your own keys to encrypt disks in amanaged instance group.

 You cannot create VMs that have disks with customer-supplied keys using
 the bulk
 insert method.
      optional .google.cloud.compute.v1.CustomerEncryptionKey disk_encryption_key = 271660677;

    • hasDiskSizeGb

      boolean hasDiskSizeGb()
       The size of the disk in GB.
      optional int64 disk_size_gb = 316263735;
      Returns:
      Whether the diskSizeGb field is set.

    • getDiskSizeGb

      long getDiskSizeGb()
       The size of the disk in GB.
      optional int64 disk_size_gb = 316263735;
      Returns:
      The diskSizeGb.

    • hasForceAttach

      boolean hasForceAttach()
       [Input Only] Whether to force attach the regional disk even if it's
 currently attached to another instance. If you try to force attach a zonal
 disk to an instance, you will receive an error.
      optional bool force_attach = 142758425;
      Returns:
      Whether the forceAttach field is set.

    • getForceAttach

      boolean getForceAttach()
       [Input Only] Whether to force attach the regional disk even if it's
 currently attached to another instance. If you try to force attach a zonal
 disk to an instance, you will receive an error.
      optional bool force_attach = 142758425;
      Returns:
      The forceAttach.

    • getGuestOsFeaturesList

      List<GuestOsFeature> getGuestOsFeaturesList()
       A list of features to enable on the guest operating system. Applicable
 only for bootable images. Read
 Enabling guest operating system features to see a list of available
 options.
      repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

    • getGuestOsFeatures

      GuestOsFeature getGuestOsFeatures(int index)
       A list of features to enable on the guest operating system. Applicable
 only for bootable images. Read
 Enabling guest operating system features to see a list of available
 options.
      repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

    • getGuestOsFeaturesCount

      int getGuestOsFeaturesCount()
       A list of features to enable on the guest operating system. Applicable
 only for bootable images. Read
 Enabling guest operating system features to see a list of available
 options.
      repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

    • getGuestOsFeaturesOrBuilderList

      List<? extends GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()
       A list of features to enable on the guest operating system. Applicable
 only for bootable images. Read
 Enabling guest operating system features to see a list of available
 options.
      repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

    • getGuestOsFeaturesOrBuilder

      GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder(int index)
       A list of features to enable on the guest operating system. Applicable
 only for bootable images. Read
 Enabling guest operating system features to see a list of available
 options.
      repeated .google.cloud.compute.v1.GuestOsFeature guest_os_features = 79294545;

    • hasIndex

      boolean hasIndex()
       Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
 boot disk. If you have many disks attached to an instance, each
 disk would have a unique index number.
      optional int32 index = 100346066;
      Returns:
      Whether the index field is set.

    • getIndex

      int getIndex()
       Output only. [Output Only] A zero-based index to this disk, where 0 is reserved for the
 boot disk. If you have many disks attached to an instance, each
 disk would have a unique index number.
      optional int32 index = 100346066;
      Returns:
      The index.

    • hasInitializeParams

      boolean hasInitializeParams()
       [Input Only] Specifies the parameters for a new disk that will be created
 alongside the new instance. Use initialization parameters to create boot
 disks or local SSDs attached to the new instance.

 This property is mutually exclusive with the source property;
 you can only define one or the other, but not both.
      optional .google.cloud.compute.v1.AttachedDiskInitializeParams initialize_params = 17697045;
      Returns:
      Whether the initializeParams field is set.

    • getInitializeParams

      AttachedDiskInitializeParams getInitializeParams()
       [Input Only] Specifies the parameters for a new disk that will be created
 alongside the new instance. Use initialization parameters to create boot
 disks or local SSDs attached to the new instance.

 This property is mutually exclusive with the source property;
 you can only define one or the other, but not both.
      optional .google.cloud.compute.v1.AttachedDiskInitializeParams initialize_params = 17697045;
      Returns:
      The initializeParams.

    • getInitializeParamsOrBuilder

      AttachedDiskInitializeParamsOrBuilder getInitializeParamsOrBuilder()
       [Input Only] Specifies the parameters for a new disk that will be created
 alongside the new instance. Use initialization parameters to create boot
 disks or local SSDs attached to the new instance.

 This property is mutually exclusive with the source property;
 you can only define one or the other, but not both.
      optional .google.cloud.compute.v1.AttachedDiskInitializeParams initialize_params = 17697045;

    • hasInterface

      boolean hasInterface()
       Specifies the disk interface to use for attaching this disk, which is
 either SCSI or NVME. For most machine types, the
 default is SCSI. Local SSDs can use either NVME or SCSI.
 In certain configurations, persistent disks can use NVMe. For more
 information, seeAbout
 persistent disks.
 Check the Interface enum for the list of possible values.
      optional string interface = 502623545;
      Returns:
      Whether the interface field is set.

    • getInterface

      String getInterface()
       Specifies the disk interface to use for attaching this disk, which is
 either SCSI or NVME. For most machine types, the
 default is SCSI. Local SSDs can use either NVME or SCSI.
 In certain configurations, persistent disks can use NVMe. For more
 information, seeAbout
 persistent disks.
 Check the Interface enum for the list of possible values.
      optional string interface = 502623545;
      Returns:
      The interface.

    • getInterfaceBytes

      com.google.protobuf.ByteString getInterfaceBytes()
       Specifies the disk interface to use for attaching this disk, which is
 either SCSI or NVME. For most machine types, the
 default is SCSI. Local SSDs can use either NVME or SCSI.
 In certain configurations, persistent disks can use NVMe. For more
 information, seeAbout
 persistent disks.
 Check the Interface enum for the list of possible values.
      optional string interface = 502623545;
      Returns:
      The bytes for interface.

    • hasKind

      boolean hasKind()
       Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
      optional string kind = 3292052;
      Returns:
      Whether the kind field is set.

    • getKind

      String getKind()
       Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
      optional string kind = 3292052;
      Returns:
      The kind.

    • getKindBytes

      com.google.protobuf.ByteString getKindBytes()
       Output only. [Output Only] Type of the resource. Alwayscompute#attachedDisk for attached disks.
      optional string kind = 3292052;
      Returns:
      The bytes for kind.

    • getLicensesList

      List<String> getLicensesList()
       Output only. [Output Only] Any valid publicly visible licenses.
      repeated string licenses = 337642578;
      Returns:
      A list containing the licenses.

    • getLicensesCount

      int getLicensesCount()
       Output only. [Output Only] Any valid publicly visible licenses.
      repeated string licenses = 337642578;
      Returns:
      The count of licenses.

    • getLicenses

      String getLicenses(int index)
       Output only. [Output Only] Any valid publicly visible licenses.
      repeated string licenses = 337642578;
      Parameters:
      index - The index of the element to return.
      Returns:
      The licenses at the given index.

    • getLicensesBytes

      com.google.protobuf.ByteString getLicensesBytes(int index)
       Output only. [Output Only] Any valid publicly visible licenses.
      repeated string licenses = 337642578;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the licenses at the given index.

    • hasMode

      boolean hasMode()
       The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
 in READ_WRITE mode.
 Check the Mode enum for the list of possible values.
      optional string mode = 3357091;
      Returns:
      Whether the mode field is set.

    • getMode

      String getMode()
       The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
 in READ_WRITE mode.
 Check the Mode enum for the list of possible values.
      optional string mode = 3357091;
      Returns:
      The mode.

    • getModeBytes

      com.google.protobuf.ByteString getModeBytes()
       The mode in which to attach this disk, either READ_WRITE orREAD_ONLY. If not specified, the default is to attach the disk
 in READ_WRITE mode.
 Check the Mode enum for the list of possible values.
      optional string mode = 3357091;
      Returns:
      The bytes for mode.

    • hasSavedState

      boolean hasSavedState()
       Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
 field is set to PRESERVED if the LocalSSD data has been saved
 to a persistent location by customer request.  (see the
 discard_local_ssd option on Stop/Suspend).
 Read-only in the api.
 Check the SavedState enum for the list of possible values.
      optional string saved_state = 411587801;
      Returns:
      Whether the savedState field is set.

    • getSavedState

      String getSavedState()
       Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
 field is set to PRESERVED if the LocalSSD data has been saved
 to a persistent location by customer request.  (see the
 discard_local_ssd option on Stop/Suspend).
 Read-only in the api.
 Check the SavedState enum for the list of possible values.
      optional string saved_state = 411587801;
      Returns:
      The savedState.

    • getSavedStateBytes

      com.google.protobuf.ByteString getSavedStateBytes()
       Output only. For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this
 field is set to PRESERVED if the LocalSSD data has been saved
 to a persistent location by customer request.  (see the
 discard_local_ssd option on Stop/Suspend).
 Read-only in the api.
 Check the SavedState enum for the list of possible values.
      optional string saved_state = 411587801;
      Returns:
      The bytes for savedState.

    • hasShieldedInstanceInitialState

      boolean hasShieldedInstanceInitialState()
       Output only. [Output Only] shielded vm initial state stored on disk
      optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;
      Returns:
      Whether the shieldedInstanceInitialState field is set.

    • getShieldedInstanceInitialState

      InitialStateConfig getShieldedInstanceInitialState()
       Output only. [Output Only] shielded vm initial state stored on disk
      optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;
      Returns:
      The shieldedInstanceInitialState.

    • getShieldedInstanceInitialStateOrBuilder

      InitialStateConfigOrBuilder getShieldedInstanceInitialStateOrBuilder()
       Output only. [Output Only] shielded vm initial state stored on disk
      optional .google.cloud.compute.v1.InitialStateConfig shielded_instance_initial_state = 192356867;

    • hasSource

      boolean hasSource()
       Specifies a valid partial or full URL to an existing Persistent Disk
 resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
 is required.

 If desired, you can also attach existing non-root persistent disks using
 this property. This field is only applicable for persistent disks.

 Note that for InstanceTemplate, specify the disk name for zonal disk,
 and the URL for regional disk.
      optional string source = 177235995;
      Returns:
      Whether the source field is set.

    • getSource

      String getSource()
       Specifies a valid partial or full URL to an existing Persistent Disk
 resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
 is required.

 If desired, you can also attach existing non-root persistent disks using
 this property. This field is only applicable for persistent disks.

 Note that for InstanceTemplate, specify the disk name for zonal disk,
 and the URL for regional disk.
      optional string source = 177235995;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       Specifies a valid partial or full URL to an existing Persistent Disk
 resource. When creating a new instance boot disk, one ofinitializeParams.sourceImage orinitializeParams.sourceSnapshot or disks.source
 is required.

 If desired, you can also attach existing non-root persistent disks using
 this property. This field is only applicable for persistent disks.

 Note that for InstanceTemplate, specify the disk name for zonal disk,
 and the URL for regional disk.
      optional string source = 177235995;
      Returns:
      The bytes for source.

    • hasType

      boolean hasType()
       Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
 Check the Type enum for the list of possible values.
      optional string type = 3575610;
      Returns:
      Whether the type field is set.

    • getType

      String getType()
       Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
 Check the Type enum for the list of possible values.
      optional string type = 3575610;
      Returns:
      The type.

    • getTypeBytes

      com.google.protobuf.ByteString getTypeBytes()
       Specifies the type of the disk, either SCRATCH orPERSISTENT. If not specified, the default isPERSISTENT.
 Check the Type enum for the list of possible values.
      optional string type = 3575610;
      Returns:
      The bytes for type.