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 property is mutually exclusive with the source property; you can only define one or the other, but not both.
Instance Attribute Summary collapse
-
#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.
-
#labels ⇒ Hash<String,String>
Labels to apply to this disk.
-
#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 must be provisioned for the disk.
-
#replica_zones ⇒ Array<String>
URLs of the zones where the disk should be replicated to.
-
#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_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.
1621 1622 1623 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1621 def initialize(**args) update!(**args) end |
Instance Attribute Details
#description ⇒ String
An optional description. Provide this property when creating the disk.
Corresponds to the JSON property description
1495 1496 1497 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1495 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
1503 1504 1505 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1503 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
1511 1512 1513 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1511 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 Other values include pd-ssd and local-ssd. 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
1527 1528 1529 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1527 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
1536 1537 1538 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1536 def guest_os_features @guest_os_features 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
1542 1543 1544 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1542 def labels @labels 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
1548 1549 1550 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1548 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
1555 1556 1557 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1555 def on_update_action @on_update_action end |
#provisioned_iops ⇒ Fixnum
Indicates how many IOPS must be provisioned for the disk.
Corresponds to the JSON property provisionedIops
1560 1561 1562 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1560 def provisioned_iops @provisioned_iops 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
1566 1567 1568 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1566 def replica_zones @replica_zones 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
1573 1574 1575 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1573 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
1594 1595 1596 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1594 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
1603 1604 1605 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1603 def source_image_encryption_key @source_image_encryption_key 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
1614 1615 1616 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1614 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
1619 1620 1621 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1619 def source_snapshot_encryption_key @source_snapshot_encryption_key end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 1626 def update!(**args) @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) @labels = args[:labels] if args.key?(:labels) @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) @replica_zones = args[:replica_zones] if args.key?(:replica_zones) @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_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 |