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



3734
3735
3736
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3734

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

Instance Attribute Details

#archive_size_bytes ⇒ String

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

Returns:

  • (String) 


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

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) 


3617
3618
3619
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3617

def creation_timestamp
  @creation_timestamp
end

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

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

Returns:



3622
3623
3624
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3622

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) 


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

def description
  @description
end

#disk_size_gb ⇒ String

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

Returns:

  • (String) 


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

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) 


3641
3642
3643
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3641

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_SCSCI_MULTIQUEUE, which allows each virtual CPU to have its own queue. For Windows images, you can only enable VIRTIO_SCSCI_MULTIQUEUE on images with driver version 1.2.0. 1621 or higher. Linux images with kernel versions 3.17 and higher will support VIRTIO_SCSCI_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:



3654
3655
3656
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3654

def guest_os_features
  @guest_os_features
end

#id ⇒ String

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

Returns:

  • (String) 


3660
3661
3662
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3660

def id
  @id
end

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

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

Returns:



3665
3666
3667
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3665

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) 


3670
3671
3672
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3670

def kind
  @kind
end

#licenses ⇒ Array<String>

Any applicable license URI. Corresponds to the JSON property licenses

Returns:

  • (Array<String>) 


3675
3676
3677
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3675

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) 


3685
3686
3687
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3685

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:



3690
3691
3692
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3690

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) 


3695
3696
3697
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3695

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) 


3706
3707
3708
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3706

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:



3711
3712
3713
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3711

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) 


3718
3719
3720
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3718

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) 


3724
3725
3726
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3724

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) 


3732
3733
3734
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3732

def status
  @status
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
 
# File 'generated/google/apis/compute_v1/classes.rb', line 3739

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