Class: Google::Apis::ComputeBeta::Disk

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_beta/classes.rb,
generated/google/apis/compute_beta/representations.rb,
generated/google/apis/compute_beta/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Disk

Returns a new instance of Disk.


5373
5374
5375
# File 'generated/google/apis/compute_beta/classes.rb', line 5373

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)

5121
5122
5123
# File 'generated/google/apis/compute_beta/classes.rb', line 5121

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)

5127
5128
5129
# File 'generated/google/apis/compute_beta/classes.rb', line 5127

def description
  @description
end

#disk_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property diskEncryptionKey


5132
5133
5134
# File 'generated/google/apis/compute_beta/classes.rb', line 5132

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)

5138
5139
5140
# File 'generated/google/apis/compute_beta/classes.rb', line 5138

def erase_windows_vss_signature
  @erase_windows_vss_signature
end

#guest_os_featuresArray<Google::Apis::ComputeBeta::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


5146
5147
5148
# File 'generated/google/apis/compute_beta/classes.rb', line 5146

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)

5152
5153
5154
# File 'generated/google/apis/compute_beta/classes.rb', line 5152

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)

5158
5159
5160
# File 'generated/google/apis/compute_beta/classes.rb', line 5158

def interface
  @interface
end

#kindString

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

Returns:

  • (String)

5163
5164
5165
# File 'generated/google/apis/compute_beta/classes.rb', line 5163

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)

5175
5176
5177
# File 'generated/google/apis/compute_beta/classes.rb', line 5175

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>)

5181
5182
5183
# File 'generated/google/apis/compute_beta/classes.rb', line 5181

def labels
  @labels
end

#last_attach_timestampString

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

Returns:

  • (String)

5186
5187
5188
# File 'generated/google/apis/compute_beta/classes.rb', line 5186

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)

5191
5192
5193
# File 'generated/google/apis/compute_beta/classes.rb', line 5191

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>)

5196
5197
5198
# File 'generated/google/apis/compute_beta/classes.rb', line 5196

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>)

5201
5202
5203
# File 'generated/google/apis/compute_beta/classes.rb', line 5201

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)

5207
5208
5209
# File 'generated/google/apis/compute_beta/classes.rb', line 5207

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)

5218
5219
5220
# File 'generated/google/apis/compute_beta/classes.rb', line 5218

def name
  @name
end

#optionsString

Internal use only. Corresponds to the JSON property options

Returns:

  • (String)

5223
5224
5225
# File 'generated/google/apis/compute_beta/classes.rb', line 5223

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)

5231
5232
5233
# File 'generated/google/apis/compute_beta/classes.rb', line 5231

def physical_block_size_bytes
  @physical_block_size_bytes
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)

5238
5239
5240
# File 'generated/google/apis/compute_beta/classes.rb', line 5238

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>)

5244
5245
5246
# File 'generated/google/apis/compute_beta/classes.rb', line 5244

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>)

5249
5250
5251
# File 'generated/google/apis/compute_beta/classes.rb', line 5249

def resource_policies
  @resource_policies
end

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

Returns:

  • (String)

5254
5255
5256
# File 'generated/google/apis/compute_beta/classes.rb', line 5254

def self_link
  @self_link
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)

5263
5264
5265
# File 'generated/google/apis/compute_beta/classes.rb', line 5263

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)

5272
5273
5274
# File 'generated/google/apis/compute_beta/classes.rb', line 5272

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)

5281
5282
5283
# File 'generated/google/apis/compute_beta/classes.rb', line 5281

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)

5300
5301
5302
# File 'generated/google/apis/compute_beta/classes.rb', line 5300

def source_image
  @source_image
end

#source_image_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property sourceImageEncryptionKey


5305
5306
5307
# File 'generated/google/apis/compute_beta/classes.rb', line 5305

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)

5314
5315
5316
# File 'generated/google/apis/compute_beta/classes.rb', line 5314

def source_image_id
  @source_image_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)

5325
5326
5327
# File 'generated/google/apis/compute_beta/classes.rb', line 5325

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

Represents a customer-supplied encryption key Corresponds to the JSON property sourceSnapshotEncryptionKey


5330
5331
5332
# File 'generated/google/apis/compute_beta/classes.rb', line 5330

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)

5339
5340
5341
# File 'generated/google/apis/compute_beta/classes.rb', line 5339

def source_snapshot_id
  @source_snapshot_id
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)

5346
5347
5348
# File 'generated/google/apis/compute_beta/classes.rb', line 5346

def status
  @status
end

#storage_typeString

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

Returns:

  • (String)

5351
5352
5353
# File 'generated/google/apis/compute_beta/classes.rb', line 5351

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)

5358
5359
5360
# File 'generated/google/apis/compute_beta/classes.rb', line 5358

def type
  @type
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>)

5364
5365
5366
# File 'generated/google/apis/compute_beta/classes.rb', line 5364

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)

5371
5372
5373
# File 'generated/google/apis/compute_beta/classes.rb', line 5371

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
# File 'generated/google/apis/compute_beta/classes.rb', line 5378

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)
  @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_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)
  @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