Class: Google::Apis::ComputeAlpha::Disk

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
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:

  • Zonal * 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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Disk

Returns a new instance of Disk.



6320
6321
6322
# File 'generated/google/apis/compute_alpha/classes.rb', line 6320

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


5982
5983
5984
# File 'generated/google/apis/compute_alpha/classes.rb', line 5982

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


5988
5989
5990
# File 'generated/google/apis/compute_alpha/classes.rb', line 5988

def description
  @description
end

#disk_encryption_keyGoogle::Apis::ComputeAlpha::CustomerEncryptionKey

Encrypts the disk using a customer-supplied encryption key. After you encrypt a disk with a customer-supplied key, you must provide the same key if you use the disk later (e.g. to create a disk snapshot, to create a disk image, to create a machine image, or to attach the disk to a virtual machine). Customer-supplied encryption keys do not protect access to metadata of the disk. If you do not provide an encryption key when creating the disk, then the disk will be encrypted using an automatically generated key and you do not need to provide a key to use the disk later. Corresponds to the JSON property diskEncryptionKey



6002
6003
6004
# File 'generated/google/apis/compute_alpha/classes.rb', line 6002

def disk_encryption_key
  @disk_encryption_key
end

#erase_windows_vss_signatureBoolean 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

Returns:

  • (Boolean)


6008
6009
6010
# File 'generated/google/apis/compute_alpha/classes.rb', line 6008

def erase_windows_vss_signature
  @erase_windows_vss_signature
end

#guest_os_featuresArray<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



6016
6017
6018
# File 'generated/google/apis/compute_alpha/classes.rb', line 6016

def guest_os_features
  @guest_os_features
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


6022
6023
6024
# File 'generated/google/apis/compute_alpha/classes.rb', line 6022

def id
  @id
end

#interfaceString

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

Returns:

  • (String)


6028
6029
6030
# File 'generated/google/apis/compute_alpha/classes.rb', line 6028

def interface
  @interface
end

#kindString

[Output Only] Type of the resource. Always compute#disk for disks. Corresponds to the JSON property kind

Returns:

  • (String)


6033
6034
6035
# File 'generated/google/apis/compute_alpha/classes.rb', line 6033

def kind
  @kind
end

#label_fingerprintString

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.

Returns:

  • (String)


6045
6046
6047
# File 'generated/google/apis/compute_alpha/classes.rb', line 6045

def label_fingerprint
  @label_fingerprint
end

#labelsHash<String,String>

Labels to apply to this disk. These can be later modified by the setLabels method. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


6051
6052
6053
# File 'generated/google/apis/compute_alpha/classes.rb', line 6051

def labels
  @labels
end

#last_attach_timestampString

[Output Only] Last attach timestamp in RFC3339 text format. Corresponds to the JSON property lastAttachTimestamp

Returns:

  • (String)


6056
6057
6058
# File 'generated/google/apis/compute_alpha/classes.rb', line 6056

def last_attach_timestamp
  @last_attach_timestamp
end

#last_detach_timestampString

[Output Only] Last detach timestamp in RFC3339 text format. Corresponds to the JSON property lastDetachTimestamp

Returns:

  • (String)


6061
6062
6063
# File 'generated/google/apis/compute_alpha/classes.rb', line 6061

def last_detach_timestamp
  @last_detach_timestamp
end

#license_codesArray<Fixnum>

Integer license codes indicating which licenses are attached to this disk. Corresponds to the JSON property licenseCodes

Returns:

  • (Array<Fixnum>)


6066
6067
6068
# File 'generated/google/apis/compute_alpha/classes.rb', line 6066

def license_codes
  @license_codes
end

#licensesArray<String>

A list of publicly visible licenses. Reserved for Google's use. Corresponds to the JSON property licenses

Returns:

  • (Array<String>)


6071
6072
6073
# File 'generated/google/apis/compute_alpha/classes.rb', line 6071

def licenses
  @licenses
end

#multi_writerBoolean 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

Returns:

  • (Boolean)


