Class: Google::Apis::ComputeV1::AttachedDiskInitializeParams
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::AttachedDiskInitializeParams
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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.
-
#labels ⇒ Hash<String,String>
Labels to apply to this 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::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceImageEncryptionKey
. -
#source_snapshot ⇒ String
The source snapshot to create this disk.
-
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceSnapshotEncryptionKey
.
Instance Method Summary collapse
-
#initialize(**args) ⇒ AttachedDiskInitializeParams
constructor
A new instance of AttachedDiskInitializeParams.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ AttachedDiskInitializeParams
Returns a new instance of AttachedDiskInitializeParams.
1373 1374 1375 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1373 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
1285 1286 1287 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1285 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 the disk with the instance name exists already in the given
zone/region, a new name will be automatically generated.
Corresponds to the JSON property diskName
1292 1293 1294 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1292 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
1300 1301 1302 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1300 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
1316 1317 1318 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1316 def disk_type @disk_type 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
1322 1323 1324 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1322 def labels @labels 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
1329 1330 1331 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1329 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
1350 1351 1352 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1350 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceImageEncryptionKey
1355 1356 1357 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1355 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
1366 1367 1368 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1366 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceSnapshotEncryptionKey
1371 1372 1373 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1371 def source_snapshot_encryption_key @source_snapshot_encryption_key end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 |
# File 'generated/google/apis/compute_v1/classes.rb', line 1378 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) @labels = args[:labels] if args.key?(:labels) @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 |