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.



1797
1798
1799
# File 'generated/google/apis/compute_beta/classes.rb', line 1797

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)


1626
1627
1628
# File 'generated/google/apis/compute_beta/classes.rb', line 1626

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)


1632
1633
1634
# File 'generated/google/apis/compute_beta/classes.rb', line 1632

def description
  @description
end

#disk_encryption_keyGoogle::Apis::ComputeBeta::CustomerEncryptionKey

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



1637
1638
1639
# File 'generated/google/apis/compute_beta/classes.rb', line 1637

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)


1643
1644
1645
# File 'generated/google/apis/compute_beta/classes.rb', line 1643

def id
  @id
end

#kindString

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

Returns:

  • (String)


1648
1649
1650
# File 'generated/google/apis/compute_beta/classes.rb', line 1648

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)


1658
1659
1660
# File 'generated/google/apis/compute_beta/classes.rb', line 1658

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


1665
1666
1667
# File 'generated/google/apis/compute_beta/classes.rb', line 1665

def labels
  @labels
end

#last_attach_timestampString

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

Returns:

  • (String)


1670
1671
1672
# File 'generated/google/apis/compute_beta/classes.rb', line 1670

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)


1675
1676
1677
# File 'generated/google/apis/compute_beta/classes.rb', line 1675

def last_detach_timestamp
  @last_detach_timestamp
end

#licensesArray<String>

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

Returns:

  • (Array<String>)


1680
1681
1682
# File 'generated/google/apis/compute_beta/classes.rb', line 1680

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)


1690
1691
1692
# File 'generated/google/apis/compute_beta/classes.rb', line 1690

def name
  @name
end

#optionsString

Internal use only. Corresponds to the JSON property options

Returns:

  • (String)


1695
1696
1697
# File 'generated/google/apis/compute_beta/classes.rb', line 1695

def options
  @options
end

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

Returns:

  • (String)


1700
1701
1702
# File 'generated/google/apis/compute_beta/classes.rb', line 1700

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)


1710
1711
1712
# File 'generated/google/apis/compute_beta/classes.rb', line 1710

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)


1729
1730
1731
# File 'generated/google/apis/compute_beta/classes.rb', line 1729

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



1734
1735
1736
# File 'generated/google/apis/compute_beta/classes.rb', line 1734

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)


1743
1744
1745
# File 'generated/google/apis/compute_beta/classes.rb', line 1743

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)


1754
1755
1756
# File 'generated/google/apis/compute_beta/classes.rb', line 1754

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



1759
1760
1761
# File 'generated/google/apis/compute_beta/classes.rb', line 1759

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)


1768
1769
1770
# File 'generated/google/apis/compute_beta/classes.rb', line 1768

def source_snapshot_id
  @source_snapshot_id
end

#statusString

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

Returns:

  • (String)


1773
1774
1775
# File 'generated/google/apis/compute_beta/classes.rb', line 1773

def status
  @status
end

#storage_typeString

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

Returns:

  • (String)


1778
1779
1780
# File 'generated/google/apis/compute_beta/classes.rb', line 1778

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)


1784
1785
1786
# File 'generated/google/apis/compute_beta/classes.rb', line 1784

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


1790
1791
1792
# File 'generated/google/apis/compute_beta/classes.rb', line 1790

def users
  @users
end

#zoneString

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

Returns:

  • (String)


1795
1796
1797
# File 'generated/google/apis/compute_beta/classes.rb', line 1795

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
# File 'generated/google/apis/compute_beta/classes.rb', line 1802

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