class Google::Apis::ComputeBeta::Disk
Represents a Persistent Disk
resource. Google
Compute Engine has two Disk
resources: * [Zonal](/compute/docs/reference/rest/beta/disks) * [Regional](/ compute/docs/reference/rest/beta/regionDisks) 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.
Attributes
- Output Only
-
Creation timestamp in RFC3339 text format.
Corresponds to the JSON property `creationTimestamp` @return [String]
An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property `description` @return [String]
Encrypts the disk using a customer-supplied encryption key or a customer- managed encryption key. Encryption keys do not protect access to metadata of the disk. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later. For example, to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine. After you encrypt a disk with a customer-managed key, the diskEncryptionKey.kmsKeyName is set to a key version name once the disk is created. The disk is encrypted with this version of the key. In the response, diskEncryptionKey.kmsKeyName appears in the following format: “ diskEncryptionKey.kmsKeyName”: “projects/kms_project_id/locations/region/ keyRings/ key_region/cryptoKeys/key /cryptoKeysVersions/version If you do not provide an encryption key when creating the disk, then the disk is encrypted using an automatically generated key and you don't need to provide a key to use the disk later. Corresponds to the JSON property `diskEncryptionKey` @return [Google::Apis::ComputeBeta::CustomerEncryptionKey]
Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. Corresponds to the JSON property `eraseWindowsVssSignature` @return [Boolean]
Specifies whether the disk restored from a source snapshot should erase Windows specific VSS signature. Corresponds to the JSON property `eraseWindowsVssSignature` @return [Boolean]
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` @return [Array<Google::Apis::ComputeBeta::GuestOsFeature>]
- Output Only
-
The unique identifier for the resource. This identifier is
defined by the server. Corresponds to the JSON property `id` @return [Fixnum]
- 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` @return [String]
- Output Only
-
Type of the resource. Always compute#disk for disks.
Corresponds to the JSON property `kind` @return [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. @return [String]
Labels to apply to this disk. These can be later modified by the setLabels method. Corresponds to the JSON property `labels` @return [Hash<String,String>]
- Output Only
-
Last attach timestamp in RFC3339 text format.
Corresponds to the JSON property `lastAttachTimestamp` @return [String]
- Output Only
-
Last detach timestamp in RFC3339 text format.
Corresponds to the JSON property `lastDetachTimestamp` @return [String]
Integer license codes indicating which licenses are attached to this disk. Corresponds to the JSON property `licenseCodes` @return [Array<Fixnum>]
A list of publicly visible licenses. Reserved for Google's use. Corresponds to the JSON property `licenses` @return [Array<String>]
An opaque location hint used to place the disk close to other resources. This field is for use by internal tools that use the public API. Corresponds to the JSON property `locationHint` @return [String]
- Output Only
-
The field indicates if the disk is created from a locked source
image. Attachment of a disk created from a locked source image will cause the following operations to become irreversibly prohibited: - R/W or R/O disk attachment to any other instance - Disk
detachment. And the disk can only be deleted when the instance is deleted - Creation of images or snapshots - Disk
cloning Furthermore, the instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Further attachment of secondary disks. - Detachment of any disks - Create machine images - Create instance template - Delete the instance with –keep-disk parameter set to true for locked disks - Attach a locked disk with –auto- delete parameter set to false Corresponds to the JSON property `locked` @return [Boolean]
- Output Only
-
The field indicates if the disk is created from a locked source
image. Attachment of a disk created from a locked source image will cause the following operations to become irreversibly prohibited: - R/W or R/O disk attachment to any other instance - Disk
detachment. And the disk can only be deleted when the instance is deleted - Creation of images or snapshots - Disk
cloning Furthermore, the instance with at least one disk with locked flag set to true will be prohibited from performing the operations below: - Further attachment of secondary disks. - Detachment of any disks - Create machine images - Create instance template - Delete the instance with –keep-disk parameter set to true for locked disks - Attach a locked disk with –auto- delete parameter set to false Corresponds to the JSON property `locked` @return [Boolean]
Indicates whether or not the disk can be read/write attached to more than one instance. Corresponds to the JSON property `multiWriter` @return [Boolean]
Indicates whether or not the disk can be read/write attached to more than one instance. Corresponds to the JSON property `multiWriter` @return [Boolean]
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]*)?` 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` @return [String]
Internal use only. Corresponds to the JSON property `options` @return [String]
Physical block size of the persistent disk, in bytes. If not present in a request, a default value is used. The currently supported size is 4096, 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` @return [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` @return [Fixnum]
- 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` @return [String]
URLs of the zones where the disk should be replicated to. Only applicable for regional resources. Corresponds to the JSON property `replicaZones` @return [Array<String>]
Resource policies applied to this disk for automatic snapshot creations. Corresponds to the JSON property `resourcePolicies` @return [Array<String>]
- Output Only
-
Reserved for future use.
Corresponds to the JSON property `satisfiesPzs` @return [Boolean]
- Output Only
-
Reserved for future use.
Corresponds to the JSON property `satisfiesPzs` @return [Boolean]
- Output Only
-
Server-defined fully-qualified URL for this resource.
Corresponds to the JSON property `selfLink` @return [String]
Size, in GB, of the persistent disk. You can specify this field when creating a persistent disk using the sourceImage, sourceSnapshot, or sourceDisk parameter, or specify it alone to create an empty persistent disk. If you specify this field along with a source, the value of sizeGb must not be less than the size of the source. Acceptable values are 1 to 65536, inclusive. Corresponds to the JSON property `sizeGb` @return [Fixnum]
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 - www.googleapis.com/compute/v1/projects/project/regions/region /disks/ disk - projects/project/zones/zone/disks/disk - projects/project/regions/ region/disks/disk - zones/zone/disks/disk - regions/region/disks/disk Corresponds to the JSON property `sourceDisk` @return [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` @return [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` @return [String]
The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key. Corresponds to the JSON property `sourceImageEncryptionKey` @return [Google::Apis::ComputeBeta::CustomerEncryptionKey]
- 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` @return [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: - www.googleapis.com/compute/v1/projects/project /global/ snapshots/snapshot - projects/project/global/snapshots/snapshot - global/ snapshots/snapshot Corresponds to the JSON property `sourceSnapshot` @return [String]
The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key. Corresponds to the JSON property `sourceSnapshotEncryptionKey` @return [Google::Apis::ComputeBeta::CustomerEncryptionKey]
- 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` @return [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/. This flag is not optimized for creating multiple disks from a source storage object. To create many disks from a source storage object, use gcloud compute images import instead. Corresponds to the JSON property `sourceStorageObject` @return [String]
- Deprecated
-
Storage type of the persistent disk.
Corresponds to the JSON property `storageType` @return [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-ssd . See Persistent disk types. Corresponds to the JSON property `type` @return [String]
A list of publicly visible user-licenses. Unlike regular licenses, user provided licenses can be modified after the disk is created. This includes a list of URLs to the license resource. For example, to provide a debian license: www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/ debian-9-stretch Corresponds to the JSON property `userLicenses` @return [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` @return [Array<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` @return [String]
Public Class Methods
# File lib/google/apis/compute_beta/classes.rb, line 5952 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/compute_beta/classes.rb, line 5957 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) @interface = args[:interface] if args.key?(:interface) @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) @location_hint = args[:location_hint] if args.key?(:location_hint) @locked = args[:locked] if args.key?(:locked) @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) @provisioned_iops = args[:provisioned_iops] if args.key?(:provisioned_iops) @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) @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @self_link = args[:self_link] if args.key?(:self_link) @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) @user_licenses = args[:user_licenses] if args.key?(:user_licenses) @users = args[:users] if args.key?(:users) @zone = args[:zone] if args.key?(:zone) end