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

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



2487
2488
2489
# File 'generated/google/apis/compute_beta/classes.rb', line 2487

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

Instance Attribute Details

#creation_timestampString

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

Returns:

  • (String)


2316
2317
2318
# File 'generated/google/apis/compute_beta/classes.rb', line 2316

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


2322
2323
2324
# File 'generated/google/apis/compute_beta/classes.rb', line 2322

def description
  @description
end

#disk_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

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



2327
2328
2329
# File 'generated/google/apis/compute_beta/classes.rb', line 2327

def disk_encryption_key
  @disk_encryption_key
end

#idString

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (String)


2333
2334
2335
# File 'generated/google/apis/compute_beta/classes.rb', line 2333

def id
  @id
end

#kindString

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

Returns:

  • (String)


2338
2339
2340
# File 'generated/google/apis/compute_beta/classes.rb', line 2338

def kind
  @kind
end

#label_fingerprintString

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

Returns:

  • (String)


2348
2349
2350
# File 'generated/google/apis/compute_beta/classes.rb', line 2348

def label_fingerprint
  @label_fingerprint
end

#labelsHash<String,String>

Labels to apply to this disk. These can be later modified by the setLabels method. Each label key/value pair must comply with RFC1035. Label values may be empty. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>)


2355
2356
2357
# File 'generated/google/apis/compute_beta/classes.rb', line 2355

def labels
  @labels
end

#last_attach_timestampString

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

Returns:

  • (String)


2360
2361
2362
# File 'generated/google/apis/compute_beta/classes.rb', line 2360

def last_attach_timestamp
  @last_attach_timestamp
end

#last_detach_timestampString

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

Returns:

  • (String)


2365
2366
2367
# File 'generated/google/apis/compute_beta/classes.rb', line 2365

def last_detach_timestamp
  @last_detach_timestamp
end

#licensesArray<String>

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

Returns:

  • (Array<String>)


2370
2371
2372
# File 'generated/google/apis/compute_beta/classes.rb', line 2370

def licenses
  @licenses
end

#nameString

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)


2380
2381
2382
# File 'generated/google/apis/compute_beta/classes.rb', line 2380

def name
  @name
end

#optionsString

Internal use only. Corresponds to the JSON property options

Returns:

  • (String)


2385
2386
2387
# File 'generated/google/apis/compute_beta/classes.rb', line 2385

def options
  @options
end

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

Returns:

  • (String)


2390
2391
2392
# File 'generated/google/apis/compute_beta/classes.rb', line 2390

def self_link
  @self_link
end

#size_gbString

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

Returns:

  • (String)


2400
2401
2402
# File 'generated/google/apis/compute_beta/classes.rb', line 2400

def size_gb
  @size_gb
end

#source_imageString

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 private image that you created, specify the image name in the following format: global/images/my-private-image You can also specify a private 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-private-family Corresponds to the JSON property sourceImage

Returns:

  • (String)


2419
2420
2421
# File 'generated/google/apis/compute_beta/classes.rb', line 2419

def source_image
  @source_image
end

#source_image_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

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



2424
2425
2426
# File 'generated/google/apis/compute_beta/classes.rb', line 2424

def source_image_encryption_key
  @source_image_encryption_key
end

#source_image_idString

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


2433
2434
2435
# File 'generated/google/apis/compute_beta/classes.rb', line 2433

def source_image_id
  @source_image_id
end

#source_snapshotString

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)


2444
2445
2446
# File 'generated/google/apis/compute_beta/classes.rb', line 2444

def source_snapshot
  @source_snapshot
end

#source_snapshot_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

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



2449
2450
2451
# File 'generated/google/apis/compute_beta/classes.rb', line 2449

def source_snapshot_encryption_key
  @source_snapshot_encryption_key
end

#source_snapshot_idString

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


2458
2459
2460
# File 'generated/google/apis/compute_beta/classes.rb', line 2458

def source_snapshot_id
  @source_snapshot_id
end

#statusString

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

Returns:

  • (String)


2463
2464
2465
# File 'generated/google/apis/compute_beta/classes.rb', line 2463

def status
  @status
end

#storage_typeString

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

Returns:

  • (String)


2468
2469
2470
# File 'generated/google/apis/compute_beta/classes.rb', line 2468

def storage_type
  @storage_type
end

#typeString

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)


2474
2475
2476
# File 'generated/google/apis/compute_beta/classes.rb', line 2474

def type
  @type
end

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


2480
2481
2482
# File 'generated/google/apis/compute_beta/classes.rb', line 2480

def users
  @users
end

#zoneString

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

Returns:

  • (String)


2485
2486
2487
# File 'generated/google/apis/compute_beta/classes.rb', line 2485

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
# File 'generated/google/apis/compute_beta/classes.rb', line 2492

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