Class: Google::Cloud::Notebooks::V1::Instance::Disk

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/notebooks/v1/instance.rb

Overview

An instance-attached disk resource.

Defined Under Namespace

Classes: GuestOsFeature

Instance Attribute Summary collapse

Instance Attribute Details

#auto_delete ⇒ ::Boolean

Returns Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Returns:

  • (::Boolean) —

    Indicates whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#boot ⇒ ::Boolean

Returns Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Returns:

  • (::Boolean) —

    Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#device_name ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#disk_size_gb ⇒ ::Integer

Returns Indicates the size of the disk in base-2 GB.

Returns:

  • (::Integer) —

    Indicates the size of the disk in base-2 GB.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#guest_os_features ⇒ ::Array<::Google::Cloud::Notebooks::V1::Instance::Disk::GuestOsFeature>

Returns 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.

Returns:



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#index ⇒ ::Integer

Returns 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.

Returns:

  • (::Integer) —

    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.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#interface ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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


311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kind ⇒ ::String

Returns Type of the resource. Always compute#attachedDisk for attached disks.

Returns:

  • (::String) —

    Type of the resource. Always compute#attachedDisk for attached disks.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#licenses ⇒ ::Array<::String>

Returns A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.

Returns:

  • (::Array<::String>) —

    A list of publicly visible licenses. Reserved for Google's use. A License represents billing and aggregate usage data for public and marketplace images.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#mode ⇒ ::String

Returns 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.

Returns:

  • (::String) —

    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


311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source ⇒ ::String

Returns Indicates a valid partial or full URL to an existing Persistent Disk resource.

Returns:

  • (::String) —

    Indicates a valid partial or full URL to an existing Persistent Disk resource.



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type ⇒ ::String

Returns Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:

  • PERSISTENT
  • SCRATCH.

Returns:

  • (::String) —

    Indicates the type of the disk, either SCRATCH or PERSISTENT. Valid values:

    • PERSISTENT
    • SCRATCH


311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'proto_docs/google/cloud/notebooks/v1/instance.rb', line 311

class Disk
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read  Enabling guest operating system
  #     features to see a list of available options.
  #     Valid values:
  #
  #     * `FEATURE_TYPE_UNSPECIFIED`
  #     * `MULTI_IP_SUBNET`
  #     * `SECURE_BOOT`
  #     * `UEFI_COMPATIBLE`
  #     * `VIRTIO_SCSI_MULTIQUEUE`
  #     * `WINDOWS`
  class GuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end