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



3755
3756
3757
# File 'generated/google/apis/compute_beta/classes.rb', line 3755

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)


3579
3580
3581
# File 'generated/google/apis/compute_beta/classes.rb', line 3579

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)


3585
3586
3587
# File 'generated/google/apis/compute_beta/classes.rb', line 3585

def description
  @description
end

#disk_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

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



3590
3591
3592
# File 'generated/google/apis/compute_beta/classes.rb', line 3590

def disk_encryption_key
  @disk_encryption_key
end

#idFixnum

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

Returns:

  • (Fixnum)


3596
3597
3598
# File 'generated/google/apis/compute_beta/classes.rb', line 3596

def id
  @id
end

#kindString

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

Returns:

  • (String)


3601
3602
3603
# File 'generated/google/apis/compute_beta/classes.rb', line 3601

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 NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String)


3612
3613
3614
# File 'generated/google/apis/compute_beta/classes.rb', line 3612

def label_fingerprint
  @label_fingerprint
end

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


3618
3619
3620
# File 'generated/google/apis/compute_beta/classes.rb', line 3618

def labels
  @labels
end

#last_attach_timestampString

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

Returns:

  • (String)


3623
3624
3625
# File 'generated/google/apis/compute_beta/classes.rb', line 3623

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)


3628
3629
3630
# File 'generated/google/apis/compute_beta/classes.rb', line 3628

def last_detach_timestamp
  @last_detach_timestamp
end

#license_codesArray<Fixnum>

Integer license codes indicating which licenses are attached to this disk. Corresponds to the JSON property licenseCodes

Returns:

  • (Array<Fixnum>)


3633
3634
3635
# File 'generated/google/apis/compute_beta/classes.rb', line 3633

def license_codes
  @license_codes
end

#licensesArray<String>

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

Returns:

  • (Array<String>)


3638
3639
3640
# File 'generated/google/apis/compute_beta/classes.rb', line 3638

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)


3648
3649
3650
# File 'generated/google/apis/compute_beta/classes.rb', line 3648

def name
  @name
end

#optionsString

Internal use only. Corresponds to the JSON property options

Returns:

  • (String)


3653
3654
3655
# File 'generated/google/apis/compute_beta/classes.rb', line 3653

def options
  @options
end

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

Returns:

  • (String)


3658
3659
3660
# File 'generated/google/apis/compute_beta/classes.rb', line 3658

def self_link
  @self_link
end

#size_gbFixnum

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)


3668
3669
3670
# File 'generated/google/apis/compute_beta/classes.rb', line 3668

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


3687
3688
3689
# File 'generated/google/apis/compute_beta/classes.rb', line 3687

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



3692
3693
3694
# File 'generated/google/apis/compute_beta/classes.rb', line 3692

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)


3701
3702
3703
# File 'generated/google/apis/compute_beta/classes.rb', line 3701

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)


3712
3713
3714
# File 'generated/google/apis/compute_beta/classes.rb', line 3712

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



3717
3718
3719
# File 'generated/google/apis/compute_beta/classes.rb', line 3717

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)


3726
3727
3728
# File 'generated/google/apis/compute_beta/classes.rb', line 3726

def source_snapshot_id
  @source_snapshot_id
end

#statusString

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

Returns:

  • (String)


3731
3732
3733
# File 'generated/google/apis/compute_beta/classes.rb', line 3731

def status
  @status
end

#storage_typeString

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

Returns:

  • (String)


3736
3737
3738
# File 'generated/google/apis/compute_beta/classes.rb', line 3736

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)


3742
3743
3744
# File 'generated/google/apis/compute_beta/classes.rb', line 3742

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


3748
3749
3750
# File 'generated/google/apis/compute_beta/classes.rb', line 3748

def users
  @users
end

#zoneString

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

Returns:

  • (String)


3753
3754
3755
# File 'generated/google/apis/compute_beta/classes.rb', line 3753

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
# File 'generated/google/apis/compute_beta/classes.rb', line 3760

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