Package com.google.cloud.notebooks.v1

Interface LocalDiskOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    LocalDisk, LocalDisk.Builder
    public interface LocalDiskOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getAutoDelete

        boolean getAutoDelete()
         Optional. Output only. Specifies 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The autoDelete.

      • getBoot

        boolean getBoot()
         Optional. Output only. 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 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The boot.

      • getDeviceName

        String getDeviceName()
         Optional. Output only. 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.
        string device_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The deviceName.

      • getDeviceNameBytes

        com.google.protobuf.ByteString getDeviceNameBytes()
         Optional. Output only. 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.
        string device_name = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The bytes for deviceName.

      • getGuestOsFeaturesList

        List<LocalDisk.RuntimeGuestOsFeature> getGuestOsFeaturesList()
         Output only. 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.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getGuestOsFeatures

        LocalDisk.RuntimeGuestOsFeature getGuestOsFeatures​(int index)
         Output only. 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.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getGuestOsFeaturesCount

        int getGuestOsFeaturesCount()
         Output only. 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.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getGuestOsFeaturesOrBuilderList

        List<? extends LocalDisk.RuntimeGuestOsFeatureOrBuilder> getGuestOsFeaturesOrBuilderList()
         Output only. 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.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getGuestOsFeaturesOrBuilder

        LocalDisk.RuntimeGuestOsFeatureOrBuilder getGuestOsFeaturesOrBuilder​(int index)
         Output only. 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.LocalDisk.RuntimeGuestOsFeature guest_os_features = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

      • getIndex

        int getIndex()
         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.
        int32 index = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        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.
        .google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];
        Returns:
        Whether the initializeParams field is set.

      • getInitializeParams

        LocalDiskInitializeParams 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.
        .google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];
        Returns:
        The initializeParams.

      • getInitializeParamsOrBuilder

        LocalDiskInitializeParamsOrBuilder 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.
        .google.cloud.notebooks.v1.LocalDiskInitializeParams initialize_params = 6 [(.google.api.field_behavior) = INPUT_ONLY];

      • getInterface

        String getInterface()
         Specifies 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()
         Specifies 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()
         Output only. Type of the resource. Always compute#attachedDisk for attached disks.
        string kind = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The kind.

      • getKindBytes

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

      • getLicensesList

        List<String> getLicensesList()
         Output only. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        A list containing the licenses.

      • getLicensesCount

        int getLicensesCount()
         Output only. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Returns:
        The count of licenses.

      • getLicenses

        String getLicenses​(int index)
         Output only. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        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. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        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()
         Specifies a valid partial or full URL to an existing Persistent Disk
 resource.
        string source = 11;
        Returns:
        The source.

      • getSourceBytes

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

      • getType

        String getType()
         Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
 specified, the default is `PERSISTENT`.
 Valid values:

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

      • getTypeBytes

        com.google.protobuf.ByteString getTypeBytes()
         Specifies the type of the disk, either `SCRATCH` or `PERSISTENT`. If not
 specified, the default is `PERSISTENT`.
 Valid values:

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