6077
6078
6079
# File 'generated/google/apis/compute_alpha/classes.rb', line 6077

def multi_writer
  @multi_writer
end

#nameString

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

Returns:

  • (String)


6088
6089
6090
# File 'generated/google/apis/compute_alpha/classes.rb', line 6088

def name
  @name
end

#optionsString

Internal use only. Corresponds to the JSON property options

Returns:

  • (String)


6093
6094
6095
# File 'generated/google/apis/compute_alpha/classes.rb', line 6093

def options
  @options
end

#physical_block_size_bytesFixnum

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

Returns:

  • (Fixnum)


6101
6102
6103
# File 'generated/google/apis/compute_alpha/classes.rb', line 6101

def physical_block_size_bytes
  @physical_block_size_bytes
end

#provisioned_iopsFixnum

Indicates how many IOPS must be provisioned for the disk. Corresponds to the JSON property provisionedIops

Returns:

  • (Fixnum)


6106
6107
6108
# File 'generated/google/apis/compute_alpha/classes.rb', line 6106

def provisioned_iops
  @provisioned_iops
end

#regionString

[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

Returns:

  • (String)


6113
6114
6115
# File 'generated/google/apis/compute_alpha/classes.rb', line 6113

def region
  @region
end

#replica_zonesArray<String>

URLs of the zones where the disk should be replicated to. Only applicable for regional resources. Corresponds to the JSON property replicaZones

Returns:

  • (Array<String>)


6119
6120
6121
# File 'generated/google/apis/compute_alpha/classes.rb', line 6119

def replica_zones
  @replica_zones
end

#resource_policiesArray<String>

Resource policies applied to this disk for automatic snapshot creations. Corresponds to the JSON property resourcePolicies

Returns:

  • (Array<String>)


6124
6125
6126
# File 'generated/google/apis/compute_alpha/classes.rb', line 6124

def resource_policies
  @resource_policies
end

#satisfies_pzsBoolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean)


6129
6130
6131
# File 'generated/google/apis/compute_alpha/classes.rb', line 6129

def satisfies_pzs
  @satisfies_pzs
end

[Output Only] Server-defined fully-qualified URL for this resource. Corresponds to the JSON property selfLink

Returns:

  • (String)


6135
6136
6137
# File 'generated/google/apis/compute_alpha/classes.rb', line 6135

def self_link
  @self_link
end

[Output Only] Server-defined URL for this resource's resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String)


6140
6141
6142
# File 'generated/google/apis/compute_alpha/classes.rb', line 6140

def self_link_with_id
  @self_link_with_id
end

#size_gbFixnum

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

Returns:

  • (Fixnum)


6149
6150
6151
# File 'generated/google/apis/compute_alpha/classes.rb', line 6149

def size_gb
  @size_gb
end

#source_diskString

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:

Returns:

  • (String)


6158
6159
6160
# File 'generated/google/apis/compute_alpha/classes.rb', line 6158

def source_disk
  @source_disk
end

#source_disk_idString

[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

Returns:

  • (String)


6167
6168
6169
# File 'generated/google/apis/compute_alpha/classes.rb', line 6167

def source_disk_id
  @source_disk_id
end

#source_imageString

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

Returns:

  • (String)


6186
6187
6188
# File 'generated/google/apis/compute_alpha/classes.rb', line 6186

def source_image
  @source_image
end

#source_image_encryption_keyGoogle::Apis::ComputeAlpha::CustomerEncryptionKey

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



6192
6193
6194
# File 'generated/google/apis/compute_alpha/classes.rb', line 6192

def source_image_encryption_key
  @source_image_encryption_key
end

#source_image_idString

[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

Returns:

  • (String)


6201
6202
6203
# File 'generated/google/apis/compute_alpha/classes.rb', line 6201

def source_image_id
  @source_image_id
end

#source_in_place_snapshotString

[Deprecated] The source in-place 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:

Returns:

  • (String)


6212
6213
6214
# File 'generated/google/apis/compute_alpha/classes.rb', line 6212

def source_in_place_snapshot
  @source_in_place_snapshot
end

#source_in_place_snapshot_idString

[Deprecated] [Output Only] The unique ID of the in-place snapshot used to create this disk. This value identifies the exact in-place snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an in-place snapshot that was later deleted and recreated under the same name, the source in-place snapshot ID would identify the exact version of the in-place snapshot that was used. Corresponds to the JSON property sourceInPlaceSnapshotId

Returns:

  • (String)


6222
6223
6224
# File 'generated/google/apis/compute_alpha/classes.rb', line 6222

def source_in_place_snapshot_id
  @source_in_place_snapshot_id
end

#source_instant_snapshotString

The source instant 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:

Returns:

  • (String)


6233
6234
6235
# File 'generated/google/apis/compute_alpha/classes.rb', line 6233

def source_instant_snapshot
  @source_instant_snapshot
end

#source_instant_snapshot_idString

[Output Only] The unique ID of the instant snapshot used to create this disk. This value identifies the exact instant snapshot that was used to create this persistent disk. For example, if you created the persistent disk from an instant snapshot that was later deleted and recreated under the same name, the source instant snapshot ID would identify the exact version of the instant snapshot that was used. Corresponds to the JSON property sourceInstantSnapshotId

Returns:

  • (String)


6243
6244
6245
# File 'generated/google/apis/compute_alpha/classes.rb', line 6243

def source_instant_snapshot_id
  @source_instant_snapshot_id
end

#source_snapshotString

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:

Returns:

  • (String)


6254
6255
6256
# File 'generated/google/apis/compute_alpha/classes.rb', line 6254

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_keyGoogle::Apis::ComputeAlpha::CustomerEncryptionKey

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



6260
6261
6262
# File 'generated/google/apis/compute_alpha/classes.rb', line 6260

def source_snapshot_encryption_key
  @source_snapshot_encryption_key
end

#source_snapshot_idString

[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

Returns:

  • (String)


6269
6270
6271
# File 'generated/google/apis/compute_alpha/classes.rb', line 6269

def source_snapshot_id
  @source_snapshot_id
end

#source_storage_objectString

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

Returns:

  • (String)


6277
6278
6279
# File 'generated/google/apis/compute_alpha/classes.rb', line 6277

def source_storage_object
  @source_storage_object
end

#statusString

[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

Returns:

  • (String)


6284
6285
6286
# File 'generated/google/apis/compute_alpha/classes.rb', line 6284

def status
  @status
end

#storage_typeString

[Deprecated] Storage type of the persistent disk. Corresponds to the JSON property storageType

Returns:

  • (String)


6289
6290
6291
# File 'generated/google/apis/compute_alpha/classes.rb', line 6289

def storage_type
  @storage_type
end

#typeString

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

Returns:

  • (String)


6296
6297
6298
# File 'generated/google/apis/compute_alpha/classes.rb', line 6296

def type
  @type
end

#user_licensesArray<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: https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/ debian-9-stretch Corresponds to the JSON property userLicenses

Returns:

  • (Array<String>)


6305
6306
6307
# File 'generated/google/apis/compute_alpha/classes.rb', line 6305

def user_licenses
  @user_licenses
end

#usersArray<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

Returns:

  • (Array<String>)


6311
6312
6313
# File 'generated/google/apis/compute_alpha/classes.rb', line 6311

def users
  @users
end

#zoneString

[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

Returns:

  • (String)


6318
6319
6320
# File 'generated/google/apis/compute_alpha/classes.rb', line 6318

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
# File 'generated/google/apis/compute_alpha/classes.rb', line 6325

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)
  @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)
  @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_in_place_snapshot = args[:source_in_place_snapshot] if args.key?(:source_in_place_snapshot)
  @source_in_place_snapshot_id = args[:source_in_place_snapshot_id] if args.key?(:source_in_place_snapshot_id)
  @source_instant_snapshot = args[:source_instant_snapshot] if args.key?(:source_instant_snapshot)
  @source_instant_snapshot_id = args[:source_instant_snapshot_id] if args.key?(:source_instant_snapshot_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