Class: Google::Cloud::Notebooks::V1::LocalDisk

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

Overview

A Local attached disk resource.

Defined Under Namespace

Classes: RuntimeGuestOsFeature

Instance Attribute Summary collapse

Instance Attribute Details

#auto_delete ⇒ ::Boolean (readonly)

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

Returns:

  • (::Boolean) —

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#boot ⇒ ::Boolean (readonly)

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

Returns:

  • (::Boolean) —

    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.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#device_name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

    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.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#guest_os_features ⇒ ::Array<::Google::Cloud::Notebooks::V1::LocalDisk::RuntimeGuestOsFeature> (readonly)

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

Returns:



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#index ⇒ ::Integer (readonly)

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

Returns:

  • (::Integer) —

    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.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#initialize_params ⇒ ::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams

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

Returns:

  • (::Google::Cloud::Notebooks::V1::LocalDiskInitializeParams) —

    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.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#interface ⇒ ::String

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

Returns:

  • (::String) —

    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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#kind ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#licenses ⇒ ::Array<::String> (readonly)

Returns Output only. Any valid publicly visible licenses.

Returns:

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

    Output only. Any valid publicly visible licenses.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    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


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#source ⇒ ::String

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

Returns:

  • (::String) —

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#type ⇒ ::String

Returns Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values:

  • PERSISTENT
  • SCRATCH.

Returns:

  • (::String) —

    Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Valid values:

    • PERSISTENT
    • SCRATCH


265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'proto_docs/google/cloud/notebooks/v1/runtime.rb', line 265

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

  # Optional. A list of features to enable on the guest operating system.
  # Applicable only for bootable images.
  # Read [Enabling guest operating system
  # features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-features)
  # to see a list of available options.
  # Guest OS features for boot disk.
  # @!attribute [rw] type
  #   @return [::String]
  #     The ID of a supported feature. Read [Enabling guest operating system
  #     features](https://cloud.google.com/compute/docs/images/create-delete-deprecate-private-images#guest-os-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 RuntimeGuestOsFeature
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end