Class: Google::Apis::ComputeAlpha::AttachedDisk
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::AttachedDisk
- 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
-
#auto_delete ⇒ Boolean
(also: #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).
-
#boot ⇒ Boolean
(also: #boot?)
Indicates that this is a boot disk.
-
#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.
-
#disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Encrypts or decrypts a disk using a customer-supplied encryption key.
-
#disk_size_gb ⇒ Fixnum
The size of the disk in GB.
-
#force_attach ⇒ Boolean
(also: #force_attach?)
[Input Only] Whether to force attach the regional disk even if it's currently attached to another instance.
-
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>
A list of features to enable on the guest operating system.
-
#index ⇒ Fixnum
[Output Only] A zero-based index to this disk, where 0 is reserved for the boot disk.
-
#initialize_params ⇒ Google::Apis::ComputeAlpha::AttachedDiskInitializeParams
[Input Only] Specifies the parameters for a new disk that will be created alongside the new instance.
-
#interface ⇒ String
Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#licenses ⇒ Array<String>
[Output Only] Any valid publicly visible licenses.
-
#locked ⇒ Boolean
(also: #locked?)
[Output Only] Whether to indicate the attached disk is locked.
-
#mode ⇒ String
The mode in which to attach this disk, either READ_WRITE or READ_ONLY.
-
#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.
-
#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
. -
#source ⇒ String
Specifies a valid partial or full URL to an existing Persistent Disk resource.
-
#type ⇒ String
Specifies the type of the disk, either SCRATCH or PERSISTENT.
-
#user_licenses ⇒ Array<String>
[Output Only] A list of user provided licenses.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AttachedDisk
constructor
A new instance of AttachedDisk.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ AttachedDisk
Returns a new instance of AttachedDisk.
1435 1436 1437 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1435 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
1288 1289 1290 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1288 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
1295 1296 1297 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1295 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
1307 1308 1309 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1307 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. Instance templates do not store customer-supplied encryption keys,
so you cannot use your own keys to encrypt disks in a managed instance group.
Corresponds to the JSON property diskEncryptionKey
1323 1324 1325 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1323 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
1328 1329 1330 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1328 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
1335 1336 1337 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1335 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
1343 1344 1345 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1343 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
1350 1351 1352 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1350 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
1359 1360 1361 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1359 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
1368 1369 1370 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1368 def interface @interface end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#attachedDisk for attached
disks.
Corresponds to the JSON property kind
1374 1375 1376 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1374 def kind @kind end |
#licenses ⇒ Array<String>
[Output Only] Any valid publicly visible licenses.
Corresponds to the JSON property licenses
1379 1380 1381 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1379 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
1389 1390 1391 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1389 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
1396 1397 1398 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1396 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
1404 1405 1406 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1404 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
1410 1411 1412 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1410 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, one of initializeParams.sourceImage or
initializeParams.sourceSnapshot 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
1420 1421 1422 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1420 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
1426 1427 1428 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1426 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
1433 1434 1435 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1433 def user_licenses @user_licenses end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1440 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) @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 |