Class: Google::Apis::ComputeAlpha::Image
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Image
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/compute_alpha/classes.rb,
lib/google/apis/compute_alpha/representations.rb,
lib/google/apis/compute_alpha/representations.rb
Overview
Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.
Defined Under Namespace
Classes: RawDisk
Instance Attribute Summary collapse
-
#architecture ⇒ String
The architecture of the image.
-
#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
Encrypts the image using a customer-supplied encryption key.
-
#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.
-
#locked ⇒ Boolean
(also: #locked?)
A flag for marketplace VM disk created from the image, which is designed for marketplace VM disk to prevent the proprietary data on the disk from being accessed unwantedly.
-
#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.
-
#rollout_override ⇒ Google::Apis::ComputeAlpha::RolloutPolicy
A rollout policy configuration.
-
#satisfies_pzs ⇒ Boolean
(also: #satisfies_pzs?)
[Output Only] Reserved for future use.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource's resource id.
-
#shielded_instance_initial_state ⇒ Google::Apis::ComputeAlpha::InitialStateConfig
Initial State for shielded instance, these are public keys which are safe to store in public Corresponds to the JSON property
shieldedInstanceInitialState
. -
#source_disk ⇒ String
URL of the source disk used to create this image.
-
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source disk.
-
#source_disk_id ⇒ String
[Output Only] 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
The customer-supplied encryption key of the source image.
-
#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
The customer-supplied encryption key of the source snapshot.
-
#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.
-
#storage_locations ⇒ Array<String>
Cloud Storage bucket storage location of the image (regional or multi-regional) .
-
#user_licenses ⇒ Array<String>
A list of publicly visible user-licenses.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Image
constructor
A new instance of Image.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Image
Returns a new instance of Image.
13847 13848 13849 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13847 def initialize(**args) update!(**args) end |
Instance Attribute Details
#architecture ⇒ String
The architecture of the image. Valid values are ARM64 or X86_64.
Corresponds to the JSON property architecture
13596 13597 13598 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13596 def architecture @architecture end |
#archive_size_bytes ⇒ Fixnum
Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
Corresponds to the JSON property archiveSizeBytes
13601 13602 13603 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13601 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
13606 13607 13608 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13606 def @creation_timestamp end |
#deprecated ⇒ Google::Apis::ComputeAlpha::DeprecationStatus
Deprecation status for a public resource.
Corresponds to the JSON property deprecated
13611 13612 13613 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13611 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
13617 13618 13619 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13617 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
13622 13623 13624 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13622 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
13630 13631 13632 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13630 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. To see a list of available options, see the
guestOSfeatures[].type parameter.
Corresponds to the JSON property guestOsFeatures
13637 13638 13639 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13637 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
13643 13644 13645 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13643 def id @id end |
#image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
Encrypts the image using a customer-supplied encryption key. After you encrypt
an image with a customer-supplied key, you must provide the same key if you
use the image later (e.g. to create a disk from the image). Customer-supplied
encryption keys do not protect access to metadata of the disk. If you do not
provide an encryption key when creating the image, then the disk will be
encrypted using an automatically generated key and you do not need to provide
a key to use the image later.
Corresponds to the JSON property imageEncryptionKey
13654 13655 13656 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13654 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
13659 13660 13661 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13659 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, otherwise the request will fail with error 412
conditionNotMet. 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.
13671 13672 13673 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13671 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
13677 13678 13679 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13677 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
13682 13683 13684 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13682 def license_codes @license_codes end |
#licenses ⇒ Array<String>
Any applicable license URI.
Corresponds to the JSON property licenses
13687 13688 13689 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13687 def licenses @licenses end |
#locked ⇒ Boolean Also known as: locked?
A flag for marketplace VM disk created from the image, which is designed for
marketplace VM disk to prevent the proprietary data on the disk from being
accessed unwantedly. The flag will be inherited by the disk created from the
image. The disk with locked flag set to true will be prohibited from
performing the operations below: - R/W or R/O disk attach - Disk detach, if
disk is created via create-on-create - Create images - Create snapshots -
Create disk clone (create disk from the current disk) The image with the
locked field set to true will be prohibited from performing the operations
below: - Create images from the current image - Update the locked field for
the current image The instance with at least one disk with locked flag set to
true will be prohibited from performing the operations below: - Secondary disk
attach - Create instant snapshot - Create machine images - Create instance
template - Delete the instance with --keep-disk parameter set to true
Corresponds to the JSON property locked
13704 13705 13706 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13704 def locked @locked 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
13715 13716 13717 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13715 def name @name end |
#raw_disk ⇒ Google::Apis::ComputeAlpha::Image::RawDisk
The parameters of the raw disk image.
Corresponds to the JSON property rawDisk
13720 13721 13722 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13720 def raw_disk @raw_disk end |
#rollout_override ⇒ Google::Apis::ComputeAlpha::RolloutPolicy
A rollout policy configuration.
Corresponds to the JSON property rolloutOverride
13725 13726 13727 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13725 def rollout_override @rollout_override end |
#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?
[Output Only] Reserved for future use.
Corresponds to the JSON property satisfiesPzs
13730 13731 13732 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13730 def satisfies_pzs @satisfies_pzs end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
13736 13737 13738 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13736 def self_link @self_link end |
#self_link_with_id ⇒ String
[Output Only] Server-defined URL for this resource's resource id.
Corresponds to the JSON property selfLinkWithId
13741 13742 13743 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13741 def self_link_with_id @self_link_with_id end |
#shielded_instance_initial_state ⇒ Google::Apis::ComputeAlpha::InitialStateConfig
Initial State for shielded instance, these are public keys which are safe to
store in public
Corresponds to the JSON property shieldedInstanceInitialState
13747 13748 13749 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13747 def shielded_instance_initial_state @shielded_instance_initial_state end |
#source_disk ⇒ String
URL of the source disk used to create this 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 In order to create an image, you must provide the full or partial
URL of one of the following: - The rawDisk.source URL - The sourceDisk URL -
The sourceImage URL - The sourceSnapshot URL
Corresponds to the JSON property sourceDisk
13757 13758 13759 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13757 def source_disk @source_disk end |
#source_disk_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source disk. Required if the
source disk is protected by a customer-supplied encryption key.
Corresponds to the JSON property sourceDiskEncryptionKey
13763 13764 13765 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13763 def source_disk_encryption_key @source_disk_encryption_key end |
#source_disk_id ⇒ String
[Output Only] 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
13770 13771 13772 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13770 def source_disk_id @source_disk_id end |
#source_image ⇒ String
URL of the source image used to create this image. The following are valid
formats for the URL: - https://www.googleapis.com/compute/v1/projects/
project_id/global/ images/image_name - projects/project_id/global/images/
image_name In order to create an image, you must provide the full or partial
URL of one of the following: - The rawDisk.source URL - The sourceDisk URL -
The sourceImage URL - The sourceSnapshot URL
Corresponds to the JSON property sourceImage
13780 13781 13782 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13780 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source image. Required if the
source image is protected by a customer-supplied encryption key.
Corresponds to the JSON property sourceImageEncryptionKey
13786 13787 13788 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13786 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
13793 13794 13795 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13793 def source_image_id @source_image_id end |
#source_snapshot ⇒ String
URL of the source snapshot used to create this image. The following are valid
formats for the URL: - https://www.googleapis.com/compute/v1/projects/
project_id/global/ snapshots/snapshot_name - projects/project_id/global/
snapshots/snapshot_name In order to create an image, you must provide the full
or partial URL of one of the following: - The rawDisk.source URL - The
sourceDisk URL - The sourceImage URL - The sourceSnapshot URL
Corresponds to the JSON property sourceSnapshot
13803 13804 13805 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13803 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeAlpha::CustomerEncryptionKey
The customer-supplied encryption key of the source snapshot. Required if the
source snapshot is protected by a customer-supplied encryption key.
Corresponds to the JSON property sourceSnapshotEncryptionKey
13809 13810 13811 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13809 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
13816 13817 13818 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13816 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
13822 13823 13824 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13822 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
13830 13831 13832 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13830 def status @status end |
#storage_locations ⇒ Array<String>
Cloud Storage bucket storage location of the image (regional or multi-regional)
.
Corresponds to the JSON property storageLocations
13836 13837 13838 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13836 def storage_locations @storage_locations end |
#user_licenses ⇒ Array<String>
A list of publicly visible user-licenses. Unlike regular licenses, user
provided licenses can be modified after the disk is created. This includes a
list of URLs to the license resource. For example, to provide a debian license:
https://www.googleapis.com/compute/v1/projects/debian-cloud/global/licenses/
debian-9-stretch
Corresponds to the JSON property userLicenses
13845 13846 13847 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13845 def user_licenses @user_licenses end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 13875 13876 13877 13878 13879 13880 13881 13882 13883 13884 13885 13886 13887 13888 13889 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13852 def update!(**args) @architecture = args[:architecture] if args.key?(:architecture) @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) @locked = args[:locked] if args.key?(:locked) @name = args[:name] if args.key?(:name) @raw_disk = args[:raw_disk] if args.key?(:raw_disk) @rollout_override = args[:rollout_override] if args.key?(:rollout_override) @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @self_link = args[:self_link] if args.key?(:self_link) @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id) @shielded_instance_initial_state = args[:shielded_instance_initial_state] if args.key?(:shielded_instance_initial_state) @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) @storage_locations = args[:storage_locations] if args.key?(:storage_locations) @user_licenses = args[:user_licenses] if args.key?(:user_licenses) end |