Package com.google.cloud.notebooks.v1

Interface Instance.DiskOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Instance.Disk, Instance.Disk.Builder
    Enclosing class:
    Instance
    public static interface Instance.DiskOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean getAutoDelete()
      Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
      boolean getBoot()
      Indicates that this is a boot disk.
      String getDeviceName()
      Indicates 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.
      com.google.protobuf.ByteString getDeviceNameBytes()
      Indicates 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.
      long getDiskSizeGb()
      Indicates the size of the disk in base-2 GB.
      Instance.Disk.GuestOsFeature getGuestOsFeatures​(int index)
      Indicates a list of features to enable on the guest operating system.
      int getGuestOsFeaturesCount()
      Indicates a list of features to enable on the guest operating system.
      List<Instance.Disk.GuestOsFeature> getGuestOsFeaturesList()
      Indicates a list of features to enable on the guest operating system.
      Instance.Disk.GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder​(int index)
      Indicates a list of features to enable on the guest operating system.
      List<? extends Instance.Disk.GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()
      Indicates a list of features to enable on the guest operating system.
      long getIndex()
      A zero-based index to this disk, where 0 is reserved for the boot disk.
      String getInterface()
      Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME.
      com.google.protobuf.ByteString getInterfaceBytes()
      Indicates the disk interface to use for attaching this disk, which is either SCSI or NVME.
      String getKind()
      Type of the resource.
      com.google.protobuf.ByteString getKindBytes()
      Type of the resource.
      String getLicenses​(int index)
      A list of publicly visible licenses.
      com.google.protobuf.ByteString getLicensesBytes​(int index)
      A list of publicly visible licenses.
      int getLicensesCount()
      A list of publicly visible licenses.
      List<String> getLicensesList()
      A list of publicly visible licenses.
      String getMode()
      The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
      com.google.protobuf.ByteString getModeBytes()
      The mode in which to attach this disk, either `READ_WRITE` or `READ_ONLY`.
      String getSource()
      Indicates a valid partial or full URL to an existing Persistent Disk resource.
      com.google.protobuf.ByteString getSourceBytes()
      Indicates a valid partial or full URL to an existing Persistent Disk resource.
      String getType()
      Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
      com.google.protobuf.ByteString getTypeBytes()
      Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getAutoDelete

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

      • 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.
        bool boot = 2;
        Returns:
        The boot.

      • getDeviceName

        String getDeviceName()
         Indicates 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.
        string device_name = 3;
        Returns:
        The deviceName.

      • getDeviceNameBytes

        com.google.protobuf.ByteString getDeviceNameBytes()
         Indicates 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.
        string device_name = 3;
        Returns:
        The bytes for deviceName.

      • getDiskSizeGb

        long getDiskSizeGb()
         Indicates the size of the disk in base-2 GB.
        int64 disk_size_gb = 4;
        Returns:
        The diskSizeGb.

      • getGuestOsFeaturesList

        List<Instance.Disk.GuestOsFeature> getGuestOsFeaturesList()
         Indicates 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.notebooks.v1.Instance.Disk.GuestOsFeature guest_os_features = 5;

      • getGuestOsFeatures

        Instance.Disk.GuestOsFeature getGuestOsFeatures​(int index)
         Indicates 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.notebooks.v1.Instance.Disk.GuestOsFeature guest_os_features = 5;

      • getGuestOsFeaturesCount

        int getGuestOsFeaturesCount()
         Indicates 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.notebooks.v1.Instance.Disk.GuestOsFeature guest_os_features = 5;

      • getGuestOsFeaturesOrBuilderList

        List<? extends Instance.Disk.GuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()
         Indicates 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.notebooks.v1.Instance.Disk.GuestOsFeature guest_os_features = 5;

      • getGuestOsFeaturesOrBuilder

        Instance.Disk.GuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder​(int index)
         Indicates 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.notebooks.v1.Instance.Disk.GuestOsFeature guest_os_features = 5;

      • getIndex

        long getIndex()
         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.
        int64 index = 6;
        Returns:
        The index.

      • getInterface

        String getInterface()
         Indicates the disk interface to use for attaching this disk, which is
 either SCSI or NVME. The default is SCSI. Persistent disks must always
 use SCSI and the request will fail if you attempt to attach a persistent
 disk in any other format than SCSI. Local SSDs can use either NVME or
 SCSI. For performance characteristics of SCSI over NVMe, see Local SSD
 performance.
 Valid values:

 * `NVME`
 * `SCSI`
        string interface = 7;
        Returns:
        The interface.

      • getInterfaceBytes

        com.google.protobuf.ByteString getInterfaceBytes()
         Indicates the disk interface to use for attaching this disk, which is
 either SCSI or NVME. The default is SCSI. Persistent disks must always
 use SCSI and the request will fail if you attempt to attach a persistent
 disk in any other format than SCSI. Local SSDs can use either NVME or
 SCSI. For performance characteristics of SCSI over NVMe, see Local SSD
 performance.
 Valid values:

 * `NVME`
 * `SCSI`
        string interface = 7;
        Returns:
        The bytes for interface.

      • getKind

        String getKind()
         Type of the resource. Always compute#attachedDisk for attached
 disks.
        string kind = 8;
        Returns:
        The kind.

      • getKindBytes

        com.google.protobuf.ByteString getKindBytes()
         Type of the resource. Always compute#attachedDisk for attached
 disks.
        string kind = 8;
        Returns:
        The bytes for kind.

      • getLicensesList

        List<String> getLicensesList()
         A list of publicly visible licenses. Reserved for Google's use.
 A License represents billing and aggregate usage data for public
 and marketplace images.
        repeated string licenses = 9;
        Returns:
        A list containing the licenses.

      • getLicensesCount

        int getLicensesCount()
         A list of publicly visible licenses. Reserved for Google's use.
 A License represents billing and aggregate usage data for public
 and marketplace images.
        repeated string licenses = 9;
        Returns:
        The count of licenses.

      • getLicenses

        String getLicenses​(int index)
         A list of publicly visible licenses. Reserved for Google's use.
 A License represents billing and aggregate usage data for public
 and marketplace images.
        repeated string licenses = 9;
        Parameters:
        index - The index of the element to return.
        Returns:
        The licenses at the given index.

      • getLicensesBytes

        com.google.protobuf.ByteString getLicensesBytes​(int index)
         A list of publicly visible licenses. Reserved for Google's use.
 A License represents billing and aggregate usage data for public
 and marketplace images.
        repeated string licenses = 9;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the licenses at the given index.

      • getMode

        String getMode()
         The mode in which to attach this disk, either `READ_WRITE` or
 `READ_ONLY`. If not specified, the default is to attach the disk in
 `READ_WRITE` mode. Valid values:

 * `READ_ONLY`
 * `READ_WRITE`
        string mode = 10;
        Returns:
        The mode.

      • getModeBytes

        com.google.protobuf.ByteString getModeBytes()
         The mode in which to attach this disk, either `READ_WRITE` or
 `READ_ONLY`. If not specified, the default is to attach the disk in
 `READ_WRITE` mode. Valid values:

 * `READ_ONLY`
 * `READ_WRITE`
        string mode = 10;
        Returns:
        The bytes for mode.

      • getSource

        String getSource()
         Indicates a valid partial or full URL to an existing Persistent Disk
 resource.
        string source = 11;
        Returns:
        The source.

      • getSourceBytes

        com.google.protobuf.ByteString getSourceBytes()
         Indicates a valid partial or full URL to an existing Persistent Disk
 resource.
        string source = 11;
        Returns:
        The bytes for source.

      • getType

        String getType()
         Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
 Valid values:

 * `PERSISTENT`
 * `SCRATCH`
        string type = 12;
        Returns:
        The type.

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         Indicates the type of the disk, either `SCRATCH` or `PERSISTENT`.
 Valid values:

 * `PERSISTENT`
 * `SCRATCH`
        string type = 12;
        Returns:
        The bytes for type.