Class: Google::Apis::ComputeV1::Disk

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



6230
6231
6232
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6230

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

Instance Attribute Details

#architecture ⇒ String

The architecture of the disk. Valid values are ARM64 or X86_64. Corresponds to the JSON property architecture

Returns:

  • (String) 


5920
5921
5922
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5920

def architecture
  @architecture
end

#async_primary_disk ⇒ Google::Apis::ComputeV1::DiskAsyncReplication

Disk asynchronously replicated into this disk. Corresponds to the JSON property asyncPrimaryDisk

Returns:



5925
5926
5927
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5925

def async_primary_disk
  @async_primary_disk
end

#async_secondary_disks ⇒ Hash<String,Google::Apis::ComputeV1::DiskAsyncReplicationList>

[Output Only] A list of disks this disk is asynchronously replicated to. Corresponds to the JSON property asyncSecondaryDisks

Returns:



5930
5931
5932
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5930

def async_secondary_disks
  @async_secondary_disks
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


5935
5936
5937
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5935

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) 


5941
5942
5943
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5941

def description
  @description
end

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



5959
5960
5961
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5959

def disk_encryption_key
  @disk_encryption_key
end

#guest_os_features ⇒ Array<Google::Apis::ComputeV1::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:



5966
5967
5968
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5966

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) 


5972
5973
5974
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5972

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


5977
5978
5979
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5977

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) 


5989
5990
5991
 
# File 'lib/google/apis/compute_v1/classes.rb', line 5989

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


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

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) 


6000
6001
6002
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6000

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) 


6005
6006
6007
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6005

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


6010
6011
6012
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6010

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


6015
6016
6017
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6015

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) 


6021
6022
6023
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6021

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


6031
6032
6033
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6031

def name
  @name
end

#options ⇒ String

Internal use only. Corresponds to the JSON property options

Returns:

  • (String) 


6036
6037
6038
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6036

def options
  @options
end

#params ⇒ Google::Apis::ComputeV1::DiskParams

Additional disk params. Corresponds to the JSON property params

Returns:



6041
6042
6043
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6041

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


6049
6050
6051
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6049

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) 


6056
6057
6058
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6056

def provisioned_iops
  @provisioned_iops
end

#provisioned_throughput ⇒ Fixnum

Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 7,124. Corresponds to the JSON property provisionedThroughput

Returns:

  • (Fixnum) 


6063
6064
6065
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6063

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


6070
6071
6072
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6070

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


6076
6077
6078
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6076

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


6081
6082
6083
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6081

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeV1::DiskResourceStatus

[Output Only] Status information for the disk resource. Corresponds to the JSON property resourceStatus

Returns:



6086
6087
6088
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6086

def resource_status
  @resource_status
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


6091
6092
6093
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6091

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) 


6097
6098
6099
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6097

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) 


6106
6107
6108
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6106

def size_gb
  @size_gb
end

#source_consistency_group_policy ⇒ String

[Output Only] URL of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. Corresponds to the JSON property sourceConsistencyGroupPolicy

Returns:

  • (String) 


6112
6113
6114
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6112

def source_consistency_group_policy
  @source_consistency_group_policy
end

#source_consistency_group_policy_id ⇒ String

[Output Only] ID of the DiskConsistencyGroupPolicy for a secondary disk that was created using a consistency group. Corresponds to the JSON property sourceConsistencyGroupPolicyId

Returns:

  • (String) 


6118
6119
6120
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6118

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


6128
6129
6130
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6128

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) 


6137
6138
6139
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6137

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) 


6152
6153
6154
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6152

def source_image
  @source_image
end

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



6158
6159
6160
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6158

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) 


6167
6168
6169
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6167

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) 


6176
6177
6178
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6176

def source_snapshot
  @source_snapshot
end

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



6182
6183
6184
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6182

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) 


6191
6192
6193
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6191

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) 


6201
6202
6203
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6201

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) 


6208
6209
6210
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6208

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


6215
6216
6217
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6215

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


6221
6222
6223
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6221

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) 


6228
6229
6230
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6228

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
 
# File 'lib/google/apis/compute_v1/classes.rb', line 6235

def update!(**args)
  @architecture = args[:architecture] if args.key?(:architecture)
  @async_primary_disk = args[:async_primary_disk] if args.key?(:async_primary_disk)
  @async_secondary_disks = args[:async_secondary_disks] if args.key?(:async_secondary_disks)
  @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)
  @location_hint = args[:location_hint] if args.key?(:location_hint)
  @name = args[:name] if args.key?(:name)
  @options = args[:options] if args.key?(:options)
  @params = args[:params] if args.key?(:params)
  @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)
  @provisioned_throughput = args[:provisioned_throughput] if args.key?(:provisioned_throughput)
  @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)
  @resource_status = args[:resource_status] if args.key?(:resource_status)
  @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_consistency_group_policy = args[:source_consistency_group_policy] if args.key?(:source_consistency_group_policy)
  @source_consistency_group_policy_id = args[:source_consistency_group_policy_id] if args.key?(:source_consistency_group_policy_id)
  @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)
  @type = args[:type] if args.key?(:type)
  @users = args[:users] if args.key?(:users)
  @zone = args[:zone] if args.key?(:zone)
end