Class: Google::Apis::ComputeAlpha::AttachedDiskInitializeParams
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::AttachedDiskInitializeParams
- 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
[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.
Instance Attribute Summary collapse
-
#architecture ⇒ String
The architecture of the attached disk.
-
#description ⇒ String
An optional description.
-
#disk_name ⇒ String
Specifies the disk name.
-
#disk_size_gb ⇒ Fixnum
Specifies the size of the disk in base-2 GB.
-
#disk_type ⇒ String
Specifies the disk type to use to create the instance.
-
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>
A list of features to enable on the guest operating system.
-
#interface ⇒ String
[Deprecated] Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME.
-
#labels ⇒ Hash<String,String>
Labels to apply to this disk.
-
#license_codes ⇒ Array<Fixnum>
Integer license codes indicating which licenses are attached to this disk.
-
#licenses ⇒ Array<String>
A list of publicly visible licenses.
-
#multi_writer ⇒ Boolean
(also: #multi_writer?)
Indicates whether or not the disk can be read/write attached to more than one instance.
-
#on_update_action ⇒ String
Specifies which action to take on instance update with this disk.
-
#provisioned_iops ⇒ Fixnum
Indicates how many IOPS to provision for the disk.
-
#provisioned_throughput ⇒ Fixnum
Indicates how much throughput to provision for the disk.
-
#replica_zones ⇒ Array<String>
URLs of the zones where the disk should be replicated to.
-
#resource_manager_tags ⇒ Hash<String,String>
Resource manager tags to be bound to the disk.
-
#resource_policies ⇒ Array<String>
Resource policies applied to this disk for automatic snapshot creations.
-
#source_image ⇒ String
The source image to create this disk.
-
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source image.
-
#source_instant_snapshot ⇒ String
The source instant-snapshot to create this disk.
-
#source_snapshot ⇒ String
The source snapshot to create this disk.
-
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source snapshot.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AttachedDiskInitializeParams
constructor
A new instance of AttachedDiskInitializeParams.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ AttachedDiskInitializeParams
Returns a new instance of AttachedDiskInitializeParams.
1719 1720 1721 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1719 def initialize(**args) update!(**args) end |
Instance Attribute Details
#architecture ⇒ String
The architecture of the attached disk. Valid values are arm64 or x86_64.
Corresponds to the JSON property architecture
1553 1554 1555 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1553 def architecture @architecture end |
#description ⇒ String
An optional description. Provide this property when creating the disk.
Corresponds to the JSON property description
1558 1559 1560 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1558 def description @description end |
#disk_name ⇒ 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.
Corresponds to the JSON property diskName
1566 1567 1568 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1566 def disk_name @disk_name end |
#disk_size_gb ⇒ Fixnum
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.
Corresponds to the JSON property diskSizeGb
1574 1575 1576 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1574 def disk_size_gb @disk_size_gb end |
#disk_type ⇒ 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 define
this field, you can provide either the full or partial URL. For example, the
following are valid values: - https://www.googleapis.com/compute/v1/projects/
project/zones/zone /diskTypes/diskType - projects/project/zones/zone/diskTypes/
diskType - zones/zone/diskTypes/diskType Note that for InstanceTemplate, this
is the name of the disk type, not URL.
Corresponds to the JSON property diskType
1587 1588 1589 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1587 def disk_type @disk_type 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. Guest OS features are applied by merging
initializeParams.guestOsFeatures and disks.guestOsFeatures
Corresponds to the JSON property guestOsFeatures
1595 1596 1597 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1595 def guest_os_features @guest_os_features end |
#interface ⇒ String
[Deprecated] Specifies the disk interface to use for attaching this disk,
which is either SCSI or NVME. The default is SCSI.
Corresponds to the JSON property interface
1601 1602 1603 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1601 def interface @interface end |
#labels ⇒ Hash<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.
Corresponds to the JSON property labels
1607 1608 1609 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1607 def labels @labels end |
#license_codes ⇒ Array<Fixnum>
Integer license codes indicating which licenses are attached to this disk.
Corresponds to the JSON property licenseCodes
1612 1613 1614 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1612 def license_codes @license_codes end |
#licenses ⇒ Array<String>
A list of publicly visible licenses. Reserved for Google's use.
Corresponds to the JSON property licenses
1617 1618 1619 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1617 def licenses @licenses end |
#multi_writer ⇒ Boolean Also known as: multi_writer?
Indicates whether or not the disk can be read/write attached to more than one
instance.
Corresponds to the JSON property multiWriter
1623 1624 1625 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1623 def multi_writer @multi_writer end |
#on_update_action ⇒ String
Specifies which action to take on instance update with this disk. Default is
to use the existing disk.
Corresponds to the JSON property onUpdateAction
1630 1631 1632 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1630 def on_update_action @on_update_action end |
#provisioned_iops ⇒ Fixnum
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.
Corresponds to the JSON property provisionedIops
1637 1638 1639 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1637 def provisioned_iops @provisioned_iops end |
#provisioned_throughput ⇒ Fixnum
Indicates how much throughput to provision for the disk. This sets the number
of throughput mb per second that the disk can handle. Values must be between 1
and 7,124.
Corresponds to the JSON property provisionedThroughput
1644 1645 1646 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1644 def provisioned_throughput @provisioned_throughput end |
#replica_zones ⇒ Array<String>
URLs of the zones where the disk should be replicated to. Only applicable for
regional resources.
Corresponds to the JSON property replicaZones
1650 1651 1652 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1650 def replica_zones @replica_zones end |
#resource_manager_tags ⇒ Hash<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.
Corresponds to the JSON property
resourceManagerTags`
1658 1659 1660 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1658 def @resource_manager_tags end |
#resource_policies ⇒ 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.
Corresponds to the JSON property resourcePolicies
1665 1666 1667 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1665 def resource_policies @resource_policies end |
#source_image ⇒ 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.
Corresponds to the JSON property sourceImage
1682 1683 1684 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1682 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source image. Required if the
source image is protected by a customer-supplied encryption key. Instance
templates 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.
Corresponds to the JSON property sourceImageEncryptionKey
1691 1692 1693 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1691 def source_image_encryption_key @source_image_encryption_key end |
#source_instant_snapshot ⇒ String
The source instant-snapshot to create this disk. When creating a new instance,
one of initializeParams.sourceSnapshot or initializeParams.
sourceInstantSnapshot 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: us-central1-a/
instantSnapshots/my-backup If the source instant-snapshot is deleted later,
this field will not be set.
Corresponds to the JSON property sourceInstantSnapshot
1702 1703 1704 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1702 def source_instant_snapshot @source_instant_snapshot end |
#source_snapshot ⇒ 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.
Corresponds to the JSON property sourceSnapshot
1712 1713 1714 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1712 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source snapshot.
Corresponds to the JSON property sourceSnapshotEncryptionKey
1717 1718 1719 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1717 def source_snapshot_encryption_key @source_snapshot_encryption_key end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1724 def update!(**args) @architecture = args[:architecture] if args.key?(:architecture) @description = args[:description] if args.key?(:description) @disk_name = args[:disk_name] if args.key?(:disk_name) @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb) @disk_type = args[:disk_type] if args.key?(:disk_type) @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @interface = args[:interface] if args.key?(:interface) @labels = args[:labels] if args.key?(:labels) @license_codes = args[:license_codes] if args.key?(:license_codes) @licenses = args[:licenses] if args.key?(:licenses) @multi_writer = args[:multi_writer] if args.key?(:multi_writer) @on_update_action = args[:on_update_action] if args.key?(:on_update_action) @provisioned_iops = args[:provisioned_iops] if args.key?(:provisioned_iops) @provisioned_throughput = args[:provisioned_throughput] if args.key?(:provisioned_throughput) @replica_zones = args[:replica_zones] if args.key?(:replica_zones) @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @source_image = args[:source_image] if args.key?(:source_image) @source_image_encryption_key = args[:source_image_encryption_key] if args.key?(:source_image_encryption_key) @source_instant_snapshot = args[:source_instant_snapshot] if args.key?(:source_instant_snapshot) @source_snapshot = args[:source_snapshot] if args.key?(:source_snapshot) @source_snapshot_encryption_key = args[:source_snapshot_encryption_key] if args.key?(:source_snapshot_encryption_key) end |