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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/representations.rb

Overview

A Disk resource. (== resource_for beta.disks ==) (== resource_for v1.disks ==)

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



3457
3458
3459
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3457

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) 


3291
3292
3293
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3291

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) 


3297
3298
3299
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3297

def description
  @description
end

#disk_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

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

Returns:



3302
3303
3304
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3302

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


3308
3309
3310
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3308

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) 


3313
3314
3315
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3313

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) 


3324
3325
3326
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3324

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


3330
3331
3332
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3330

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) 


3335
3336
3337
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3335

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) 


3340
3341
3342
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3340

def last_detach_timestamp
  @last_detach_timestamp
end

#licenses ⇒ Array<String>

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

Returns:

  • (Array<String>) 


3345
3346
3347
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3345

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) 


3355
3356
3357
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3355

def name
  @name
end

#options ⇒ String

Internal use only. Corresponds to the JSON property options

Returns:

  • (String) 


3360
3361
3362
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3360

def options
  @options
end

#self_link ⇒ String

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

Returns:

  • (String) 


3365
3366
3367
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3365

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) 


3375
3376
3377
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3375

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) 


3394
3395
3396
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3394

def source_image
  @source_image
end

#source_image_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

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

Returns:



3399
3400
3401
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3399

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) 


3408
3409
3410
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3408

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) 


3419
3420
3421
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3419

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

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

Returns:



3424
3425
3426
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3424

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) 


3433
3434
3435
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3433

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) 


3438
3439
3440
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3438

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

Returns:

  • (String) 


3444
3445
3446
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3444

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


3450
3451
3452
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3450

def users
  @users
end

#zone ⇒ String

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

Returns:

  • (String) 


3455
3456
3457
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3455

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3462

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