Class: Google::Apis::ComputeV1::Image

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

An Image resource.

Defined Under Namespace

Classes: RawDisk

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

Returns a new instance of Image



3916
3917
3918
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3916

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

Instance Attribute Details

#archive_size_bytes ⇒ Fixnum

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). Corresponds to the JSON property archiveSizeBytes

Returns:

  • (Fixnum) 


3788
3789
3790
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3788

def archive_size_bytes
  @archive_size_bytes
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


3793
3794
3795
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3793

def creation_timestamp
  @creation_timestamp
end

#deprecated ⇒ Google::Apis::ComputeV1::DeprecationStatus

Deprecation status for a public resource. Corresponds to the JSON property deprecated

Returns:



3798
3799
3800
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3798

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


3804
3805
3806
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3804

def description
  @description
end

#disk_size_gb ⇒ Fixnum

Size of the image when restored onto a persistent disk (in GB). Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


3809
3810
3811
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3809

def disk_size_gb
  @disk_size_gb
end

#family ⇒ String

The name of the image family to which this image belongs. You can create disks by specifying an image family instead of a specific image name. The image family always returns its latest image that is not deprecated. The name of the image family must comply with RFC1035. Corresponds to the JSON property family

Returns:

  • (String) 


3817
3818
3819
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3817

def family
  @family
end

#guest_os_features ⇒ Array<Google::Apis::ComputeV1::GuestOsFeature>

A list of features to enable on the guest OS. Applicable for bootable images only. Currently, only one feature can be enabled, VIRTIO_SCSI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSI_MULTIQUEUE on images with driver version 1.2.0. 1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSI_MULTIQUEUE. For new Windows images, the server might also populate this field with the value WINDOWS, to indicate that this is a Windows image. This value is purely informational and does not enable or disable any features. Corresponds to the JSON property guestOsFeatures

Returns:



3830
3831
3832
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3830

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


3836
3837
3838
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3836

def id
  @id
end

#image_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

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

Returns:



3841
3842
3843
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3841

def image_encryption_key
  @image_encryption_key
end

#kind ⇒ String

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

Returns:

  • (String) 


3846
3847
3848
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3846

def kind
  @kind
end

#labels ⇒ Hash<String,String>

Labels to apply to this image. These can be later modified by the setLabels method. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


3852
3853
3854
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3852

def labels
  @labels
end

#licenses ⇒ Array<String>

Any applicable license URI. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


3857
3858
3859
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3857

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) 


3867
3868
3869
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3867

def name
  @name
end

#raw_disk ⇒ Google::Apis::ComputeV1::Image::RawDisk

The parameters of the raw disk image. Corresponds to the JSON property rawDisk

Returns:



3872
3873
3874
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3872

def raw_disk
  @raw_disk
end

#self_link ⇒ String

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

Returns:

  • (String) 


3877
3878
3879
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3877

def self_link
  @self_link
end

#source_disk ⇒ String

URL of the source disk used to create this image. This can be a full or valid partial URL. You must provide either this property or the rawDisk.source property but not both to create an image. For example, the following are valid values:

Returns:

  • (String) 


3888
3889
3890
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3888

def source_disk
  @source_disk
end

#source_disk_encryption_key ⇒ Google::Apis::ComputeV1::CustomerEncryptionKey

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

Returns:



3893
3894
3895
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3893

def source_disk_encryption_key
  @source_disk_encryption_key
end

#source_disk_id ⇒ String

The ID value of the disk used to create this image. This value may be used to determine whether the image was taken from the current or a previous instance of a given disk name. Corresponds to the JSON property sourceDiskId

Returns:

  • (String) 


3900
3901
3902
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3900

def source_disk_id
  @source_disk_id
end

#source_type ⇒ String

The type of the image used to create this disk. The default and only value is RAW Corresponds to the JSON property sourceType

Returns:

  • (String) 


3906
3907
3908
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3906

def source_type
  @source_type
end

#status ⇒ String

[Output Only] The status of the image. An image can be used to create other resources, such as instances, only after the image has been successfully created and the status is set to READY. Possible values are FAILED, PENDING, or READY. Corresponds to the JSON property status

Returns:

  • (String) 


3914
3915
3916
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3914

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3921

def update!(**args)
  @archive_size_bytes = args[:archive_size_bytes] if args.key?(:archive_size_bytes)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @deprecated = args[:deprecated] if args.key?(:deprecated)
  @description = args[:description] if args.key?(:description)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @family = args[:family] if args.key?(:family)
  @guest_os_features = args[:guest_os_features] if args.key?(:guest_os_features)
  @id = args[:id] if args.key?(:id)
  @image_encryption_key = args[:image_encryption_key] if args.key?(:image_encryption_key)
  @kind = args[:kind] if args.key?(:kind)
  @labels = args[:labels] if args.key?(:labels)
  @licenses = args[:licenses] if args.key?(:licenses)
  @name = args[:name] if args.key?(:name)
  @raw_disk = args[:raw_disk] if args.key?(:raw_disk)
  @self_link = args[:self_link] if args.key?(:self_link)
  @source_disk = args[:source_disk] if args.key?(:source_disk)
  @source_disk_encryption_key = args[:source_disk_encryption_key] if args.key?(:source_disk_encryption_key)
  @source_disk_id = args[:source_disk_id] if args.key?(:source_disk_id)
  @source_type = args[:source_type] if args.key?(:source_type)
  @status = args[:status] if args.key?(:status)
end