Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 703c92ca475a5fd3e8cc2c5b3961be0251b5480c / . / docs / dyn / compute_v1.disks.html
blob: 59ea1b2920c5565559ee487018b6aa38cd67c7f9 [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.disks.html">disks</a></h1>
<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="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="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>
<p class="toc_element">
<code><a href="#get">get(project, zone, disk)</a></code></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 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 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.
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.
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.
For example, filter=name ne example-instance.
Returns:
An object of the form:
{
"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.
"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.
"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 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.
#
# 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",
],
"users": [ # 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.
"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.
{
"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", # [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>
<div class="method">
<code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="createSnapshot">createSnapshot(project, zone, disk, body)</code>
<pre>Creates a snapshot of this disk.
Args:
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:
{ # A persistent disk snapshot resource.
"status": "A String", # [Output Only] The status of the snapshot.
"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.
"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.
"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.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"name": "A String", # Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
}
Returns:
An object of the form:
{ # An Operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] 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.
"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 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.
"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.
"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.
{
"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", # [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.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, disk)</code>
<pre>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.
Args:
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", # [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.
"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 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.
"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.
"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.
{
"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", # [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.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, disk)</code>
<pre>Returns a specified persistent disk.
Args:
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 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.
"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.
"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 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.
#
# 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",
],
"users": [ # 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.
"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 in the specified project using the data included in the request.
Args:
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 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.
"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.
"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 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.
#
# 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",
],
"users": [ # 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.
"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.
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", # [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.
"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 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.
"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.
"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.
{
"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", # [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.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"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.
}</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.
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.
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.
For example, filter=name ne example-instance.
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.
"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.
"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.
"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 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.
#
# 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",
],
"users": [ # 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.
"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.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>