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

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

Returns a new instance of AttachedDisk



1768
1769
1770
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1768

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) 


1662
1663
1664
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1662

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) 


1669
1670
1671
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1669

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) 


1681
1682
1683
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1681

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:



1686
1687
1688
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1686

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) 


1692
1693
1694
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1692

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:



1699
1700
1701
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1699

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) 


1706
1707
1708
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1706

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:



1715
1716
1717
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1715

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) 


1724
1725
1726
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1724

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) 


1730
1731
1732
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1730

def kind
  @kind
end

#licenses ⇒ Array<String>

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

Returns:

  • (Array<String>) 


1735
1736
1737
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1735

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) 


1741
1742
1743
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1741

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) 


1749
1750
1751
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1749

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) 


1760
1761
1762
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1760

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) 


1766
1767
1768
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1766

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 1773

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