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

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

Constructor Details

#initialize(**args) ⇒ Disk

Returns a new instance of Disk.



5857
5858
5859
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5857

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

Returns:

  • (String) 


5559
5560
5561
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5559

def creation_timestamp
  @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

Returns:

  • (String) 


5565
5566
5567
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5565

def description
  @description
end

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

Returns:



5579
5580
5581
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5579

def disk_encryption_key
  @disk_encryption_key
end

#erase_windows_vss_signature ⇒ Boolean 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) 


5585
5586
5587
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5585

def erase_windows_vss_signature
  @erase_windows_vss_signature
end

#guest_os_features ⇒ Array<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

Returns:



5593
5594
5595
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5593

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

Returns:

  • (Fixnum) 


5599
5600
5601
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5599

def id
  @id
end

#interface ⇒ String

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) 


5605
5606
5607
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5605

def interface
  @interface
end

#kind ⇒ String

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

Returns:

  • (String) 


5610
5611
5612
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5610

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.

Returns:

  • (String) 


5622
5623
5624
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5622

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

Returns:

  • (Hash<String,String>) 


5628
5629
5630
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5628

def labels
  @labels
end

#last_attach_timestamp ⇒ String

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

Returns:

  • (String) 


5633
5634
5635
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5633

def last_attach_timestamp
  @last_attach_timestamp
end

#last_detach_timestamp ⇒ String

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

Returns:

  • (String) 


5638
5639
5640
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5638

def last_detach_timestamp
  @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

Returns:

  • (Array<Fixnum>) 


5643
5644
5645
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5643

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

Returns:

  • (Array<String>) 


5648
5649
5650
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5648

def licenses
  @licenses
end

#location_hint ⇒ 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

Returns:

  • (String) 


5654
5655
5656
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5654

def location_hint
  @location_hint
end

#multi_writer ⇒ Boolean 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) 


5660
5661
5662
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5660

def multi_writer
  @multi_writer
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

Returns:

  • (String) 


5671
5672
5673
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5671

def name
  @name
end

#options ⇒ String

Internal use only. Corresponds to the JSON property options

Returns:

  • (String) 


5676
5677
5678
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5676

def options
  @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. 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) 


5684
5685
5686
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5684

def physical_block_size_bytes
  @physical_block_size_bytes
end

#provisioned_iops ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5689
5690
5691
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5689

def provisioned_iops
  @provisioned_iops
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

Returns:

  • (String) 


5696
5697
5698
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5696

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

Returns:

  • (Array<String>) 


5702
5703
5704
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5702

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

Returns:

  • (Array<String>) 


5707
5708
5709
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5707

def resource_policies
  @resource_policies
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


5712
5713
5714
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5712

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

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

Returns:

  • (String) 


5718
5719
5720
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5718

def self_link
  @self_link
end

#size_gb ⇒ Fixnum

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) 


5727
5728
5729
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5727

def size_gb
  @size_gb
end

#source_disk ⇒ String

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) 


5741
5742
5743
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5741

def source_disk
  @source_disk
end

#source_disk_id ⇒ 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

Returns:

  • (String) 


5750
5751
5752
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5750

def source_disk_id
  @source_disk_id
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

Returns:

  • (String) 


5769
5770
5771
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5769

def source_image
  @source_image
end

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

Returns:



5775
5776
5777
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5775

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

Returns:

  • (String) 


5784
5785
5786
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5784

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:

Returns:

  • (String) 


5795
5796
5797
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5795

def source_snapshot
  @source_snapshot
end

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

Returns:



5801
5802
5803
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5801

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

Returns:

  • (String) 


5810
5811
5812
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5810

def source_snapshot_id
  @source_snapshot_id
end

#source_storage_object ⇒ 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

Returns:

  • (String) 


5820
5821
5822
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5820

def source_storage_object
  @source_storage_object
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

Returns:

  • (String) 


5830
5831
5832
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5830

def status
  @status
end

#storage_type ⇒ String

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

Returns:

  • (String) 


5835
5836
5837
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5835

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: projects/project/zones/ zone/diskTypes/pd-standard or pd-ssd Corresponds to the JSON property type

Returns:

  • (String) 


5842
5843
5844
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5842

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

Returns:

  • (Array<String>) 


5848
5849
5850
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5848

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

Returns:

  • (String) 


5855
5856
5857
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5855

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5862

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)
  @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)
  @users = args[:users] if args.key?(:users)
  @zone = args[:zone] if args.key?(:zone)
end