Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_v1.zoneOperations.html
blob: d1a9a57d017e1d87a8b918391cd9aa2625067a5f [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.zoneOperations.html">zoneOperations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, zone, operation)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]79<p class="firstline">Deletes the specified zone-specific Operations resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#get">get(project, zone, operation)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]82<p class="firstline">Retrieves the specified zone-specific Operations resource.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]84 <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]85<p class="firstline">Retrieves a list of Operation resources contained within the specified zone.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]89<p class="toc_element">
90 <code><a href="#wait">wait(project, zone, operation)</a></code></p>
91<p class="firstline">Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, zone, operation)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]95 <pre>Deletes the specified zone-specific Operations resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96
97Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]98 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]99 zone: string, Name of the zone for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]100 operation: string, Name of the Operations resource to delete. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]101</pre>
102</div>
103
104<div class="method">
105 <code class="details" id="get">get(project, zone, operation)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]106 <pre>Retrieves the specified zone-specific Operations resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]107
108Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]109 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 zone: string, Name of the zone for this request. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]111 operation: string, Name of the Operations resource to return. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]112
113Returns:
114 An object of the form:
115
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]116 { # Represents an Operation resource.
117 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118 # Google Compute Engine has three Operation resources:
119 #
120 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
121 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]122 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
123 #
124 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]125 # - For global operations, use the `globalOperations` resource.
126 # - For regional operations, use the `regionOperations` resource.
127 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]128 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]129 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]130 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]131 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]132 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]133 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]134 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]135 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]136 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
137 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]138 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]139 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]140 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]142 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]143 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]144 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]145 "message": "A String", # [Output Only] A human-readable description of the warning code.
146 "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.
147 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
148 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]149 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]150 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]151 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]152 },
153 ],
154 },
155 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]156 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]157 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]158 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
159 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]160 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]161 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]162 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]163 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]164 "message": "A String", # [Output Only] An optional, human-readable error message.
165 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]166 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]167 },
168 ],
169 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]171 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]172 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]173 }</pre>
174</div>
175
176<div class="method">
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]177 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]178 <pre>Retrieves a list of Operation resources contained within the specified zone.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]179
180Args:
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]181 project: string, Project ID for this request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]182 zone: string, Name of the zone for request. (required)
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]183 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
184
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]185You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
Sai Cheemalapatiea3a5e12016-10-12 14:05:53 -0700[diff] [blame]186
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]187Currently, only sorting by `name` or `creationTimestamp desc` is supported.
188 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. Acceptable values are `0` to `500`, inclusive. (Default: `500`)
189 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.
190 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]191
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]192For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]193
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]195
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ```
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]197
198Returns:
199 An object of the form:
200
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]201 { # Contains a list of Operation resources.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]202 "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.
203 "kind": "compute#operationList", # [Output Only] Type of resource. Always `compute#operations` for Operations resource.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]204 "items": [ # [Output Only] A list of Operation resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 { # Represents an Operation resource.
206 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]207 # Google Compute Engine has three Operation resources:
208 #
209 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
210 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]211 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
212 #
213 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]214 # - For global operations, use the `globalOperations` resource.
215 # - For regional operations, use the `regionOperations` resource.
216 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]218 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]219 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]221 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]222 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]224 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
226 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]227 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]228 "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.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]229 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]230 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]231 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]232 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]233 {
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]234 "message": "A String", # [Output Only] A human-readable description of the warning code.
235 "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.
236 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
237 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]238 {
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]239 "value": "A String", # [Output Only] A warning data value corresponding to the key.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]240 "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).
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]241 },
242 ],
243 },
244 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]245 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]246 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]247 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
248 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Nathaniel Manista5cbe5ba2015-03-10 23:29:22 +0000[diff] [blame]250 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]251 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]252 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]253 "message": "A String", # [Output Only] An optional, human-readable error message.
254 "code": "A String", # [Output Only] The error type identifier for this error.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]255 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]256 },
257 ],
258 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]259 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]260 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]261 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]262 },
263 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]264 "warning": { # [Output Only] Informational warning message.
265 "message": "A String", # [Output Only] A human-readable description of the warning code.
266 "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.
267 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
268 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
269 {
270 "value": "A String", # [Output Only] A warning data value corresponding to the key.
271 "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).
272 },
273 ],
274 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]275 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]276 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
282 <pre>Retrieves the next page of results.
283
284Args:
285 previous_request: The request for the previous page. (required)
286 previous_response: The response from the request for the previous page. (required)
287
288Returns:
289 A request object that you can call 'execute()' on to request the next
290 page. Returns None if there are no more items in the collection.
291 </pre>
292</div>
293
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]294<div class="method">
295 <code class="details" id="wait">wait(project, zone, operation)</code>
296 <pre>Waits for the specified Operation resource to return as `DONE` or for the request to approach the 2 minute deadline, and retrieves the specified Operation resource. This method differs from the `GET` method in that it waits for no more than the default deadline (2 minutes) and then returns the current state of the operation, which might be `DONE` or still in progress.
297
298This method is called on a best-effort basis. Specifically:
299- In uncommon cases, when the server is overloaded, the request might return before the default deadline is reached, or might return after zero seconds.
300- If the default deadline is reached, there is no guarantee that the operation is actually done when the method returns. Be prepared to retry if the operation is not `DONE`.
301
302Args:
303 project: string, Project ID for this request. (required)
304 zone: string, Name of the zone for this request. (required)
305 operation: string, Name of the Operations resource to return. (required)
306
307Returns:
308 An object of the form:
309
310 { # Represents an Operation resource.
311 #
312 # Google Compute Engine has three Operation resources:
313 #
314 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
315 #
316 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
317 #
318 # Operations can be global, regional or zonal.
319 # - For global operations, use the `globalOperations` resource.
320 # - For regional operations, use the `regionOperations` resource.
321 # - For zonal operations, use the `zonalOperations` resource.
322 #
323 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
324 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
325 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
326 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
327 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
328 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
329 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
330 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
331 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
332 "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.
333 "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.
334 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
335 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
336 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
337 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
338 {
339 "message": "A String", # [Output Only] A human-readable description of the warning code.
340 "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.
341 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
342 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
343 {
344 "value": "A String", # [Output Only] A warning data value corresponding to the key.
345 "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).
346 },
347 ],
348 },
349 ],
350 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
351 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
352 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
353 "name": "A String", # [Output Only] Name of the operation.
354 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
355 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
356 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
357 {
358 "message": "A String", # [Output Only] An optional, human-readable error message.
359 "code": "A String", # [Output Only] The error type identifier for this error.
360 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
361 },
362 ],
363 },
364 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
365 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
366 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
367 }</pre>
368</div>
369
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]370</body></html>