Update docs for 1.4.0 release
diff --git a/docs/dyn/compute_v1.disks.html b/docs/dyn/compute_v1.disks.html
index b23f53a..aa9ddad 100644
--- a/docs/dyn/compute_v1.disks.html
+++ b/docs/dyn/compute_v1.disks.html
@@ -85,16 +85,16 @@
<p class="firstline">A description of how to use this function</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, disk)</a></code></p>
-<p class="firstline">Deletes the specified persistent disk resource.</p>
+<p class="firstline">Deletes the specified persistent disk.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, disk)</a></code></p>
-<p class="firstline">Returns the specified persistent disk resource.</p>
+<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 resource 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 included in the request.</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 disk resources contained within the specified zone.</p>
+<p class="firstline">Retrieves the 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>
@@ -104,7 +104,7 @@
<pre>Retrieves the list of disks grouped by scope.
Args:
- project: string, Name of the project scoping this request. (required)
+ project: string, Project ID for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -113,46 +113,61 @@
An object of the form:
{
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": { # A map of scoped disk lists.
- "a_key": { # Name of the scope containing this set of disks.
- "disks": [ # List of disks contained in this scope.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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.
+ { # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "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.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "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.
+ "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.
+ "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.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # 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.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "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.
+ "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.
+ "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": { # Informational warning which replaces the list of disks when the list is empty.
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "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.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
},
},
- "kind": "compute#diskAggregatedList", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "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.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>
@@ -175,9 +190,9 @@
<pre>A description of how to use this function
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to snapshot. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to snapshot. (required)
body: object, The request body. (required)
The object takes the form of:
@@ -204,36 +219,36 @@
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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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
+ "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 (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "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.
+ "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 be monotonically increasing 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.
"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 RFC 3339 format.
- "warnings": [
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "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.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "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.
+ "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.
+ "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.
@@ -242,55 +257,55 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This 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 (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, disk)</code>
- <pre>Deletes the specified persistent disk resource.
+ <pre>Deletes the specified persistent disk.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to delete. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to delete. (required)
Returns:
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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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
+ "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 (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "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.
+ "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 be monotonically increasing 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.
"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 RFC 3339 format.
- "warnings": [
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "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.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "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.
+ "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.
+ "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.
@@ -299,75 +314,105 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This 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 (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, disk)</code>
- <pre>Returns the specified persistent disk resource.
+ <pre>Returns a specified persistent disk.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
- disk: string, Name of the persistent disk resource to return. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
+ disk: string, Name of the persistent disk to return. (required)
Returns:
An object of the form:
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+ { # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "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.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "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.
+ "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.
+ "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.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # 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.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "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.
+ "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.
+ "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>
</div>
<div class="method">
<code class="details" id="insert">insert(project, zone, body, sourceImage=None)</code>
- <pre>Creates a persistent disk resource in the specified project using the data included in the request.
+ <pre>Creates a persistent disk in the specified project using the data included in the request.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
body: object, The request body. (required)
The object takes the form of:
-{ # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+{ # A Disk resource.
+ "status": "A String", # [Output Only] The status of disk creation. Applicable statuses includes: CREATING, FAILED, READY, RESTORING.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "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.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "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.
+ "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.
+ "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.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # 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.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "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.
+ "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.
+ "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.
}
sourceImage: string, Optional. Source image to restore onto a disk.
@@ -376,36 +421,36 @@
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",
- "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
+ "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
+ "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 (output only).
- "operationType": "A String",
- "httpErrorMessage": "A String",
- "progress": 42,
- "httpErrorStatusCode": 42,
+ "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.
+ "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 be monotonically increasing 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.
"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 RFC 3339 format.
- "warnings": [
+ "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.
+ "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
- "message": "A String", # Optional human-readable details for this warning.
- "code": "A String", # The warning type identifier for this warning.
- "data": [ # Metadata for this warning in 'key: value' format.
+ "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.
{
- "value": "A String", # A warning data value corresponding to the key.
- "key": "A String", # A key for the warning data.
+ "value": "A String", # [Output Only] A warning data value corresponding to the key.
+ "key": "A String", # [Output Only] A key for the warning data.
},
],
},
],
- "user": "A String",
- "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource (output only).
- "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
- "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
+ "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.
+ "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.
+ "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.
@@ -414,19 +459,19 @@
},
],
},
- "endTime": "A String",
+ "endTime": "A String", # [Output Only] The time that this operation was completed. This 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 (output only).
+ "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
}</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 disk resources contained within the specified zone.
+ <pre>Retrieves the list of persistent disks contained within the specified zone.
Args:
- project: string, Name of the project scoping this request. (required)
- zone: string, Name of the zone scoping this request. (required)
+ project: string, Project ID for this request. (required)
+ zone: string, The name of the zone for this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
@@ -434,33 +479,48 @@
Returns:
An object of the form:
- { # Contains a list of persistent disk resources.
- "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
- "items": [ # A list of Disk resources.
- { # A persistent disk resource.
- "status": "A String", # The status of disk creation (output only).
- "sourceSnapshot": "A String", # The source snapshot used to create this disk.
- "kind": "compute#disk", # Type of the resource.
+ { # A list of Disk resources.
+ "nextPageToken": "A String", # [Output Only] A token used to continue a truncated list request.
+ "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.
+ "sourceSnapshot": "A String", # The source snapshot used to create this disk. You can provide this as a partial or full URL to the resource. For example, the following are valid values:
+ # - https://www.googleapis.com/compute/v1/projects/project/global/snapshots/snapshot
+ # - projects/project/global/snapshots/snapshot
+ # - global/snapshots/snapshot
+ "kind": "compute#disk", # [Output Only] Type of the resource. Always compute#disk for disks.
"description": "A String", # An optional textual description of the resource; provided by the client when the resource is created.
- "sizeGb": "A String", # Size of the persistent disk, specified in GB. This parameter is optional when creating a disk from a disk image or a snapshot, otherwise it is required.
+ "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.
"options": "A String", # Internal use only.
- "sourceImageId": "A String", # The 'id' value of the image used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given image.
- "sourceSnapshotId": "A String", # The 'id' value of the snapshot used to create this disk. This value may be used to determine whether the disk was created from the current or a previous instance of a given disk snapshot.
- "sourceImage": "A String", # The source image used to create this disk.
- "licenses": [ # Public visible licenses.
+ "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.
+ "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.
+ "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.
+ #
+ # When creating a disk, you can provide a private (custom) image using the following input, and Compute Engine will use the corresponding image from your project. For example:
+ #
+ # global/images/my-private-image
+ #
+ # Or you can provide an image from a publicly-available project. For example, to use a Debian image from the debian-cloud project, make sure to include the project in the URL:
+ #
+ # 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.
"A String",
],
- "zone": "A String", # URL of the zone where the disk resides (output only).
- "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for the resource (output only).
- "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.
+ "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.
+ "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", # Type of resource.
- "id": "A String", # Unique identifier for the resource; defined by the server (output only).
- "selfLink": "A String", # Server defined URL for this resource (output only).
+ "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.
+ "selfLink": "A String", # [Output Only] Server defined URL for this resource.
}</pre>
</div>