Class: Google::Apis::ComputeAlpha::Disk
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Disk
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
Represents a Persistent Disk resource. Google Compute Engine has two Disk resources:
- Global * Regional
Persistent disks are required for running your VM instances. Create both boot
and non-boot (data) persistent disks. For more information, read Persistent
Disks. For more storage options, read Storage options.
The disks resource represents a zonal persistent disk. For more information,
read Zonal persistent disks.
The regionDisks resource represents a regional persistent disk. For more
information, read Regional resources. (== resource_for
$api_version
.disks == ) (== resource_for$api_version
.regionDisks ==)
Instance Attribute Summary collapse
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
diskEncryptionKey
. -
#erase_windows_vss_signature ⇒ Boolean
(also: #erase_windows_vss_signature?)
Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature.
-
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>
A list of features to enable on the guest operating system.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output Only] Type of the resource.
-
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this disk, which is essentially a hash of the labels set used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels to apply to this disk.
-
#last_attach_timestamp ⇒ String
[Output Only] Last attach timestamp in RFC3339 text format.
-
#last_detach_timestamp ⇒ String
[Output Only] Last detach timestamp in RFC3339 text format.
-
#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.
-
#name ⇒ String
Name of the resource.
-
#options ⇒ String
Internal use only.
-
#physical_block_size_bytes ⇒ Fixnum
Physical block size of the persistent disk, in bytes.
-
#region ⇒ String
[Output Only] URL of the region where the disk resides.
-
#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.
-
#self_link ⇒ String
[Output Only] Server-defined fully-qualified URL for this resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource's resource id.
-
#size_gb ⇒ Fixnum
Size of the persistent disk, specified in GB.
-
#source_disk ⇒ String
The source disk used to create this disk.
-
#source_disk_id ⇒ String
[Output Only] The unique ID of the disk used to create this disk.
-
#source_image ⇒ String
The source image used to create this disk.
-
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceImageEncryptionKey
. -
#source_image_id ⇒ String
[Output Only] The ID value of the image used to create this disk.
-
#source_snapshot ⇒ String
The source snapshot used to create this disk.
-
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceSnapshotEncryptionKey
. -
#source_snapshot_id ⇒ String
[Output Only] The unique ID of the snapshot used to create this disk.
-
#source_storage_object ⇒ String
The full Google Cloud Storage URI where the disk image is stored.
-
#status ⇒ String
[Output Only] The status of disk creation.
-
#storage_type ⇒ String
[Deprecated] Storage type of the persistent disk.
-
#type ⇒ String
URL of the disk type resource describing which disk type to use to create the disk.
-
#users ⇒ Array<String>
[Output Only] Links to the users of the disk (attached instances) in form: projects/project/zones/zone/instances/instance Corresponds to the JSON property
users
. -
#zone ⇒ String
[Output Only] URL of the zone where the disk resides.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Disk
constructor
A new instance of Disk.
-
#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) ⇒ Disk
Returns a new instance of Disk.
5519 5520 5521 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5519 def initialize(**args) update!(**args) end |
Instance Attribute Details
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
Corresponds to the JSON property creationTimestamp
5259 5260 5261 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5259 def @creation_timestamp end |
#description ⇒ String
An optional description of this resource. Provide this property when you
create the resource.
Corresponds to the JSON property description
5265 5266 5267 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5265 def description @description end |
#disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property diskEncryptionKey
5270 5271 5272 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5270 def disk_encryption_key @disk_encryption_key end |
#erase_windows_vss_signature ⇒ Boolean Also known as: erase_windows_vss_signature?
Specifies whether the disk restored from a source snapshot should erase
Windows specific VSS signature.
Corresponds to the JSON property eraseWindowsVssSignature
5276 5277 5278 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5276 def erase_windows_vss_signature @erase_windows_vss_signature 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.
Corresponds to the JSON property guestOsFeatures
5284 5285 5286 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5284 def guest_os_features @guest_os_features end |
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource. This identifier is
defined by the server.
Corresponds to the JSON property id
5290 5291 5292 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5290 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#disk for disks.
Corresponds to the JSON property kind
5295 5296 5297 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5295 def kind @kind end |
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this disk, which is essentially
a hash of the labels set used for optimistic locking. The fingerprint is
initially generated by Compute Engine and changes after every request to
modify or update labels. You must always provide an up-to-date fingerprint
hash in order to update or change labels, otherwise the request will fail with
error 412 conditionNotMet.
To see the latest fingerprint, make a get() request to retrieve a disk.
Corresponds to the JSON property labelFingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
5307 5308 5309 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5307 def label_fingerprint @label_fingerprint end |
#labels ⇒ Hash<String,String>
Labels to apply to this disk. These can be later modified by the setLabels
method.
Corresponds to the JSON property labels
5313 5314 5315 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5313 def labels @labels end |
#last_attach_timestamp ⇒ String
[Output Only] Last attach timestamp in RFC3339 text format.
Corresponds to the JSON property lastAttachTimestamp
5318 5319 5320 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5318 def @last_attach_timestamp end |
#last_detach_timestamp ⇒ String
[Output Only] Last detach timestamp in RFC3339 text format.
Corresponds to the JSON property lastDetachTimestamp
5323 5324 5325 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5323 def @last_detach_timestamp end |
#license_codes ⇒ Array<Fixnum>
Integer license codes indicating which licenses are attached to this disk.
Corresponds to the JSON property licenseCodes
5328 5329 5330 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5328 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
5333 5334 5335 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5333 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
5339 5340 5341 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5339 def multi_writer @multi_writer end |
#name ⇒ String
Name of the resource. Provided by the client when the resource is created. The
name must be 1-63 characters long, and comply with RFC1035. Specifically, the
name must be 1-63 characters long and match the regular expression [a-z]([-a-
z0-9]*[a-z0-9])?
which means the first character must be a lowercase letter,
and all following characters must be a dash, lowercase letter, or digit,
except the last character, which cannot be a dash.
Corresponds to the JSON property name
5350 5351 5352 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5350 def name @name end |
#options ⇒ String
Internal use only.
Corresponds to the JSON property options
5355 5356 5357 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5355 def @options end |
#physical_block_size_bytes ⇒ Fixnum
Physical block size of the persistent disk, in bytes. If not present in a
request, a default value is used. Currently supported sizes are 4096 and 16384,
other sizes may be added in the future. If an unsupported value is requested,
the error message will list the supported values for the caller's project.
Corresponds to the JSON property physicalBlockSizeBytes
5363 5364 5365 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5363 def physical_block_size_bytes @physical_block_size_bytes end |
#region ⇒ String
[Output Only] URL of the region where the disk resides. Only applicable for
regional resources. You must specify this field as part of the HTTP request
URL. It is not settable as a field in the request body.
Corresponds to the JSON property region
5370 5371 5372 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5370 def region @region 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
5376 5377 5378 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5376 def replica_zones @replica_zones end |
#resource_policies ⇒ Array<String>
Resource policies applied to this disk for automatic snapshot creations.
Corresponds to the JSON property resourcePolicies
5381 5382 5383 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5381 def resource_policies @resource_policies end |
#self_link ⇒ String
[Output Only] Server-defined fully-qualified URL for this resource.
Corresponds to the JSON property selfLink
5386 5387 5388 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5386 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource's resource id.
Corresponds to the JSON property selfLinkWithId
5391 5392 5393 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5391 def self_link_with_id @self_link_with_id end |
#size_gb ⇒ Fixnum
Size of the persistent disk, specified in GB. You can specify this field when
creating a persistent disk using the sourceImage or sourceSnapshot parameter,
or specify it alone to create an empty persistent disk.
If you specify this field along with sourceImage or sourceSnapshot, the value
of sizeGb must not be less than the size of the sourceImage or the size of the
snapshot. Acceptable values are 1 to 65536, inclusive.
Corresponds to the JSON property sizeGb
5401 5402 5403 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5401 def size_gb @size_gb end |
#source_disk ⇒ String
The source disk used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
- projects/project/zones/zone/disks/disk
- zones/zone/disks/disk
Corresponds to the JSON property
sourceDisk
5410 5411 5412 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5410 def source_disk @source_disk end |
#source_disk_id ⇒ String
[Output Only] The unique ID of the disk used to create this disk. This value
identifies the exact disk that was used to create this persistent disk. For
example, if you created the persistent disk from a disk that was later deleted
and recreated under the same name, the source disk ID would identify the exact
version of the disk that was used.
Corresponds to the JSON property sourceDiskId
5419 5420 5421 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5419 def source_disk_id @source_disk_id end |
#source_image ⇒ String
The source image used to create this disk. If the source image is deleted,
this field will not be set.
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
Corresponds to the JSON property sourceImage
5438 5439 5440 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5438 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceImageEncryptionKey
5443 5444 5445 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5443 def source_image_encryption_key @source_image_encryption_key end |
#source_image_id ⇒ String
[Output Only] The ID value of the image used to create this disk. This value
identifies the exact image that was used to create this persistent disk. For
example, if you created the persistent disk from an image that was later
deleted and recreated under the same name, the source image ID would identify
the exact version of the image that was used.
Corresponds to the JSON property sourceImageId
5452 5453 5454 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5452 def source_image_id @source_image_id end |
#source_snapshot ⇒ String
The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
- https://www.googleapis.com/compute/v1/projects/project/global/snapshots/ snapshot
- projects/project/global/snapshots/snapshot
- global/snapshots/snapshot
Corresponds to the JSON property
sourceSnapshot
5463 5464 5465 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5463 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceSnapshotEncryptionKey
5468 5469 5470 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5468 def source_snapshot_encryption_key @source_snapshot_encryption_key end |
#source_snapshot_id ⇒ String
[Output Only] The unique ID of the snapshot used to create this disk. This
value identifies the exact snapshot that was used to create this persistent
disk. For example, if you created the persistent disk from a snapshot that was
later deleted and recreated under the same name, the source snapshot ID would
identify the exact version of the snapshot that was used.
Corresponds to the JSON property sourceSnapshotId
5477 5478 5479 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5477 def source_snapshot_id @source_snapshot_id end |
#source_storage_object ⇒ String
The full Google Cloud Storage URI where the disk image is stored. This file
must be a gzip-compressed tarball whose name ends in .tar.gz or virtual
machine disk whose name ends in vmdk. Valid URIs may start with gs:// or https:
//storage.googleapis.com/.
Corresponds to the JSON property sourceStorageObject
5485 5486 5487 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5485 def source_storage_object @source_storage_object end |
#status ⇒ String
[Output Only] The status of disk creation. CREATING: Disk is provisioning.
RESTORING: Source data is being copied into the disk. FAILED: Disk creation
failed. READY: Disk is ready for use. DELETING: Disk is deleting.
Corresponds to the JSON property status
5492 5493 5494 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5492 def status @status end |
#storage_type ⇒ String
[Deprecated] Storage type of the persistent disk.
Corresponds to the JSON property storageType
5497 5498 5499 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5497 def storage_type @storage_type end |
#type ⇒ String
URL of the disk type resource describing which disk type to use to create the
disk. Provide this when creating the disk. For example: projects/project/zones/
zone/diskTypes/pd-standard or pd-ssd
Corresponds to the JSON property type
5504 5505 5506 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5504 def type @type end |
#users ⇒ Array<String>
[Output Only] Links to the users of the disk (attached instances) in form:
projects/project/zones/zone/instances/instance
Corresponds to the JSON property users
5510 5511 5512 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5510 def users @users end |
#zone ⇒ String
[Output Only] URL of the zone where the disk resides. You must specify this
field as part of the HTTP request URL. It is not settable as a field in the
request body.
Corresponds to the JSON property zone
5517 5518 5519 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5517 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 5543 5544 5545 5546 5547 5548 5549 5550 5551 5552 5553 5554 5555 5556 5557 5558 5559 5560 5561 5562 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 5524 def update!(**args) @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp) @description = args[:description] if args.key?(:description) @disk_encryption_key = args[:disk_encryption_key] if args.key?(:disk_encryption_key) @erase_windows_vss_signature = args[:erase_windows_vss_signature] if args.key?(:erase_windows_vss_signature) @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @last_attach_timestamp = args[:last_attach_timestamp] if args.key?(:last_attach_timestamp) @last_detach_timestamp = args[:last_detach_timestamp] if args.key?(:last_detach_timestamp) @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) @name = args[:name] if args.key?(:name) @options = args[:options] if args.key?(:options) @physical_block_size_bytes = args[:physical_block_size_bytes] if args.key?(:physical_block_size_bytes) @region = args[:region] if args.key?(:region) @replica_zones = args[:replica_zones] if args.key?(:replica_zones) @resource_policies = args[:resource_policies] if args.key?(:resource_policies) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @size_gb = args[:size_gb] if args.key?(:size_gb) @source_disk = args[:source_disk] if args.key?(:source_disk) @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id) @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_image_id = args[:source_image_id] if args.key?(:source_image_id) @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) @source_snapshot_id = args[:source_snapshot_id] if args.key?(:source_snapshot_id) @source_storage_object = args[:source_storage_object] if args.key?(:source_storage_object) @status = args[:status] if args.key?(:status) @storage_type = args[:storage_type] if args.key?(:storage_type) @type = args[:type] if args.key?(:type) @users = args[:users] if args.key?(:users) @zone = args[:zone] if args.key?(:zone) end |