Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Image (v2.3.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Image.

Represents an Image resource. You can use images to create boot disks for your VM instances. For more information, read Images.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#architecture

def architecture() -> ::String
Returns
  • (::String) — The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

#architecture=

def architecture=(value) -> ::String
Parameter
  • value (::String) — The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.
Returns
  • (::String) — The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

#archive_size_bytes

def archive_size_bytes() -> ::Integer
Returns
  • (::Integer) — Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

#archive_size_bytes=

def archive_size_bytes=(value) -> ::Integer
Parameter
  • value (::Integer) — Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).
Returns
  • (::Integer) — Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
  • (::String) — [Output Only] Creation timestamp in RFC3339 text format.

#deprecated

def deprecated() -> ::Google::Cloud::Compute::V1::DeprecationStatus
Returns

#deprecated=

def deprecated=(value) -> ::Google::Cloud::Compute::V1::DeprecationStatus
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#disk_size_gb

def disk_size_gb() -> ::Integer
Returns
  • (::Integer) — Size of the image when restored onto a persistent disk (in GB).

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer
Parameter
  • value (::Integer) — Size of the image when restored onto a persistent disk (in GB).
Returns
  • (::Integer) — Size of the image when restored onto a persistent disk (in GB).

#family

def family() -> ::String
Returns
  • (::String) — The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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.

#family=

def family=(value) -> ::String
Parameter
  • value (::String) — The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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.
Returns
  • (::String) — The name of the image family to which this image belongs. The image family name can be from a publicly managed image family provided by Compute Engine, or from a custom image family you create. For example, centos-stream-9 is a publicly available image family. For more information, see Image family best practices. When creating disks, you can specify 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.

#guest_os_features

def guest_os_features() -> ::Array<::Google::Cloud::Compute::V1::GuestOsFeature>
Returns
  • (::Array<::Google::Cloud::Compute::V1::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.

#guest_os_features=

def guest_os_features=(value) -> ::Array<::Google::Cloud::Compute::V1::GuestOsFeature>
Parameter
  • value (::Array<::Google::Cloud::Compute::V1::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.
Returns
  • (::Array<::Google::Cloud::Compute::V1::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.

#id

def id() -> ::Integer
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#image_encryption_key

def image_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns
  • (::Google::Cloud::Compute::V1::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.

#image_encryption_key=

def image_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
  • value (::Google::Cloud::Compute::V1::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.
Returns
  • (::Google::Cloud::Compute::V1::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.

#kind

def kind() -> ::String
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#image for images.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Type of the resource. Always compute#image for images.
Returns
  • (::String) — [Output Only] Type of the resource. Always compute#image for images.

#label_fingerprint

def label_fingerprint() -> ::String
Returns
  • (::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.

#label_fingerprint=

def label_fingerprint=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this image. These can be later modified by the setLabels method.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this image. These can be later modified by the setLabels method.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels to apply to this image. These can be later modified by the setLabels method.

#license_codes

def license_codes() -> ::Array<::Integer>
Returns
  • (::Array<::Integer>) — Integer license codes indicating which licenses are attached to this image.

#license_codes=

def license_codes=(value) -> ::Array<::Integer>
Parameter
  • value (::Array<::Integer>) — Integer license codes indicating which licenses are attached to this image.
Returns
  • (::Array<::Integer>) — Integer license codes indicating which licenses are attached to this image.

#licenses

def licenses() -> ::Array<::String>
Returns
  • (::Array<::String>) — Any applicable license URI.

#licenses=

def licenses=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Any applicable license URI.
Returns
  • (::Array<::String>) — Any applicable license URI.

#name

def name() -> ::String
Returns
  • (::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.

#name=

def name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#raw_disk

def raw_disk() -> ::Google::Cloud::Compute::V1::RawDisk
Returns

#raw_disk=

def raw_disk=(value) -> ::Google::Cloud::Compute::V1::RawDisk
Parameter
Returns

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — [Output Only] Reserved for future use.

#satisfies_pzs=

def satisfies_pzs=(value) -> ::Boolean
Parameter
  • value (::Boolean) — [Output Only] Reserved for future use.
Returns
  • (::Boolean) — [Output Only] Reserved for future use.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output Only] Server-defined URL for the resource.
Returns
  • (::String) — [Output Only] Server-defined URL for the resource.

#shielded_instance_initial_state

def shielded_instance_initial_state() -> ::Google::Cloud::Compute::V1::InitialStateConfig
Returns

#shielded_instance_initial_state=

def shielded_instance_initial_state=(value) -> ::Google::Cloud::Compute::V1::InitialStateConfig
Parameter
Returns

#source_disk

def source_disk() -> ::String
Returns
  • (::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

#source_disk=

def source_disk=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#source_disk_encryption_key

def source_disk_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns

#source_disk_encryption_key=

def source_disk_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
Returns

#source_disk_id

def source_disk_id() -> ::String
Returns
  • (::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.

#source_disk_id=

def source_disk_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#source_image

def source_image() -> ::String
Returns
  • (::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

#source_image=

def source_image=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#source_image_encryption_key

def source_image_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns

#source_image_encryption_key=

def source_image_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
Returns

#source_image_id

def source_image_id() -> ::String
Returns
  • (::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.

#source_image_id=

def source_image_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#source_snapshot

def source_snapshot() -> ::String
Returns
  • (::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

#source_snapshot=

def source_snapshot=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#source_snapshot_encryption_key

def source_snapshot_encryption_key() -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Returns

#source_snapshot_encryption_key=

def source_snapshot_encryption_key=(value) -> ::Google::Cloud::Compute::V1::CustomerEncryptionKey
Parameter
Returns

#source_snapshot_id

def source_snapshot_id() -> ::String
Returns
  • (::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.

#source_snapshot_id=

def source_snapshot_id=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#source_type

def source_type() -> ::String
Returns
  • (::String) — The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.

#source_type=

def source_type=(value) -> ::String
Parameter
  • value (::String) — The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.
Returns
  • (::String) — The type of the image used to create this disk. The default and only valid value is RAW. Check the SourceType enum for the list of possible values.

#status

def status() -> ::String
Returns
  • (::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. Check the Status enum for the list of possible values.

#status=

def status=(value) -> ::String
Parameter
  • value (::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. Check the Status enum for the list of possible values.
Returns
  • (::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. Check the Status enum for the list of possible values.

#storage_locations

def storage_locations() -> ::Array<::String>
Returns
  • (::Array<::String>) — Cloud Storage bucket storage location of the image (regional or multi-regional).

#storage_locations=

def storage_locations=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Cloud Storage bucket storage location of the image (regional or multi-regional).
Returns
  • (::Array<::String>) — Cloud Storage bucket storage location of the image (regional or multi-regional).