project STRING Required

Project ID for this request

forceCreate BOOLEAN

Force image creation if true

requestId STRING

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)

archiveSizeBytes INTEGER

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

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

deprecated OBJECT

Deprecation status for a public resource

deprecated.deleted STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it

deprecated.deprecated STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it

deprecated.obsolete STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it

deprecated.replacement STRING

The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource

deprecated.state ENUMERATION

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error

description STRING

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

diskSizeGb INTEGER

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

guestOsFeatures[] OBJECT

Guest OS features

guestOsFeatures[].type ENUMERATION

The ID of a supported feature. Read Enabling guest operating system features to see a list of available options

id INTEGER

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

imageEncryptionKey OBJECT

Represents a customer-supplied encryption key

imageEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

imageEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

imageEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

kind STRING

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

labelFingerprint BINARY

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 OBJECT

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

labels.customKey.value STRING Required

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

licenseCodes[] INTEGER

licenses[] STRING

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

rawDisk OBJECT

The parameters of the raw disk image

rawDisk.containerType ENUMERATION

The format used to encode and transmit the block device, which should be TAR. This is just a container and transmission format and not a runtime format. Provided by the client when the disk image is created

rawDisk.sha1Checksum STRING

[Deprecated] This field is deprecated. An optional SHA1 checksum of the disk image before unpackaging provided by the client when the disk image is created

rawDisk.source STRING

The full Google Cloud Storage URL where the disk image is stored. You must provide either this property or the sourceDisk property but not both

selfLink STRING

[Output Only] Server-defined URL for the resource

sourceDisk 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

sourceDiskEncryptionKey OBJECT

Represents a customer-supplied encryption key

sourceDiskEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

sourceDiskEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

sourceDiskEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

sourceDiskId 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

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

sourceImageEncryptionKey OBJECT

Represents a customer-supplied encryption key

sourceImageEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

sourceImageEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

sourceImageEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

sourceImageId 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

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

sourceSnapshotEncryptionKey OBJECT

Represents a customer-supplied encryption key

sourceSnapshotEncryptionKey.kmsKeyName STRING

The name of the encryption key that is stored in Google Cloud KMS

sourceSnapshotEncryptionKey.rawKey STRING

Specifies a 256-bit customer-supplied encryption key, encoded in RFC 4648 base64 to either encrypt or decrypt this resource

sourceSnapshotEncryptionKey.sha256 STRING

[Output only] The RFC 4648 base64 encoded SHA-256 hash of the customer-supplied encryption key that protects this resource

sourceSnapshotId 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

sourceType ENUMERATION

The type of the image used to create this disk. The default and only value is RAW

status ENUMERATION

[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

clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

httpErrorStatusCode INTEGER

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found

id INTEGER

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

insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

name STRING

[Output Only] Name of the resource

operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

progress INTEGER

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses

region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

user STRING

[Output Only] User who requested the operation, for example: [email protected]

warnings[] OBJECT

warnings[].code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warnings[].data[] OBJECT

warnings[].data[].key STRING

[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warnings[].data[].value STRING

[Output Only] A warning data value corresponding to the key

warnings[].message STRING

[Output Only] A human-readable description of the warning code

zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations