Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::AttachedDiskInitializeParams (v1.9.0)

Version 1.9.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::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.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#architecture

def architecture() -> ::String

Returns

• (::String) — The architecture of the attached disk. Valid values are arm64 or x86_64. Check the Architecture enum for the list of possible values.

#architecture=

def architecture=(value) -> ::String

Parameter

• value (::String) — The architecture of the attached disk. Valid values are arm64 or x86_64. Check the Architecture enum for the list of possible values.

Returns

• (::String) — The architecture of the attached disk. Valid values are arm64 or x86_64. Check the Architecture enum for the list of possible values.

#description

def description() -> ::String

Returns

• (::String) — An optional description. Provide this property when creating the disk.

#description=

def description=(value) -> ::String

Parameter

• value (::String) — An optional description. Provide this property when creating the disk.

Returns

• (::String) — An optional description. Provide this property when creating the disk.

#disk_name

def disk_name() -> ::String

Returns

• (::String) — Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

#disk_name=

def disk_name=(value) -> ::String

Parameter

• value (::String) — Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

Returns

• (::String) — Specifies the disk name. If not specified, the default is to use the name of the instance. If a disk with the same name already exists in the given region, the existing disk is attached to the new instance and the new disk is not created.

#disk_size_gb

def disk_size_gb() -> ::Integer

Returns

• (::Integer) — Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer

Parameter

• value (::Integer) — Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

Returns

• (::Integer) — Specifies the size of the disk in base-2 GB. The size must be at least 10 GB. If you specify a sourceImage, which is required for boot disks, the default size is the size of the sourceImage. If you do not specify a sourceImage, the default disk size is 500 GB.

#disk_type

def disk_type() -> ::String

Returns

• (::String) — Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

#disk_type=

def disk_type=(value) -> ::String

Parameter

• value (::String) — Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

Returns

• (::String) — Specifies the disk type to use to create the instance. If not specified, the default is pd-standard, specified using the full URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/pd-standard For a full list of acceptable values, see Persistent disk types. If you specify this field when creating a VM, you can provide either the full or partial URL. For example, the following values are valid: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/diskType - zones/zone/diskTypes/diskType If you specify this field when creating or updating an instance template or all-instances configuration, specify the type of the disk, not the URL. For example: pd-standard.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this disk. These can be later modified by the disks.setLabels method. This field is only applicable for persistent disks.

#licenses

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

Returns

• (::Array<::String>) — A list of publicly visible licenses. Reserved for Google's use.

#licenses=

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

Parameter

• value (::Array<::String>) — A list of publicly visible licenses. Reserved for Google's use.

Returns

• (::Array<::String>) — A list of publicly visible licenses. Reserved for Google's use.

#on_update_action

def on_update_action() -> ::String

Returns

• (::String) — Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

#on_update_action=

def on_update_action=(value) -> ::String

Parameter

• value (::String) — Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

Returns

• (::String) — Specifies which action to take on instance update with this disk. Default is to use the existing disk. Check the OnUpdateAction enum for the list of possible values.

#provisioned_iops

def provisioned_iops() -> ::Integer

Returns

• (::Integer) — Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

#provisioned_iops=

def provisioned_iops=(value) -> ::Integer

Parameter

• value (::Integer) — Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

Returns

• (::Integer) — Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 10,000 and 120,000. For more details, see the Extreme persistent disk documentation.

#resource_manager_tags

def resource_manager_tags() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

#resource_manager_tags=

def resource_manager_tags=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Resource manager tags to be bound to the disk. Tag keys and values have the same definition as resource manager tags. Keys must be in the format tagKeys/{tag_key_id}, and values are in the format tagValues/456. The field is ignored (both PUT & PATCH) when empty.

#resource_policies

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

Returns

• (::Array<::String>) — Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

#resource_policies=

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

Parameter

• value (::Array<::String>) — Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

Returns

• (::Array<::String>) — Resource policies applied to this disk for automatic snapshot creations. Specified using the full or partial URL. For instance template, specify only the resource policy name.

#source_image

def source_image() -> ::String

Returns

• (::String) — The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

#source_image=

def source_image=(value) -> ::String

Parameter

• value (::String) — The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

Returns

• (::String) — The source image to create this disk. When creating a new instance, one of initializeParams.sourceImage or initializeParams.sourceSnapshot or disks.source is required except for local SSD. To create a disk with one of the public operating system images, specify the image by its family name. For example, specify family/debian-9 to use the latest Debian 9 image: projects/debian-cloud/global/images/family/debian-9 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-9-stretch-vYYYYMMDD To create a disk with a custom image that you created, specify the image name in the following format: global/images/my-custom-image You can also specify a custom image by its image family, which returns the latest version of the image in that family. Replace the image name with family/family-name: global/images/family/my-image-family If the source image is deleted later, this field will not be set.

#source_image_encryption_key

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

Returns

• (::Google::Cloud::Compute::V1::CustomerEncryptionKey) — The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

#source_image_encryption_key=

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

Parameter

• value (::Google::Cloud::Compute::V1::CustomerEncryptionKey) — The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

Returns

• (::Google::Cloud::Compute::V1::CustomerEncryptionKey) — The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. InstanceTemplate and InstancePropertiesPatch do not store customer-supplied encryption keys, so you cannot create disks for instances in a managed instance group if the source images are encrypted with your own keys.

#source_snapshot

def source_snapshot() -> ::String

Returns

• (::String) — The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

#source_snapshot=

def source_snapshot=(value) -> ::String

Parameter

• value (::String) — The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

Returns

• (::String) — The source snapshot to create this disk. When creating a new instance, one of initializeParams.sourceSnapshot or initializeParams.sourceImage or disks.source is required except for local SSD. To create a disk with a snapshot that you created, specify the snapshot name in the following format: global/snapshots/my-backup If the source snapshot is deleted later, this field will not be set.

#source_snapshot_encryption_key

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

Returns

• (::Google::Cloud::Compute::V1::CustomerEncryptionKey) — The customer-supplied encryption key of the source snapshot.

#source_snapshot_encryption_key=

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

Parameter

• value (::Google::Cloud::Compute::V1::CustomerEncryptionKey) — The customer-supplied encryption key of the source snapshot.

Returns

• (::Google::Cloud::Compute::V1::CustomerEncryptionKey) — The customer-supplied encryption key of the source snapshot.