Class: Google::Apis::ComputeAlpha::SavedAttachedDisk

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/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) ⇒ SavedAttachedDisk

Returns a new instance of SavedAttachedDisk



22634
22635
22636
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22634

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

Instance Attribute Details

#auto_delete ⇒ Boolean 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) 


22515
22516
22517
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22515

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) 


22522
22523
22524
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22522

def boot
  @boot
end

#device_name ⇒ String

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) 


22534
22535
22536
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22534

def device_name
  @device_name
end

#disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



22539
22540
22541
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22539

def disk_encryption_key
  @disk_encryption_key
end

#disk_size_gb ⇒ Fixnum

The size of the disk in base-2 GB. This supersedes disk_size_gb in InitializeParams. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


22545
22546
22547
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22545

def disk_size_gb
  @disk_size_gb
end

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

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:



22552
22553
22554
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22552

def guest_os_features
  @guest_os_features
end

#index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


22559
22560
22561
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22559

def index
  @index
end

#initialize_params ⇒ Google::Apis::ComputeAlpha::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

Returns:



22568
22569
22570
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22568

def initialize_params
  @initialize_params
end

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

Returns:

  • (String) 


22577
22578
22579
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22577

def interface
  @interface
end

#kind ⇒ String

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

Returns:

  • (String) 


22583
22584
22585
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22583

def kind
  @kind
end

#licenses ⇒ Array<String>

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

Returns:

  • (Array<String>) 


22588
22589
22590
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22588

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

Returns:

  • (String) 


22594
22595
22596
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22594

def mode
  @mode
end

#saved_state ⇒ String

For LocalSSD disks on VM Instances in STOPPED or SUSPENDED state, this field is set to PRESERVED if the LocalSSD data has been saved to a persistent location by customer request. (see the discard_local_ssd option on Stop/ Suspend). Read-only in the api. Corresponds to the JSON property savedState

Returns:

  • (String) 


22602
22603
22604
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22602

def saved_state
  @saved_state
end

#source ⇒ String

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance, one of initializeParams.sourceImage or disks. source is required except for local SSD. If desired, you can also attach existing non-root persistent disks using this property. This field is only applicable for persistent disks. Note that for InstanceTemplate, specify the disk name, not the URL for the disk. Corresponds to the JSON property source

Returns:

  • (String) 


22613
22614
22615
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22613

def source
  @source
end

#storage_bytes ⇒ Fixnum

[Output Only] A size of the storage used by the disk's snapshot. Corresponds to the JSON property storageBytes

Returns:

  • (Fixnum) 


22618
22619
22620
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22618

def storage_bytes
  @storage_bytes
end

#storage_bytes_status ⇒ String

[Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date. Corresponds to the JSON property storageBytesStatus

Returns:

  • (String) 


22626
22627
22628
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22626

def storage_bytes_status
  @storage_bytes_status
end

#type ⇒ String

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) 


22632
22633
22634
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22632

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
22649
22650
22651
22652
22653
22654
22655
22656
22657
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 22639

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)
  @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)
  @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)
  @saved_state = args[:saved_state] if args.key?(:saved_state)
  @source = args[:source] if args.key?(:source)
  @storage_bytes = args[:storage_bytes] if args.key?(:storage_bytes)
  @storage_bytes_status = args[:storage_bytes_status] if args.key?(:storage_bytes_status)
  @type = args[:type] if args.key?(:type)
end