Updated docs
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index 59ea1b2..158f79c 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -76,13 +76,13 @@
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Retrieves the list of disks grouped by scope.</p>
+<p class="firstline">Retrieves an aggregated list of persistent disks.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#createSnapshot">createSnapshot(project, zone, disk, body)</a></code></p>
-<p class="firstline">Creates a snapshot of this disk.</p>
+<p class="firstline">Creates a snapshot of a specified persistent disk.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, disk)</a></code></p>
<p class="firstline">Deletes the specified persistent disk. Deleting a disk removes its data permanently and is irreversible. However, deleting a disk does not delete any snapshots previously made from the disk. You must separately delete snapshots.</p>
@@ -91,33 +91,37 @@
<p class="firstline">Returns a specified persistent disk.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, zone, body, sourceImage=None)</a></code></p>
-<p class="firstline">Creates a persistent disk in the specified project using the data included in the request.</p>
+<p class="firstline">Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 200 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.</p>
<p class="toc_element">
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
-<p class="firstline">Retrieves the list of persistent disks contained within the specified zone.</p>
+<p class="firstline">Retrieves a list of persistent disks contained within the specified zone.</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="aggregatedList">aggregatedList(project, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves the list of disks grouped by scope.
+ <pre>Retrieves an aggregated list of persistent disks.
Args:
project: string, Project ID for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
- 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.
+ 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 (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.
+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, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use 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. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter 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:
{
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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 map of scoped disk lists.
"a_key": { # [Output Only] Name of the scope containing this set of disks.
"disks": [ # [Output Only] List of disks contained in this scope.
@@ -129,13 +133,13 @@
# - global/snapshots/snapshot
"kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
#
# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
- "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
@@ -149,33 +153,42 @@
# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
#
# where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
- "licenses": [ # Any applicable publicly visible licenses.
+ #
+ # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example:
+ #
+ # global/images/family/my-private-family
+ #
+ # Or you can specify an image family from a publicly-available project. For example, to use the latest Debian 7 from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/family/debian-7
+ "licenses": [ # [Output Only] Any applicable publicly visible licenses.
"A String",
],
- "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
"A String",
],
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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 fully-qualified URL for this 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.
},
],
"warning": { # [Output Only] Informational warning which replaces the list of disks when the list is empty.
- "message": "A String", # [Output Only] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
+ "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 for the warning data.
+ "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).
},
],
},
},
},
"kind": "compute#diskAggregatedList", # [Output Only] Type of resource. Always compute#diskAggregatedList for aggregated lists of persistent disks.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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>
@@ -196,7 +209,7 @@
<div class="method">
<code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body)</code>
- <pre>Creates a snapshot of this disk.
+ <pre>Creates a snapshot of a specified persistent disk.
Args:
project: string, Project ID for this request. (required)
@@ -206,19 +219,19 @@
The object takes the form of:
{ # A persistent disk snapshot resource.
- "status": "A String", # [Output Only] The status of the snapshot.
+ "status": "A String", # [Output Only] The status of the snapshot. This can be CREATING, DELETING, FAILED, READY, or UPLOADING.
"kind": "compute#snapshot", # [Output Only] Type of the resource. Always compute#snapshot for Snapshot resources.
"storageBytes": "A String", # [Output Only] A size of the the storage used by the snapshot. As snapshots share storage, this number is expected to change with snapshot creation/deletion.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sourceDisk": "A String", # The source disk used to create this snapshot.
- "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
+ "sourceDisk": "A String", # [Output Only] The source disk used to create this snapshot.
+ "storageBytesStatus": "A String", # [Output Only] An indicator whether storageBytes is in a stable state or it is being adjusted as a result of shared storage reallocation. This status can either be UPDATING, meaning the size of the snapshot is being updated, or UP_TO_DATE, meaning the size of the snapshot is up-to-date.
"sourceDiskId": "A String", # [Output Only] The ID value of the disk used to create this snapshot. This value may be used to determine whether the snapshot was taken from the current or a previous instance of a given disk name.
"diskSizeGb": "A String", # [Output Only] Size of the snapshot, specified in GB.
- "licenses": [ # Public visible licenses.
+ "licenses": [ # [Output Only] A list of public visible licenses that apply to this snapshot. This can be because the original image had licenses attached (such as a Windows image).
"A String",
],
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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.
}
@@ -228,35 +241,37 @@
An object of the form:
{ # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+ "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] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "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 at 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 message that was returned, such as 404.
+ "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] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "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] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -266,9 +281,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -285,35 +300,37 @@
An object of the form:
{ # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+ "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] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "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 at 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 message that was returned, such as 404.
+ "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] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "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] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -323,9 +340,9 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies.
}</pre>
</div>
@@ -349,13 +366,13 @@
# - global/snapshots/snapshot
"kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
#
# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
- "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
@@ -369,15 +386,23 @@
# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
#
# where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
- "licenses": [ # Any applicable publicly visible licenses.
+ #
+ # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example:
+ #
+ # global/images/family/my-private-family
+ #
+ # Or you can specify an image family from a publicly-available project. For example, to use the latest Debian 7 from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/family/debian-7
+ "licenses": [ # [Output Only] Any applicable publicly visible licenses.
"A String",
],
- "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
"A String",
],
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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 fully-qualified URL for this 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>
@@ -385,7 +410,7 @@
<div class="method">
<code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
- <pre>Creates a persistent disk in the specified project using the data included in the request.
+ <pre>Creates a persistent disk in the specified project using the data in the request. You can create a disk with a sourceImage, a sourceSnapshot, or create an empty 200 GB data disk by omitting all properties. You can also create a disk that is larger than the default size by specifying the sizeGb property.
Args:
project: string, Project ID for this request. (required)
@@ -401,13 +426,13 @@
# - global/snapshots/snapshot
"kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
#
# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
- "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
@@ -421,15 +446,23 @@
# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
#
# where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
- "licenses": [ # Any applicable publicly visible licenses.
+ #
+ # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example:
+ #
+ # global/images/family/my-private-family
+ #
+ # Or you can specify an image family from a publicly-available project. For example, to use the latest Debian 7 from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/family/debian-7
+ "licenses": [ # [Output Only] Any applicable publicly visible licenses.
"A String",
],
- "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
"A String",
],
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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 fully-qualified URL for this 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.
}
@@ -440,35 +473,37 @@
An object of the form:
{ # An Operation resource, used to manage asynchronous API requests.
- "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
- "clientOperationId": "A String", # [Output Only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all Operation resources in the project.
+ "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] Unique identifier for the resource; defined by the server.
- "zone": "A String", # [Output Only] URL of the zone where the operation resides.
- "operationType": "A String", # [Output Only] Type of the operation, such as insert, update, and delete.
+ "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 at 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 message that was returned, such as 404.
+ "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] Status of the operation. Can be one of the following: PENDING, RUNNING, or DONE.
- "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC3339 text format.
+ "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] Optional human-readable details for this warning.
- "code": "A String", # [Output Only] The warning type identifier for this warning.
- "data": [ # [Output Only] Metadata for this warning in key: value format.
+ "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 for the warning data.
+ "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 is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#Operation for Operation resources.
+ "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] URL of the region where the operation resides. Only applicable for regional resources.
+ "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.
{
@@ -478,32 +513,36 @@
},
],
},
- "endTime": "A String", # [Output Only] The time that this operation was completed. This is in RFC3339 text format.
+ "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] URL of the resource the operation is mutating.
+ "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, zone, maxResults=None, pageToken=None, filter=None)</code>
- <pre>Retrieves the list of persistent disks contained within the specified zone.
+ <pre>Retrieves a list of persistent disks contained within the specified zone.
Args:
project: string, Project ID for this request. (required)
zone: string, The name of the zone for this request. (required)
- maxResults: integer, Maximum count of results to be returned.
- pageToken: string, Specifies a page token to use. Use this parameter if you want to list the next page of results. Set pageToken to the nextPageToken returned by a previous list request.
- 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.
+ 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 (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.
+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, filter=name ne example-instance.
+For example, to filter for instances whose name is not equal to example-instance, you would use filter=name ne example-instance.
+
+Compute Engine Beta API Only: If you use 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. In particular, use filtering on nested fields to take advantage of instance labels to organize and filter 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:
{ # A list of Disk resources.
- "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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 persistent disks.
{ # A Disk resource.
"status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
@@ -513,13 +552,13 @@
# - global/snapshots/snapshot
"kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"lastDetachTimestamp": "A String", # [Output Only] Last detach timestamp in RFC3339 text format.
- "description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
+ "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"sizeGb": "A String", # Size of the persistent disk, specified in GB. You can specify this field when creating a persistent disk using the sourceImage or sourceSnapshot parameter, or specify it alone to create an empty persistent disk.
#
# If you specify this field along with sourceImage or sourceSnapshot, the value of sizeGb must not be less than the size of the sourceImage or the size of the snapshot.
- "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
+ "type": "A String", # URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
+ "sourceImageId": "A String", # [Output Only] The ID value of the image used to create this disk. This value identifies the exact image that was used to create this persistent disk. For example, if you created the persistent disk from an image that was later deleted and recreated under the same name, the source image ID would identify the exact version of the image that was used.
"sourceSnapshotId": "A String", # [Output Only] The unique ID of the snapshot used to create this disk. This value identifies the exact snapshot that was used to create this persistent disk. For example, if you created the persistent disk from a snapshot that was later deleted and recreated under the same name, the source snapshot ID would identify the exact version of the snapshot that was used.
"lastAttachTimestamp": "A String", # [Output Only] Last attach timestamp in RFC3339 text format.
"sourceImage": "A String", # The source image used to create this disk. If the source image is deleted from the system, this field will not be set, even if an image with the same name has been re-created.
@@ -533,21 +572,29 @@
# projects/debian-cloud/global/images/debian-7-wheezy-vYYYYMMDD
#
# where vYYYYMMDD is the image version. The fully-qualified URL will also work in both cases.
- "licenses": [ # Any applicable publicly visible licenses.
+ #
+ # You can also specify the latest image for a private image family by replacing the image name suffix with family/family-name. For example:
+ #
+ # global/images/family/my-private-family
+ #
+ # Or you can specify an image family from a publicly-available project. For example, to use the latest Debian 7 from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # projects/debian-cloud/global/images/family/debian-7
+ "licenses": [ # [Output Only] Any applicable publicly visible licenses.
"A String",
],
- "users": [ # Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
+ "users": [ # [Output Only] Links to the users of the disk (attached instances) in form: project/zones/zone/instances/instance
"A String",
],
"zone": "A String", # [Output Only] URL of the zone where the disk resides.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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 fully-qualified URL for this 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#diskList", # [Output Only] Type of resource. Always compute#diskList for lists of disks.
- "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+ "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>