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
A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==)
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
. -
#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>
Any applicable 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::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.
-
#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: 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
4277 4278 4279 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4277 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
4064 4065 4066 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4064 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
4070 4071 4072 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4070 def description @description end |
#disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property diskEncryptionKey
4075 4076 4077 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4075 def disk_encryption_key @disk_encryption_key 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
4082 4083 4084 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4082 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
4088 4089 4090 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4088 def id @id end |
#kind ⇒ String
[Output Only] Type of the resource. Always compute#disk for disks.
Corresponds to the JSON property kind
4093 4094 4095 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4093 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.
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.
4104 4105 4106 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4104 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
4110 4111 4112 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4110 def labels @labels end |
#last_attach_timestamp ⇒ String
[Output Only] Last attach timestamp in RFC3339 text format.
Corresponds to the JSON property lastAttachTimestamp
4115 4116 4117 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4115 def @last_attach_timestamp end |
#last_detach_timestamp ⇒ String
[Output Only] Last detach timestamp in RFC3339 text format.
Corresponds to the JSON property lastDetachTimestamp
4120 4121 4122 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4120 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
4125 4126 4127 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4125 def license_codes @license_codes end |
#licenses ⇒ Array<String>
Any applicable publicly visible licenses.
Corresponds to the JSON property licenses
4130 4131 4132 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4130 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
4140 4141 4142 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4140 def name @name end |
#options ⇒ String
Internal use only.
Corresponds to the JSON property options
4145 4146 4147 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4145 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. Initially only 4096 is supported, but other
powers of two may be added. If an unsupported value is requested, the error
message will list the supported values, but even a supported value may be
allowed for only some projects.
Corresponds to the JSON property physicalBlockSizeBytes
4154 4155 4156 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4154 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
4161 4162 4163 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4161 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
4167 4168 4169 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4167 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
4172 4173 4174 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4172 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
4177 4178 4179 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4177 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
4187 4188 4189 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4187 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-8 to use the
latest Debian 8 image:
projects/debian-cloud/global/images/family/debian-8
Alternatively, use a specific version of a public operating system image:
projects/debian-cloud/global/images/debian-8-jessie-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
4206 4207 4208 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4206 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
4211 4212 4213 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4211 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
4220 4221 4222 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4220 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
4231 4232 4233 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4231 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
4236 4237 4238 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4236 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
4245 4246 4247 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4245 def source_snapshot_id @source_snapshot_id end |
#status ⇒ String
[Output Only] The status of disk creation.
Corresponds to the JSON property status
4250 4251 4252 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4250 def status @status end |
#storage_type ⇒ String
[Deprecated] Storage type of the persistent disk.
Corresponds to the JSON property storageType
4255 4256 4257 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4255 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: project/zones/zone/
diskTypes/pd-standard or pd-ssd
Corresponds to the JSON property type
4262 4263 4264 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4262 def type @type end |
#users ⇒ Array<String>
[Output Only] Links to the users of the disk (attached instances) in form:
project/zones/zone/instances/instance
Corresponds to the JSON property users
4268 4269 4270 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4268 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
4275 4276 4277 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4275 def zone @zone end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 4282 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) @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 |