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.



285
286
287
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 285

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) 


206
207
208
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 206

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) 


213
214
215
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 213

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) 


225
226
227
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 225

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) 


230
231
232
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 230

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:



237
238
239
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 237

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) 


244
245
246
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 244

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) 


254
255
256
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 254

def interface
  @interface
end

#kind ⇒ String

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

Returns:

  • (String) 


259
260
261
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 259

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


265
266
267
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 265

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) 


272
273
274
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 272

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) 


277
278
279
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 277

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) 


283
284
285
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 283

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 290

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