| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.images.html">images</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(project, image)</a></code></p> |
| <p class="firstline">Deletes the specified image.</p> |
| <p class="toc_element"> |
| <code><a href="#deprecate">deprecate(project, image, body)</a></code></p> |
| <p class="firstline">Sets the deprecation status of an image.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(project, image)</a></code></p> |
| <p class="firstline">Returns the specified image. Get a list of available images by making a list() request.</p> |
| <p class="toc_element"> |
| <code><a href="#getFromFamily">getFromFamily(project, family)</a></code></p> |
| <p class="firstline">Returns the latest image that is part of an image family and is not deprecated.</p> |
| <p class="toc_element"> |
| <code><a href="#insert">insert(project, body)</a></code></p> |
| <p class="firstline">Creates an image in the specified project using the data included in the request.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p> |
| <p class="firstline">Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="delete">delete(project, image)</code> |
| <pre>Deletes the specified image. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| image: string, Name of the image resource to delete. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # An Operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "clientOperationId": "A String", # [Output Only] Reserved for future use. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| "progress": 42, # [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. |
| "httpErrorStatusCode": 42, # [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. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| "key": "A 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). |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| "name": "A String", # [Output Only] Name of the resource. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="deprecate">deprecate(project, image, body)</code> |
| <pre>Sets the deprecation status of an image. |
| |
| If an empty request body is given, clears the deprecation status instead. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| image: string, Image name. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # Deprecation status for a public resource. |
| "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED. |
| "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED. |
| "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. 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. |
| "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE. |
| "replacement": "A 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. |
| } |
| |
| |
| Returns: |
| An object of the form: |
| |
| { # An Operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "clientOperationId": "A String", # [Output Only] Reserved for future use. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| "progress": 42, # [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. |
| "httpErrorStatusCode": 42, # [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. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| "key": "A 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). |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| "name": "A String", # [Output Only] Name of the resource. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(project, image)</code> |
| <pre>Returns the specified image. Get a list of available images by making a list() request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| image: string, Name of the image resource to return. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # An Image resource. |
| "status": "A 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. |
| "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "family": "A 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. |
| "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. |
| "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED. |
| "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED. |
| "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. 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. |
| "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE. |
| "replacement": "A 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. |
| }, |
| "rawDisk": { # The parameters of the raw disk image. |
| "containerType": "A String", # 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. |
| "source": "A 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. |
| "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. |
| }, |
| "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). |
| "sourceDiskId": "A String", # 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. |
| "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). |
| "sourceDisk": "A String", # URL of the 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/disk/disk |
| # - projects/project/zones/zone/disk/disk |
| # - zones/zone/disks/disk |
| "licenses": [ # Any applicable publicly visible licenses. |
| "A String", |
| ], |
| "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "name": "A 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="getFromFamily">getFromFamily(project, family)</code> |
| <pre>Returns the latest image that is part of an image family and is not deprecated. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| family: string, Name of the image resource to return. (required) |
| |
| Returns: |
| An object of the form: |
| |
| { # An Image resource. |
| "status": "A 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. |
| "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "family": "A 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. |
| "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. |
| "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED. |
| "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED. |
| "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. 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. |
| "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE. |
| "replacement": "A 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. |
| }, |
| "rawDisk": { # The parameters of the raw disk image. |
| "containerType": "A String", # 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. |
| "source": "A 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. |
| "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. |
| }, |
| "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). |
| "sourceDiskId": "A String", # 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. |
| "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). |
| "sourceDisk": "A String", # URL of the 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/disk/disk |
| # - projects/project/zones/zone/disk/disk |
| # - zones/zone/disks/disk |
| "licenses": [ # Any applicable publicly visible licenses. |
| "A String", |
| ], |
| "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "name": "A 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. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="insert">insert(project, body)</code> |
| <pre>Creates an image in the specified project using the data included in the request. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| body: object, The request body. (required) |
| The object takes the form of: |
| |
| { # An Image resource. |
| "status": "A 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. |
| "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "family": "A 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. |
| "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. |
| "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED. |
| "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED. |
| "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. 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. |
| "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE. |
| "replacement": "A 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. |
| }, |
| "rawDisk": { # The parameters of the raw disk image. |
| "containerType": "A String", # 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. |
| "source": "A 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. |
| "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. |
| }, |
| "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). |
| "sourceDiskId": "A String", # 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. |
| "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). |
| "sourceDisk": "A String", # URL of the 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/disk/disk |
| # - projects/project/zones/zone/disk/disk |
| # - zones/zone/disks/disk |
| "licenses": [ # Any applicable publicly visible licenses. |
| "A String", |
| ], |
| "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "name": "A 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: |
| An object of the form: |
| |
| { # An Operation resource, used to manage asynchronous API requests. |
| "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| "clientOperationId": "A String", # [Output Only] Reserved for future use. |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. |
| "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. |
| "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. |
| "progress": 42, # [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. |
| "httpErrorStatusCode": 42, # [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. |
| "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. |
| "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| { |
| "message": "A String", # [Output Only] A human-readable description of the warning code. |
| "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. |
| "data": [ # [Output Only] Metadata about this warning in key: value format. For example: |
| # "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| { |
| "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| "key": "A 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). |
| }, |
| ], |
| }, |
| ], |
| "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. |
| "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. |
| "name": "A String", # [Output Only] Name of the resource. |
| "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. |
| "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| { |
| "message": "A String", # [Output Only] An optional, human-readable error message. |
| "code": "A String", # [Output Only] The error type identifier for this error. |
| "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| }, |
| ], |
| }, |
| "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code> |
| <pre>Retrieves the list of private images available to the specified project. Private images are images you create that belong to your project. This method does not get any images that belong to other projects, including publicly-available images, like Debian 7. If you want to get a list of publicly-available images, use this method to make a request to the respective image project, such as debian-cloud or windows-cloud. |
| |
| See Accessing images for more information. |
| |
| Args: |
| project: string, Project ID for this request. (required) |
| maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. |
| pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results. |
| filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. |
| |
| The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. |
| |
| For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. |
| |
| Compute Engine Beta API Only: When filtering in the Beta API, you can also filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. |
| |
| The Beta API also supports filtering on multiple expressions by providing each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. |
| |
| Returns: |
| An object of the form: |
| |
| { # Contains a list of images. |
| "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. |
| "items": [ # [Output Only] A list of Image resources. |
| { # An Image resource. |
| "status": "A 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. |
| "kind": "compute#image", # [Output Only] Type of the resource. Always compute#image for images. |
| "description": "A String", # An optional description of this resource. Provide this property when you create the resource. |
| "family": "A 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. |
| "deprecated": { # Deprecation status for a public resource. # The deprecation status associated with this image. |
| "deleted": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DELETED. |
| "deprecated": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to DEPRECATED. |
| "state": "A String", # The deprecation state of this resource. This can be DEPRECATED, OBSOLETE, or DELETED. 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. |
| "obsolete": "A String", # An optional RFC3339 timestamp on or after which the deprecation state of this resource will be changed to OBSOLETE. |
| "replacement": "A 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. |
| }, |
| "rawDisk": { # The parameters of the raw disk image. |
| "containerType": "A String", # 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. |
| "source": "A 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. |
| "sha1Checksum": "A String", # An optional SHA1 checksum of the disk image before unpackaging; provided by the client when the disk image is created. |
| }, |
| "archiveSizeBytes": "A String", # Size of the image tar.gz archive stored in Google Cloud Storage (in bytes). |
| "sourceDiskId": "A String", # 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. |
| "diskSizeGb": "A String", # Size of the image when restored onto a persistent disk (in GB). |
| "sourceDisk": "A String", # URL of the 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/disk/disk |
| # - projects/project/zones/zone/disk/disk |
| # - zones/zone/disks/disk |
| "licenses": [ # Any applicable publicly visible licenses. |
| "A String", |
| ], |
| "sourceType": "RAW", # The type of the image used to create this disk. The default and only value is RAW |
| "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| "name": "A 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. |
| }, |
| ], |
| "kind": "compute#imageList", # Type of resource. |
| "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |