Package com.google.cloud.notebooks.v1

Class Instance.Disk

  • All Implemented Interfaces:
    Instance.DiskOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Instance
    public static final class Instance.Disk
extends com.google.protobuf.GeneratedMessageV3
implements Instance.DiskOrBuilder
     An instance-attached disk resource.
    Protobuf type google.cloud.notebooks.v1.Instance.Disk
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Instance.Disk.Builder
      An instance-attached disk resource.
      static class  Instance.Disk.GuestOsFeature
      Guest OS features for boot disk.
      static interface  Instance.Disk.GuestOsFeatureOrBuilder  

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • 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()
         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;
        Specified by:
        getAutoDelete in interface Instance.DiskOrBuilder
        Returns:
        The autoDelete.

      • getBoot

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

      • getDeviceName

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

      • getDeviceNameBytes

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

      • getDiskSizeGb

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

      • getGuestOsFeaturesList

        public 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;
        Specified by:
        getGuestOsFeaturesList in interface Instance.DiskOrBuilder

      • getGuestOsFeaturesOrBuilderList

        public 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;
        Specified by:
        getGuestOsFeaturesOrBuilderList in interface Instance.DiskOrBuilder

      • getGuestOsFeaturesCount

        public 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;
        Specified by:
        getGuestOsFeaturesCount in interface Instance.DiskOrBuilder

      • getGuestOsFeatures

        public 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;
        Specified by:
        getGuestOsFeatures in interface Instance.DiskOrBuilder

      • getGuestOsFeaturesOrBuilder

        public 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;
        Specified by:
        getGuestOsFeaturesOrBuilder in interface Instance.DiskOrBuilder

      • getIndex

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

      • getInterface

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

      • getInterfaceBytes

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

      • getKind

        public String getKind()
         Type of the resource. Always compute#attachedDisk for attached
 disks.
        string kind = 8;
        Specified by:
        getKind in interface Instance.DiskOrBuilder
        Returns:
        The kind.

      • getKindBytes

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

      • getLicensesList

        public com.google.protobuf.ProtocolStringList 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;
        Specified by:
        getLicensesList in interface Instance.DiskOrBuilder
        Returns:
        A list containing the licenses.

      • getLicensesCount

        public 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;
        Specified by:
        getLicensesCount in interface Instance.DiskOrBuilder
        Returns:
        The count of licenses.

      • getLicenses

        public 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;
        Specified by:
        getLicenses in interface Instance.DiskOrBuilder
        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)
         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;
        Specified by:
        getLicensesBytes in interface Instance.DiskOrBuilder
        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 Instance.DiskOrBuilder
        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 Instance.DiskOrBuilder
        Returns:
        The bytes for mode.

      • getSource

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

      • getSourceBytes

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

      • getType

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

 * `PERSISTENT`
 * `SCRATCH`
        string type = 12;
        Specified by:
        getType in interface Instance.DiskOrBuilder
        Returns:
        The type.

      • getTypeBytes

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

 * `PERSISTENT`
 * `SCRATCH`
        string type = 12;
        Specified by:
        getTypeBytes in interface Instance.DiskOrBuilder
        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 Instance.Disk parseFrom​(ByteBuffer data)
                               throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static Instance.Disk getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Instance.Disk> 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 Instance.Disk getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder