Class: Google::Apis::ComputeAlpha::AttachedDisk

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

Overview

An instance-attached disk resource.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AttachedDisk

Returns a new instance of AttachedDisk.



1839
1840
1841
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1839

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

Instance Attribute Details

#architecture ⇒ String

[Output Only] The architecture of the attached disk. Valid values are ARM64 or X86_64. Corresponds to the JSON property architecture

Returns:

  • (String) 


1684
1685
1686
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1684

def architecture
  @architecture
end

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


1690
1691
1692
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1690

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) 


1697
1698
1699
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1697

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


1709
1710
1711
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1709

def device_name
  @device_name
end

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

Encrypts or decrypts a disk using a customer-supplied encryption key. If you are creating a new disk, this field encrypts the new disk using an encryption key that you provide. If you are attaching an existing disk that is already encrypted, this field decrypts the disk using the customer-supplied encryption key. If you encrypt a disk using a customer-supplied key, you must provide the same key again when you attempt to use this resource at a later time. For example, you must provide the key when you create a snapshot or an image from the disk or when you attach the disk to a virtual machine instance. If you do not provide an encryption key, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Note: Instance templates do not store customer-supplied encryption keys, so you cannot use your own keys to encrypt disks in a managed instance group. You cannot create VMs that have disks with customer-supplied keys using the bulk insert method. Corresponds to the JSON property diskEncryptionKey

Returns:



1727
1728
1729
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1727

def disk_encryption_key
  @disk_encryption_key
end

#disk_size_gb ⇒ Fixnum

The size of the disk in GB. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


1732
1733
1734
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1732

def disk_size_gb
  @disk_size_gb
end

#force_attach ⇒ Boolean Also known as: force_attach?

[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance. If you try to force attach a zonal disk to an instance, you will receive an error. Corresponds to the JSON property forceAttach

Returns:

  • (Boolean) 


1739
1740
1741
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1739

def force_attach
  @force_attach
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:



1747
1748
1749
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1747

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) 


1754
1755
1756
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1754

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 field is persisted and returned for instanceTemplate and not returned in the context of 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:



1764
1765
1766
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1764

def initialize_params
  @initialize_params
end

#interface ⇒ String

Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. For most machine types, the default is SCSI. Local SSDs can use either NVME or SCSI. In certain configurations, persistent disks can use NVMe. For more information, see About persistent disks. Corresponds to the JSON property interface

Returns:

  • (String) 


1772
1773
1774
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1772

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) 


1778
1779
1780
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1778

def kind
  @kind
end

#licenses ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1783
1784
1785
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1783

def licenses
  @licenses
end

#locked ⇒ Boolean Also known as: locked?

[Output Only] Whether to indicate the attached disk is locked. The locked disk is not allowed to be detached from the instance, or to be used as the source of the snapshot creation, and the image creation. The instance with at least one locked attached disk is not allow to be used as source of machine image creation, instant snapshot creation, and not allowed to be deleted with --keep- disk parameter set to true for locked disks. Corresponds to the JSON property locked

Returns:

  • (Boolean) 


1793
1794
1795
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1793

def locked
  @locked
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) 


1800
1801
1802
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1800

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) 


1808
1809
1810
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1808

def saved_state
  @saved_state
end

#shielded_instance_initial_state ⇒ Google::Apis::ComputeAlpha::InitialStateConfig

Initial State for shielded instance, these are public keys which are safe to store in public Corresponds to the JSON property shieldedInstanceInitialState

Returns:



1814
1815
1816
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1814

def shielded_instance_initial_state
  @shielded_instance_initial_state
end

#source ⇒ String

Specifies a valid partial or full URL to an existing Persistent Disk resource. When creating a new instance boot disk, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required. 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 for zonal disk, and the URL for regional disk. Corresponds to the JSON property source

Returns:

  • (String) 


1824
1825
1826
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1824

def source
  @source
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) 


1830
1831
1832
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1830

def type
  @type
end

#user_licenses ⇒ Array<String>

[Output Only] A list of user provided licenses. It represents a list of URLs to the license resource. Unlike regular licenses, user provided licenses can be modified after the disk is created. Corresponds to the JSON property userLicenses

Returns:

  • (Array<String>) 


1837
1838
1839
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1837

def user_licenses
  @user_licenses
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 1844

def update!(**args)
  @architecture = args[:architecture] if args.key?(:architecture)
  @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)
  @force_attach = args[:force_attach] if args.key?(:force_attach)
  @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)
  @locked = args[:locked] if args.key?(:locked)
  @mode = args[:mode] if args.key?(:mode)
  @saved_state = args[:saved_state] if args.key?(:saved_state)
  @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state)
  @source = args[:source] if args.key?(:source)
  @type = args[:type] if args.key?(:type)
  @user_licenses = args[:user_licenses] if args.key?(:user_licenses)
end