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.

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



1931
1932
1933
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1931

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) 


1782
1783
1784
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1782

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) 


1788
1789
1790
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1788

def description
  @description
end

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

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

Returns:



1793
1794
1795
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1793

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) 


1799
1800
1801
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1799

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) 


1804
1805
1806
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1804

def kind
  @kind
end

#last_attach_timestamp ⇒ String

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

Returns:

  • (String) 


1809
1810
1811
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1809

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) 


1814
1815
1816
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1814

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


1819
1820
1821
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1819

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) 


1829
1830
1831
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1829

def name
  @name
end

#options ⇒ String

Internal use only. Corresponds to the JSON property options

Returns:

  • (String) 


1834
1835
1836
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1834

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) 


1839
1840
1841
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1839

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

Returns:

  • (Fixnum) 


1849
1850
1851
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1849

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


1868
1869
1870
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1868

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:



1873
1874
1875
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1873

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) 


1882
1883
1884
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1882

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) 


1893
1894
1895
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1893

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:



1898
1899
1900
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1898

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) 


1907
1908
1909
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1907

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) 


1912
1913
1914
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1912

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) 


1918
1919
1920
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1918

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


1924
1925
1926
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1924

def users
  @users
end

#zone ⇒ String

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

Returns:

  • (String) 


1929
1930
1931
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1929

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
 
# File 'generated/google/apis/compute_v1/classes.rb', line 1936

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