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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Disk

Returns a new instance of Disk.



6026
6027
6028
 
# File 'lib/google/apis/compute_beta/classes.rb', line 6026

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) 


5710
5711
5712
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5710

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) 


5716
5717
5718
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5716

def description
  @description
end

#disk_encryption_key ⇒ Google::Apis::ComputeBeta::CustomerEncryptionKey

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

Returns:



5734
5735
5736
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5734

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) 


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

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:



5748
5749
5750
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5748

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) 


5754
5755
5756
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5754

def id
  @id
end

#interface ⇒ String

[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

Returns:

  • (String) 


5760
5761
5762
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5760

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) 


5765
5766
5767
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5765

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) 


5777
5778
5779
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5777

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


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

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) 


5788
5789
5790
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5788

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) 


5793
5794
5795
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5793

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


5798
5799
5800
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5798

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


5803
5804
5805
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5803

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) 


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

def location_hint
  @location_hint
end

#locked ⇒ Boolean Also known as: locked?

[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

Returns:

  • (Boolean) 


5824
5825
5826
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5824

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


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

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) 


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

def name
  @name
end

#options ⇒ String

Internal use only. Corresponds to the JSON property options

Returns:

  • (String) 


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

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) 


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

def physical_block_size_bytes
  @physical_block_size_bytes
end

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

Returns:

  • (Fixnum) 


5862
5863
5864
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5862

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) 


5869
5870
5871
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5869

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


5875
5876
5877
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5875

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


5880
5881
5882
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5880

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) 


5885
5886
5887
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5885

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) 


5891
5892
5893
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5891

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) 


5900
5901
5902
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5900

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: - https: //www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - https://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

Returns:

  • (String) 


5910
5911
5912
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5910

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) 


5919
5920
5921
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5919

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) 


5934
5935
5936
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5934

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:



5940
5941
5942
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5940

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) 


5949
5950
5951
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5949

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

Returns:

  • (String) 


5958
5959
5960
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5958

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:



5964
5965
5966
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5964

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) 


5973
5974
5975
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5973

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) 


5983
5984
5985
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5983

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) 


5990
5991
5992
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5990

def status
  @status
end

#storage_type ⇒ String

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

Returns:

  • (String) 


5995
5996
5997
 
# File 'lib/google/apis/compute_beta/classes.rb', line 5995

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-ssd . See Persistent disk types. Corresponds to the JSON property type

Returns:

  • (String) 


6002
6003
6004
 
# File 'lib/google/apis/compute_beta/classes.rb', line 6002

def type
  @type
end

#user_licenses ⇒ Array<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>) 


6011
6012
6013
 
# File 'lib/google/apis/compute_beta/classes.rb', line 6011

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


6017
6018
6019
 
# File 'lib/google/apis/compute_beta/classes.rb', line 6017

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) 


6024
6025
6026
 
# File 'lib/google/apis/compute_beta/classes.rb', line 6024

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
 
# File 'lib/google/apis/compute_beta/classes.rb', line 6031

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