Class: Google::Apis::ComputeV1::Disk
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Disk
- Defined in:
- generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
diskEncryptionKey
. -
#guest_os_features ⇒ Array<Google::Apis::ComputeV1::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.
-
#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.
-
#size_gb ⇒ Fixnum
Size of the persistent disk, specified in GB.
-
#source_image ⇒ String
The source image used 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_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::ComputeV1::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.
-
#status ⇒ String
[Output Only] The status of disk creation.
-
#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.
4523 4524 4525 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4523 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
4313 4314 4315 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4313 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
4319 4320 4321 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4319 def description @description end |
#disk_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property diskEncryptionKey
4324 4325 4326 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4324 def disk_encryption_key @disk_encryption_key end |
#guest_os_features ⇒ Array<Google::Apis::ComputeV1::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
4331 4332 4333 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4331 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
4337 4338 4339 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4337 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#disk for disks.
Corresponds to the JSON property kind
4342 4343 4344 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4342 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.
4354 4355 4356 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4354 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
4360 4361 4362 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4360 def labels @labels end |
#last_attach_timestamp ⇒ String
[Output Only] Last attach timestamp in RFC3339 text format.
Corresponds to the JSON property lastAttachTimestamp
4365 4366 4367 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4365 def @last_attach_timestamp end |
#last_detach_timestamp ⇒ String
[Output Only] Last detach timestamp in RFC3339 text format.
Corresponds to the JSON property lastDetachTimestamp
4370 4371 4372 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4370 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
4375 4376 4377 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4375 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
4380 4381 4382 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4380 def licenses @licenses 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
4390 4391 4392 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4390 def name @name end |
#options ⇒ String
Internal use only.
Corresponds to the JSON property options
4395 4396 4397 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4395 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
4403 4404 4405 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4403 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
4410 4411 4412 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4410 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
4416 4417 4418 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4416 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
4421 4422 4423 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4421 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
4426 4427 4428 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4426 def self_link @self_link 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
4436 4437 4438 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4436 def size_gb @size_gb 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
4455 4456 4457 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4455 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
4460 4461 4462 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4460 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
4469 4470 4471 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4469 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
4480 4481 4482 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4480 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
4485 4486 4487 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4485 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
4494 4495 4496 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4494 def source_snapshot_id @source_snapshot_id 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
4501 4502 4503 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4501 def status @status 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
4508 4509 4510 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4508 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
4514 4515 4516 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4514 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
4521 4522 4523 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4521 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 |
# File 'generated/google/apis/compute_v1/classes.rb', line 4528 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) @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) @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) @size_gb = args[:size_gb] if args.key?(:size_gb) @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) @status = args[:status] if args.key?(:status) @type = args[:type] if args.key?(:type) @users = args[:users] if args.key?(:users) @zone = args[:zone] if args.key?(:zone) end |