Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::AttachedDisk (v1.3.0)

Version 1.3.0

• 2.15.0 (latest)
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::AttachedDisk.

An instance-attached disk resource.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#auto_delete

def auto_delete() -> ::Boolean

Returns

• (::Boolean) — Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

#auto_delete=

def auto_delete=(value) -> ::Boolean

Parameter

• value (::Boolean) — Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

Returns

• (::Boolean) — Specifies whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).

#boot

def boot() -> ::Boolean

Returns

• (::Boolean) — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

#boot=

def boot=(value) -> ::Boolean

Parameter

• value (::Boolean) — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

Returns

• (::Boolean) — Indicates that this is a boot disk. The virtual machine will use the first partition of the disk for its root filesystem.

#device_name

def device_name() -> ::String

Returns

• (::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.

#device_name=

def device_name=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#disk_encryption_key

def disk_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey

Returns

• (::Google::Cloud::Compute::V1::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.

#disk_encryption_key=

def disk_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey

Parameter

• value (::Google::Cloud::Compute::V1::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.

Returns

• (::Google::Cloud::Compute::V1::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.

#disk_size_gb

def disk_size_gb() -> ::Integer

Returns

• (::Integer) — The size of the disk in GB.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer

Parameter

• value (::Integer) — The size of the disk in GB.

Returns

• (::Integer) — The size of the disk in GB.

#guest_os_features

def guest_os_features() -> ::Array<::Google::Cloud::Compute::V1::GuestOsFeature>

Returns

• (::Array<::Google::Cloud::Compute::V1::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.

#guest_os_features=

def guest_os_features=(value) -> ::Array<::Google::Cloud::Compute::V1::GuestOsFeature>

Parameter

• value (::Array<::Google::Cloud::Compute::V1::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.

Returns

• (::Array<::Google::Cloud::Compute::V1::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.

#index

def index() -> ::Integer

Returns

• (::Integer) — [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.

#index=

def index=(value) -> ::Integer

Parameter

• value (::Integer) — [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.

Returns

• (::Integer) — [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.

#initialize_params

def initialize_params() -> ::Google::Cloud::Compute::V1::AttachedDiskInitializeParams

Returns

• (::Google::Cloud::Compute::V1::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.

#initialize_params=

def initialize_params=(value) -> ::Google::Cloud::Compute::V1::AttachedDiskInitializeParams

Parameter

• value (::Google::Cloud::Compute::V1::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.

Returns

• (::Google::Cloud::Compute::V1::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.

#interface

def interface() -> ::String

Returns

• (::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. Check the Interface enum for the list of possible values.

#interface=

def interface=(value) -> ::String

Parameter

• value (::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. Check the Interface enum for the list of possible values.

Returns

• (::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. Check the Interface enum for the list of possible values.

#kind

def kind() -> ::String

Returns

• (::String) — [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

#kind=

def kind=(value) -> ::String

Parameter

• value (::String) — [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

Returns

• (::String) — [Output Only] Type of the resource. Always compute#attachedDisk for attached disks.

#licenses

def licenses() -> ::Array<::String>

Returns

• (::Array<::String>) — [Output Only] Any valid publicly visible licenses.

#licenses=

def licenses=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — [Output Only] Any valid publicly visible licenses.

Returns

• (::Array<::String>) — [Output Only] Any valid publicly visible licenses.

#mode

def mode() -> ::String

Returns

• (::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. Check the Mode enum for the list of possible values.

#mode=

def mode=(value) -> ::String

Parameter

• value (::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. Check the Mode enum for the list of possible values.

Returns

• (::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. Check the Mode enum for the list of possible values.

#shielded_instance_initial_state

def shielded_instance_initial_state() -> ::Google::Cloud::Compute::V1::InitialStateConfig

Returns

• (::Google::Cloud::Compute::V1::InitialStateConfig) — [Output Only] shielded vm initial state stored on disk

#shielded_instance_initial_state=

def shielded_instance_initial_state=(value) -> ::Google::Cloud::Compute::V1::InitialStateConfig

Parameter

• value (::Google::Cloud::Compute::V1::InitialStateConfig) — [Output Only] shielded vm initial state stored on disk

Returns

• (::Google::Cloud::Compute::V1::InitialStateConfig) — [Output Only] shielded vm initial state stored on disk

#source

def source() -> ::String

Returns

• (::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 for zonal disk, and the URL for regional disk.

#source=

def source=(value) -> ::String

Parameter

• value (::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 for zonal disk, and the URL for regional disk.

Returns

• (::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 for zonal disk, and the URL for regional disk.

#type

def type() -> ::String

Returns

• (::String) — Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Check the Type enum for the list of possible values.

#type=

def type=(value) -> ::String

Parameter

• value (::String) — Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Check the Type enum for the list of possible values.

Returns

• (::String) — Specifies the type of the disk, either SCRATCH or PERSISTENT. If not specified, the default is PERSISTENT. Check the Type enum for the list of possible values.