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

A Disk resource.

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



4182
4183
4184
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4182

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) 


3973
3974
3975
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3973

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) 


3979
3980
3981
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3979

def description
  @description
end

#disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



3984
3985
3986
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3984

def disk_encryption_key
  @disk_encryption_key
end

#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>

A list of features to enable on the guest OS. Applicable for bootable disks only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows disks, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0. 1621 or higher. Linux disks with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. For newer Windows images, the server might also populate this property with the value WINDOWS to indicate that this is a Windows image. Corresponds to the JSON property guestOsFeatures

Returns:



3996
3997
3998
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 3996

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) 


4002
4003
4004
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4002

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) 


4007
4008
4009
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4007

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


4018
4019
4020
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4018

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


4024
4025
4026
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4024

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) 


4029
4030
4031
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4029

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) 


4034
4035
4036
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4034

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


4039
4040
4041
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4039

def license_codes
  @license_codes
end

#licenses ⇒ Array<String>

Any applicable publicly visible licenses. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


4044
4045
4046
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4044

def licenses
  @licenses
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? 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) 


4054
4055
4056
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4054

def name
  @name
end

#options ⇒ String

Internal use only. Corresponds to the JSON property options

Returns:

  • (String) 


4059
4060
4061
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4059

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. Initially only 4096 is supported, but other powers of two may be added. If an unsupported value is requested, the error message will list the supported values, but even a supported value may be allowed for only some projects. Corresponds to the JSON property physicalBlockSizeBytes

Returns:

  • (Fixnum) 


4068
4069
4070
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4068

def physical_block_size_bytes
  @physical_block_size_bytes
end

#region ⇒ String

[Output Only] URL of the region where the disk resides. Only applicable for regional resources. Corresponds to the JSON property region

Returns:

  • (String) 


4074
4075
4076
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4074

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


4080
4081
4082
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4080

def replica_zones
  @replica_zones
end

#self_link ⇒ String

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

Returns:

  • (String) 


4085
4086
4087
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4085

def self_link
  @self_link
end

#size_gb ⇒ Fixnum

Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk. If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot. Acceptable values are 1 to 65536, inclusive. Corresponds to the JSON property sizeGb

Returns:

  • (Fixnum) 


4095
4096
4097
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4095

def size_gb
  @size_gb
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-8 to use the latest Debian 8 image: projects/debian-cloud/global/images/family/debian-8 Alternatively, use a specific version of a public operating system image: projects/debian-cloud/global/images/debian-8-jessie-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) 


4114
4115
4116
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4114

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



4119
4120
4121
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4119

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) 


4128
4129
4130
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4128

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) 


4139
4140
4141
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4139

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey

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

Returns:



4144
4145
4146
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4144

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) 


4153
4154
4155
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4153

def source_snapshot_id
  @source_snapshot_id
end

#status ⇒ String

[Output Only] The status of disk creation. Corresponds to the JSON property status

Returns:

  • (String) 


4158
4159
4160
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4158

def status
  @status
end

#storage_type ⇒ String

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

Returns:

  • (String) 


4163
4164
4165
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4163

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. Corresponds to the JSON property type

Returns:

  • (String) 


4169
4170
4171
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4169

def type
  @type
end

#users ⇒ Array<String>

[Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance Corresponds to the JSON property users

Returns:

  • (Array<String>) 


4175
4176
4177
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4175

def users
  @users
end

#zone ⇒ String

[Output Only] URL of the zone where the disk resides. Corresponds to the JSON property zone

Returns:

  • (String) 


4180
4181
4182
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4180

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 4187

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