Compute Engine v1 API - Class Image (2.3.0)

public sealed class Image : IMessage<Image>, IEquatable<Image>, IDeepCloneable<Image>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class Image.

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

Inheritance

Object > Image

Implements

IMessage<Image>, IEquatable<Image>, IDeepCloneable<Image>, IBufferMessage, IMessage

Inherited Members

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

Image()

public Image()

Image(Image)

public Image(Image other)

Parameter
Name	Description
`other`	`Image`

Properties

Architecture

public string Architecture { get; set; }

The architecture of the image. Valid values are ARM64 or X86_64. Check the Architecture enum for the list of possible values.

Property Value
Type	Description
`String`

ArchiveSizeBytes

public long ArchiveSizeBytes { get; set; }

Size of the image tar.gz archive stored in Google Cloud Storage (in bytes).

Property Value
Type	Description
`Int64`

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in RFC3339 text format.

Property Value
Type	Description
`String`

Deprecated

public DeprecationStatus Deprecated { get; set; }

The deprecation status associated with this image.

Property Value
Type	Description
`DeprecationStatus`

Description

public string Description { get; set; }

An optional description of this resource. Provide this property when you create the resource.

Property Value
Type	Description
`String`

DiskSizeGb

public long DiskSizeGb { get; set; }

Size of the image when restored onto a persistent disk (in GB).

Property Value
Type	Description
`Int64`

Family

public string Family { get; set; }

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.

Property Value
Type	Description
`String`

GuestOsFeatures

public RepeatedField<GuestOsFeature> GuestOsFeatures { get; }

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.

Property Value
Type	Description
`RepeatedField<GuestOsFeature>`

HasArchitecture

public bool HasArchitecture { get; }

Gets whether the "architecture" field is set

Property Value
Type	Description
`Boolean`

HasArchiveSizeBytes

public bool HasArchiveSizeBytes { get; }

Gets whether the "archive_size_bytes" field is set

Property Value
Type	Description
`Boolean`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`Boolean`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`Boolean`

HasDiskSizeGb

public bool HasDiskSizeGb { get; }

Gets whether the "disk_size_gb" field is set

Property Value
Type	Description
`Boolean`

HasFamily

public bool HasFamily { get; }

Gets whether the "family" field is set

Property Value
Type	Description
`Boolean`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`Boolean`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`Boolean`

HasLabelFingerprint

public bool HasLabelFingerprint { get; }

Gets whether the "label_fingerprint" field is set

Property Value
Type	Description
`Boolean`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`Boolean`

HasSatisfiesPzs

public bool HasSatisfiesPzs { get; }

Gets whether the "satisfies_pzs" field is set

Property Value
Type	Description
`Boolean`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`Boolean`

HasSourceDisk

public bool HasSourceDisk { get; }

Gets whether the "source_disk" field is set

Property Value
Type	Description
`Boolean`

HasSourceDiskId

public bool HasSourceDiskId { get; }

Gets whether the "source_disk_id" field is set

Property Value
Type	Description
`Boolean`

HasSourceImage

public bool HasSourceImage { get; }

Gets whether the "source_image" field is set

Property Value
Type	Description
`Boolean`

HasSourceImageId

public bool HasSourceImageId { get; }

Gets whether the "source_image_id" field is set

Property Value
Type	Description
`Boolean`

HasSourceSnapshot

public bool HasSourceSnapshot { get; }

Gets whether the "source_snapshot" field is set

Property Value
Type	Description
`Boolean`

HasSourceSnapshotId

public bool HasSourceSnapshotId { get; }

Gets whether the "source_snapshot_id" field is set

Property Value
Type	Description
`Boolean`

HasSourceType

public bool HasSourceType { get; }

Gets whether the "source_type" field is set

Property Value
Type	Description
`Boolean`

HasStatus

public bool HasStatus { get; }

Gets whether the "status" field is set

Property Value
Type	Description
`Boolean`

Id

public ulong Id { get; set; }

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Property Value
Type	Description
`UInt64`

ImageEncryptionKey

public CustomerEncryptionKey ImageEncryptionKey { get; set; }

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.

Property Value
Type	Description
`CustomerEncryptionKey`

Kind

public string Kind { get; set; }

[Output Only] Type of the resource. Always compute#image for images.

Property Value
Type	Description
`String`

LabelFingerprint

public string LabelFingerprint { get; set; }

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.

Property Value
Type	Description
`String`

Labels

public MapField<string, string> Labels { get; }

Labels to apply to this image. These can be later modified by the setLabels method.

Property Value
Type	Description
`MapField<String, String>`

LicenseCodes

public RepeatedField<long> LicenseCodes { get; }

Integer license codes indicating which licenses are attached to this image.

Property Value
Type	Description
`RepeatedField<Int64>`

Licenses

public RepeatedField<string> Licenses { get; }

Any applicable license URI.

Property Value
Type	Description
`RepeatedField<String>`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`String`

RawDisk

public RawDisk RawDisk { get; set; }

The parameters of the raw disk image.

Property Value
Type	Description
`RawDisk`

SatisfiesPzs

public bool SatisfiesPzs { get; set; }

[Output Only] Reserved for future use.

Property Value
Type	Description
`Boolean`

SelfLink

public string SelfLink { get; set; }

[Output Only] Server-defined URL for the resource.

Property Value
Type	Description
`String`

ShieldedInstanceInitialState

public InitialStateConfig ShieldedInstanceInitialState { get; set; }

Set the secure boot keys of shielded instance.

Property Value
Type	Description
`InitialStateConfig`

SourceDisk

public string SourceDisk { get; set; }

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

Property Value
Type	Description
`String`

SourceDiskEncryptionKey

public CustomerEncryptionKey SourceDiskEncryptionKey { get; set; }

The customer-supplied encryption key of the source disk. Required if the source disk is protected by a customer-supplied encryption key.

Property Value
Type	Description
`CustomerEncryptionKey`

SourceDiskId

public string SourceDiskId { get; set; }

[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.

Property Value
Type	Description
`String`

SourceImage

public string SourceImage { get; set; }

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

Property Value
Type	Description
`String`

SourceImageEncryptionKey

public CustomerEncryptionKey SourceImageEncryptionKey { get; set; }

The customer-supplied encryption key of the source image. Required if the source image is protected by a customer-supplied encryption key.

Property Value
Type	Description
`CustomerEncryptionKey`

SourceImageId

public string SourceImageId { get; set; }

[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.

Property Value
Type	Description
`String`

SourceSnapshot

public string SourceSnapshot { get; set; }

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

Property Value
Type	Description
`String`

SourceSnapshotEncryptionKey

public CustomerEncryptionKey SourceSnapshotEncryptionKey { get; set; }

The customer-supplied encryption key of the source snapshot. Required if the source snapshot is protected by a customer-supplied encryption key.

Property Value
Type	Description
`CustomerEncryptionKey`

SourceSnapshotId

public string SourceSnapshotId { get; set; }

[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.

Property Value
Type	Description
`String`

SourceType

public string SourceType { get; set; }

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.

Property Value
Type	Description
`String`

Status

public string Status { get; set; }

[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.

Property Value
Type	Description
`String`

StorageLocations

public RepeatedField<string> StorageLocations { get; }

Cloud Storage bucket storage location of the image (regional or multi-regional).

Property Value
Type	Description
`RepeatedField<String>`