Class: Google::Apis::ComputeAlpha::Image
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Image
- Defined in:
- generated/google/apis/compute_alpha/classes.rb,
generated/google/apis/compute_alpha/representations.rb,
generated/google/apis/compute_alpha/representations.rb
Overview
An Image resource. (== resource_for beta.images ==) (== resource_for v1.images ==)
Defined Under Namespace
Classes: RawDisk
Instance Attribute Summary collapse
-
#archive_size_bytes ⇒ Fixnum
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#deprecated ⇒ Google::Apis::ComputeAlpha::DeprecationStatus
Deprecation status for a public resource.
-
#description ⇒ String
An optional description of this resource.
-
#disk_size_gb ⇒ Fixnum
Size of the image when restored onto a persistent disk (in GB).
-
#family ⇒ String
The name of the image family to which this image belongs.
-
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>
A list of features to enable on the guest operating system.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
imageEncryptionKey
. -
#kind ⇒ String
[Output Only] Type of the resource.
-
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this image, which is essentially a hash of the labels used for optimistic locking.
-
#labels ⇒ Hash<String,String>
Labels to apply to this image.
-
#license_codes ⇒ Array<Fixnum>
Integer license codes indicating which licenses are attached to this image.
-
#licenses ⇒ Array<String>
Any applicable license URI.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#raw_disk ⇒ Google::Apis::ComputeAlpha::Image::RawDisk
The parameters of the raw disk image.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#source_disk ⇒ String
URL of the source disk used to create this image.
-
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceDiskEncryptionKey
. -
#source_disk_id ⇒ String
The ID value of the disk used to create this image.
-
#source_image ⇒ String
URL of the source image used to create this image.
-
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceImageEncryptionKey
. -
#source_image_id ⇒ String
[Output Only] The ID value of the image used to create this image.
-
#source_snapshot ⇒ String
URL of the source snapshot used to create this image.
-
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key Corresponds to the JSON property
sourceSnapshotEncryptionKey
. -
#source_snapshot_id ⇒ String
[Output Only] The ID value of the snapshot used to create this image.
-
#source_type ⇒ String
The type of the image used to create this disk.
-
#status ⇒ String
[Output Only] The status of the image.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Image
constructor
A new instance of Image.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ Image
Returns a new instance of Image
8772 8773 8774 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8772 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
8591 8592 8593 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8591 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
8596 8597 8598 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8596 def @creation_timestamp end |
#deprecated ⇒ Google::Apis::ComputeAlpha::DeprecationStatus
Deprecation status for a public resource.
Corresponds to the JSON property deprecated
8601 8602 8603 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8601 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
8607 8608 8609 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8607 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
8612 8613 8614 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8612 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
8620 8621 8622 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8620 def family @family end |
#guest_os_features ⇒ Array<Google::Apis::ComputeAlpha::GuestOsFeature>
A list of features to enable on the guest operating system. Applicable only
for bootable images. Read Enabling guest operating system features to see a
list of available options.
Corresponds to the JSON property guestOsFeatures
8627 8628 8629 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8627 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
8633 8634 8635 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8633 def id @id end |
#image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property imageEncryptionKey
8638 8639 8640 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8638 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
8643 8644 8645 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8643 def kind @kind end |
#label_fingerprint ⇒ String
A fingerprint for the labels being applied to this image, which is essentially
a hash of the labels 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 an image.
Corresponds to the JSON property labelFingerprint
NOTE: Values are automatically base64 encoded/decoded in the client library.
8654 8655 8656 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8654 def label_fingerprint @label_fingerprint 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
8660 8661 8662 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8660 def labels @labels end |
#license_codes ⇒ Array<Fixnum>
Integer license codes indicating which licenses are attached to this image.
Corresponds to the JSON property licenseCodes
8665 8666 8667 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8665 def license_codes @license_codes end |
#licenses ⇒ Array<String>
Any applicable license URI.
Corresponds to the JSON property licenses
8670 8671 8672 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8670 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]([-a-
z0-9]*[a-z0-9])?
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
8680 8681 8682 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8680 def name @name end |
#raw_disk ⇒ Google::Apis::ComputeAlpha::Image::RawDisk
The parameters of the raw disk image.
Corresponds to the JSON property rawDisk
8685 8686 8687 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8685 def raw_disk @raw_disk end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
8690 8691 8692 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8690 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:
- https://www.googleapis.com/compute/v1/projects/project/zones/zone/disks/disk
- projects/project/zones/zone/disks/disk
- zones/zone/disks/disk
Corresponds to the JSON property
sourceDisk
8701 8702 8703 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8701 def source_disk @source_disk end |
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceDiskEncryptionKey
8706 8707 8708 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8706 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
8713 8714 8715 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8713 def source_disk_id @source_disk_id end |
#source_image ⇒ String
URL of the source image used to create this image. This can be a full or valid partial URL. You must provide exactly one of:
- this property, or
- the rawDisk.source property, or
- the sourceDisk property in order to create an image.
Corresponds to the JSON property
sourceImage
8722 8723 8724 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8722 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceImageEncryptionKey
8727 8728 8729 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8727 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 image. This value
may be used to determine whether the image was taken from the current or a
previous instance of a given image name.
Corresponds to the JSON property sourceImageId
8734 8735 8736 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8734 def source_image_id @source_image_id end |
#source_snapshot ⇒ String
URL of the source snapshot used to create this image. This can be a full or valid partial URL. You must provide exactly one of:
- this property, or
- the sourceImage property, or
- the rawDisk.source property, or
- the sourceDisk property in order to create an image.
Corresponds to the JSON property
sourceSnapshot
8744 8745 8746 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8744 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Represents a customer-supplied encryption key
Corresponds to the JSON property sourceSnapshotEncryptionKey
8749 8750 8751 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8749 def source_snapshot_encryption_key @source_snapshot_encryption_key end |
#source_snapshot_id ⇒ String
[Output Only] The ID value of the snapshot used to create this image. This
value may be used to determine whether the snapshot was taken from the current
or a previous instance of a given snapshot name.
Corresponds to the JSON property sourceSnapshotId
8756 8757 8758 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8756 def source_snapshot_id @source_snapshot_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
8762 8763 8764 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8762 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
8770 8771 8772 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8770 def status @status end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 8801 8802 8803 8804 8805 8806 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8777 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) @label_fingerprint = args[:label_fingerprint] if args.key?(:label_fingerprint) @labels = args[:labels] if args.key?(:labels) @license_codes = args[:license_codes] if args.key?(:license_codes) @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_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) @source_type = args[:source_type] if args.key?(:source_type) @status = args[:status] if args.key?(:status) end |