Class: Google::Apis::ComputeV1::AttachedDisk

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Overview

An instance-attached disk resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ AttachedDisk

Returns a new instance of AttachedDisk.


430
431
432
# File 'generated/google/apis/compute_v1/classes.rb', line 430

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

Instance Attribute Details

#auto_deleteBoolean Also known as: auto_delete?

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

348
349
350
# File 'generated/google/apis/compute_v1/classes.rb', line 348

def auto_delete
  @auto_delete
end

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

355
356
357
# File 'generated/google/apis/compute_v1/classes.rb', line 355

def boot
  @boot
end

#device_nameString

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

367
368
369
# File 'generated/google/apis/compute_v1/classes.rb', line 367

def device_name
  @device_name
end

#disk_encryption_keyGoogle::Apis::ComputeV1::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property diskEncryptionKey


372
373
374
# File 'generated/google/apis/compute_v1/classes.rb', line 372

def disk_encryption_key
  @disk_encryption_key
end

#indexFixnum

Assigns a zero-based index to this disk, where 0 is reserved for the boot disk. For example, if you have many disks attached to an instance, each disk would have a unique index number. If not specified, the server will choose an appropriate value. Corresponds to the JSON property index

Returns:

  • (Fixnum)

380
381
382
# File 'generated/google/apis/compute_v1/classes.rb', line 380

def index
  @index
end

#initialize_paramsGoogle::Apis::ComputeV1::AttachedDiskInitializeParams

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


389
390
391
# File 'generated/google/apis/compute_v1/classes.rb', line 389

def initialize_params
  @initialize_params
end

#interfaceString

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

Returns:

  • (String)

398
399
400
# File 'generated/google/apis/compute_v1/classes.rb', line 398

def interface
  @interface
end

#kindString

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

Returns:

  • (String)

404
405
406
# File 'generated/google/apis/compute_v1/classes.rb', line 404

def kind
  @kind
end

#licensesArray<String>

[Output Only] Any valid publicly visible licenses. Corresponds to the JSON property licenses

Returns:

  • (Array<String>)

409
410
411
# File 'generated/google/apis/compute_v1/classes.rb', line 409

def licenses
  @licenses
end

#modeString

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

Returns:

  • (String)

415
416
417
# File 'generated/google/apis/compute_v1/classes.rb', line 415

def mode
  @mode
end

#sourceString

Specifies a valid partial or full URL to an existing Persistent Disk resource. This field is only applicable for persistent disks. Note that for InstanceTemplate, it is just disk name, not URL for the disk. Corresponds to the JSON property source

Returns:

  • (String)

422
423
424
# File 'generated/google/apis/compute_v1/classes.rb', line 422

def source
  @source
end

#typeString

Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Corresponds to the JSON property type

Returns:

  • (String)

428
429
430
# File 'generated/google/apis/compute_v1/classes.rb', line 428

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


435
436
437
438
439
440
441
442
443
444
445
446
447
448
# File 'generated/google/apis/compute_v1/classes.rb', line 435

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_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key)
  @index = args[:index] if args.key?(:index)
  @initialize_params = args[:initialize_params] if args.key?(:initialize_params)
  @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