Class: Google::Apis::NotebooksV1::Disk

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/notebooks_v1/classes.rb,
lib/google/apis/notebooks_v1/representations.rb,
lib/google/apis/notebooks_v1/representations.rb

Overview

An instance-attached disk resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Disk

Returns a new instance of Disk.



384
385
386
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 384

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#auto_delete ⇒ Boolean Also known as: auto_delete?

Indicates whether the disk will be auto-deleted when the instance is deleted ( but not when the disk is detached from the instance). Corresponds to the JSON property autoDelete

Returns:

  • (Boolean) 


305
306
307
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 305

def auto_delete
  @auto_delete
end

#boot ⇒ Boolean Also known as: boot?

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

Returns:

  • (Boolean) 


312
313
314
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 312

def boot
  @boot
end

#device_name ⇒ 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. Corresponds to the JSON property deviceName

Returns:

  • (String) 


324
325
326
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 324

def device_name
  @device_name
end

#disk_size_gb ⇒ Fixnum

Indicates the size of the disk in base-2 GB. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


329
330
331
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 329

def disk_size_gb
  @disk_size_gb
end

#guest_os_features ⇒ Array<Google::Apis::NotebooksV1::GuestOsFeature>

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. Corresponds to the JSON property guestOsFeatures

Returns:



336
337
338
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 336

def guest_os_features
  @guest_os_features
end

#index ⇒ Fixnum

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. Corresponds to the JSON property index

Returns:

  • (Fixnum) 


343
344
345
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 343

def index
  @index
end

#interface ⇒ 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 Corresponds to the JSON property interface

Returns:

  • (String) 


353
354
355
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 353

def interface
  @interface
end

#kind ⇒ String

Type of the resource. Always compute#attachedDisk for attached disks. Corresponds to the JSON property kind

Returns:

  • (String) 


358
359
360
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 358

def kind
  @kind
end

#licenses ⇒ 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. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


364
365
366
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 364

def licenses
  @licenses
end

#mode ⇒ 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 Corresponds to the JSON property mode

Returns:

  • (String) 


371
372
373
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 371

def mode
  @mode
end

#source ⇒ String

Indicates a valid partial or full URL to an existing Persistent Disk resource. Corresponds to the JSON property source

Returns:

  • (String) 


376
377
378
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 376

def source
  @source
end

#type ⇒ String

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

  • PERSISTENT * SCRATCH Corresponds to the JSON property type

Returns:

  • (String) 


382
383
384
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 382

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 389

def update!(**args)
  @auto_delete = args[:auto_delete] if args.key?(:auto_delete)
  @boot = args[:boot] if args.key?(:boot)
  @device_name = args[:device_name] if args.key?(:device_name)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @index = args[:index] if args.key?(:index)
  @interface = args[:interface] if args.key?(:interface)
  @kind = args[:kind] if args.key?(:kind)
  @licenses = args[:licenses] if args.key?(:licenses)
  @mode = args[:mode] if args.key?(:mode)
  @source = args[:source] if args.key?(:source)
  @type = args[:type] if args.key?(:type)
end