Class: Google::Apis::ComputeV1::Image
- Inherits:
-
Object
- Object
- Google::Apis::ComputeV1::Image
- 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
Represents an Image resource.
You can use images to create boot disks for your VM instances. For more
information, read Images. (== resource_for $api_version
.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::ComputeV1::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::ComputeV1::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::ComputeV1::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.
-
#name ⇒ String
Name of the resource; provided by the client when the resource is created.
-
#raw_disk ⇒ Google::Apis::ComputeV1::Image::RawDisk
The parameters of the raw disk image.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#shielded_instance_initial_state ⇒ Google::Apis::ComputeV1::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::ComputeV1::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::ComputeV1::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::ComputeV1::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) .
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.
10491 10492 10493 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10491 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
10283 10284 10285 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10283 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
10288 10289 10290 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10288 def @creation_timestamp end |
#deprecated ⇒ Google::Apis::ComputeV1::DeprecationStatus
Deprecation status for a public resource.
Corresponds to the JSON property deprecated
10293 10294 10295 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10293 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
10299 10300 10301 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10299 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
10304 10305 10306 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10304 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
10312 10313 10314 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10312 def family @family end |
#guest_os_features ⇒ Array<Google::Apis::ComputeV1::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
10319 10320 10321 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10319 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
10325 10326 10327 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10325 def id @id end |
#image_encryption_key ⇒ Google::Apis::ComputeV1::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
10337 10338 10339 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10337 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
10342 10343 10344 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10342 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.
10354 10355 10356 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10354 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
10360 10361 10362 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10360 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
10365 10366 10367 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10365 def license_codes @license_codes end |
#licenses ⇒ Array<String>
Any applicable license URI.
Corresponds to the JSON property licenses
10370 10371 10372 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10370 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
10380 10381 10382 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10380 def name @name end |
#raw_disk ⇒ Google::Apis::ComputeV1::Image::RawDisk
The parameters of the raw disk image.
Corresponds to the JSON property rawDisk
10385 10386 10387 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10385 def raw_disk @raw_disk end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
10390 10391 10392 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10390 def self_link @self_link end |
#shielded_instance_initial_state ⇒ Google::Apis::ComputeV1::InitialStateConfig
Initial State for shielded instance, these are public keys which are safe to
store in public
Corresponds to the JSON property shieldedInstanceInitialState
10396 10397 10398 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10396 def shielded_instance_initial_state @shielded_instance_initial_state 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
10407 10408 10409 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10407 def source_disk @source_disk end |
#source_disk_encryption_key ⇒ Google::Apis::ComputeV1::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
10413 10414 10415 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10413 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
10420 10421 10422 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10420 def source_disk_id @source_disk_id end |
#source_image ⇒ String
URL of the source image used to create this image. In order to create an image, you must provide the full or partial URL of one of the following:
- The selfLink URL
- This property
- The rawDisk.source URL
- The sourceDisk URL
Corresponds to the JSON property
sourceImage
10431 10432 10433 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10431 def source_image @source_image end |
#source_image_encryption_key ⇒ Google::Apis::ComputeV1::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
10437 10438 10439 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10437 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
10444 10445 10446 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10444 def source_image_id @source_image_id end |
#source_snapshot ⇒ String
URL of the source snapshot used to create this image. In order to create an image, you must provide the full or partial URL of one of the following:
- The selfLink URL
- This property
- The sourceImage URL
- The rawDisk.source URL
- The sourceDisk URL
Corresponds to the JSON property
sourceSnapshot
10456 10457 10458 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10456 def source_snapshot @source_snapshot end |
#source_snapshot_encryption_key ⇒ Google::Apis::ComputeV1::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
10462 10463 10464 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10462 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
10469 10470 10471 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10469 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
10475 10476 10477 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10475 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
10483 10484 10485 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10483 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
10489 10490 10491 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10489 def storage_locations @storage_locations end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10496 10497 10498 10499 10500 10501 10502 10503 10504 10505 10506 10507 10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 |
# File 'generated/google/apis/compute_v1/classes.rb', line 10496 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) @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) end |