Package com.google.cloud.notebooks.v1

Class LocalDisk

  • All Implemented Interfaces:
    LocalDiskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class LocalDisk
extends com.google.protobuf.GeneratedMessageV3
implements LocalDiskOrBuilder
     A Local attached disk resource.
    Protobuf type google.cloud.notebooks.v1.LocalDisk
    See Also:
    Serialized Form

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getAutoDelete

        public 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];
        Specified by:
        getAutoDelete in interface LocalDiskOrBuilder
        Returns:
        The autoDelete.

      • getBoot

        public 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];
        Specified by:
        getBoot in interface LocalDiskOrBuilder
        Returns:
        The boot.

      • getDeviceName

        public 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];
        Specified by:
        getDeviceName in interface LocalDiskOrBuilder
        Returns:
        The deviceName.

      • getDeviceNameBytes

        public 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];
        Specified by:
        getDeviceNameBytes in interface LocalDiskOrBuilder
        Returns:
        The bytes for deviceName.

      • getGuestOsFeaturesList

        public 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];
        Specified by:
        getGuestOsFeaturesList in interface LocalDiskOrBuilder

      • getGuestOsFeaturesOrBuilderList

        public 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];
        Specified by:
        getGuestOsFeaturesOrBuilderList in interface LocalDiskOrBuilder

      • getGuestOsFeaturesCount

        public 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];
        Specified by:
        getGuestOsFeaturesCount in interface LocalDiskOrBuilder

      • getGuestOsFeatures

        public 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];
        Specified by:
        getGuestOsFeatures in interface LocalDiskOrBuilder

      • getGuestOsFeaturesOrBuilder

        public 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];
        Specified by:
        getGuestOsFeaturesOrBuilder in interface LocalDiskOrBuilder

      • getIndex

        public 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];
        Specified by:
        getIndex in interface LocalDiskOrBuilder
        Returns:
        The index.

      • hasInitializeParams

        public 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];
        Specified by:
        hasInitializeParams in interface LocalDiskOrBuilder
        Returns:
        Whether the initializeParams field is set.

      • getInitializeParams

        public 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];
        Specified by:
        getInitializeParams in interface LocalDiskOrBuilder
        Returns:
        The initializeParams.

      • getInitializeParamsOrBuilder

        public 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];
        Specified by:
        getInitializeParamsOrBuilder in interface LocalDiskOrBuilder

      • getInterface

        public 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;
        Specified by:
        getInterface in interface LocalDiskOrBuilder
        Returns:
        The interface.

      • getInterfaceBytes

        public 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;
        Specified by:
        getInterfaceBytes in interface LocalDiskOrBuilder
        Returns:
        The bytes for interface.

      • getKind

        public String getKind()
         Output only. Type of the resource. Always compute#attachedDisk for attached disks.
        string kind = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getKind in interface LocalDiskOrBuilder
        Returns:
        The kind.

      • getKindBytes

        public 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];
        Specified by:
        getKindBytes in interface LocalDiskOrBuilder
        Returns:
        The bytes for kind.

      • getLicensesList

        public com.google.protobuf.ProtocolStringList getLicensesList()
         Output only. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLicensesList in interface LocalDiskOrBuilder
        Returns:
        A list containing the licenses.

      • getLicensesCount

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

      • getLicenses

        public String getLicenses​(int index)
         Output only. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLicenses in interface LocalDiskOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The licenses at the given index.

      • getLicensesBytes

        public com.google.protobuf.ByteString getLicensesBytes​(int index)
         Output only. Any valid publicly visible licenses.
        repeated string licenses = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getLicensesBytes in interface LocalDiskOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the licenses at the given index.

      • getMode

        public 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;
        Specified by:
        getMode in interface LocalDiskOrBuilder
        Returns:
        The mode.

      • getModeBytes

        public 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;
        Specified by:
        getModeBytes in interface LocalDiskOrBuilder
        Returns:
        The bytes for mode.

      • getSource

        public String getSource()
         Specifies a valid partial or full URL to an existing Persistent Disk
 resource.
        string source = 11;
        Specified by:
        getSource in interface LocalDiskOrBuilder
        Returns:
        The source.

      • getSourceBytes

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

      • getType

        public 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;
        Specified by:
        getType in interface LocalDiskOrBuilder
        Returns:
        The type.

      • getTypeBytes

        public 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;
        Specified by:
        getTypeBytes in interface LocalDiskOrBuilder
        Returns:
        The bytes for type.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static LocalDisk parseFrom​(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalDisk parseFrom​(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalDisk parseFrom​(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalDisk parseFrom​(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalDisk parseFrom​(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalDisk parseFrom​(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static LocalDisk parseFrom​(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException
        Throws:
        IOException

      • newBuilderForType

        public LocalDisk.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public LocalDisk.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected LocalDisk.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static LocalDisk getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<LocalDisk> parser()

      • getParserForType

        public com.google.protobuf.Parser<LocalDisk> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public LocalDisk getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder