Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 715bd7f9ca9a324a05ee05a6476af383e54930f9 / . / docs / dyn / spanner_v1.projects.instances.databases.operations.html
blob: 6a97795c63e6e9bcd4d5e44444f5039148c8205b [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -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="spanner_v1.html">Cloud Spanner API</a> . <a href="spanner_v1.projects.html">projects</a> . <a href="spanner_v1.projects.instances.html">instances</a> . <a href="spanner_v1.projects.instances.databases.html">databases</a> . <a href="spanner_v1.projects.instances.databases.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#cancel">cancel(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Starts asynchronous cancellation on a long-running operation. The server</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a long-running operation. This method indicates that the client is</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets the latest state of a long-running operation. Clients can use this</p>
86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]87 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]88<p class="firstline">Lists operations that match the specified filter in the request. If the</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code>
95 <pre>Starts asynchronous cancellation on a long-running operation. The server
96makes a best effort to cancel the operation, but success is not
97guaranteed. If the server doesn't support this method, it returns
98`google.rpc.Code.UNIMPLEMENTED`. Clients can use
99Operations.GetOperation or
100other methods to check whether the cancellation succeeded or whether the
101operation completed despite cancellation. On successful cancellation,
102the operation is not deleted; instead, it becomes an operation with
103an Operation.error value with a google.rpc.Status.code of 1,
104corresponding to `Code.CANCELLED`.
105
106Args:
107 name: string, The name of the operation resource to be cancelled. (required)
108 x__xgafv: string, V1 error format.
109 Allowed values
110 1 - v1 error format
111 2 - v2 error format
112
113Returns:
114 An object of the form:
115
116 { # A generic empty message that you can re-use to avoid defining duplicated
117 # empty messages in your APIs. A typical example is to use it as the request
118 # or the response type of an API method. For instance:
119 #
120 # service Foo {
121 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
122 # }
123 #
124 # The JSON representation for `Empty` is empty JSON object `{}`.
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
130 <pre>Deletes a long-running operation. This method indicates that the client is
131no longer interested in the operation result. It does not cancel the
132operation. If the server doesn't support this method, it returns
133`google.rpc.Code.UNIMPLEMENTED`.
134
135Args:
136 name: string, The name of the operation resource to be deleted. (required)
137 x__xgafv: string, V1 error format.
138 Allowed values
139 1 - v1 error format
140 2 - v2 error format
141
142Returns:
143 An object of the form:
144
145 { # A generic empty message that you can re-use to avoid defining duplicated
146 # empty messages in your APIs. A typical example is to use it as the request
147 # or the response type of an API method. For instance:
148 #
149 # service Foo {
150 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
151 # }
152 #
153 # The JSON representation for `Empty` is empty JSON object `{}`.
154 }</pre>
155</div>
156
157<div class="method">
158 <code class="details" id="get">get(name, x__xgafv=None)</code>
159 <pre>Gets the latest state of a long-running operation. Clients can use this
160method to poll the operation result at intervals as recommended by the API
161service.
162
163Args:
164 name: string, The name of the operation resource. (required)
165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
173 { # This resource represents a long-running operation that is the result of a
174 # network API call.
175 "metadata": { # Service-specific metadata associated with the operation. It typically
176 # contains progress information and common metadata such as create time.
177 # Some services might not provide such metadata. Any method that returns a
178 # long-running operation should document the metadata type, if any.
179 "a_key": "", # Properties of the object. Contains field @type with type URL.
180 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]181 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
182 # different programming environments, including REST APIs and RPC APIs. It is
183 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]184 #
185 # - Simple to use and understand for most users
186 # - Flexible enough to meet unexpected needs
187 #
188 # # Overview
189 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]190 # The `Status` message contains three pieces of data: error code, error
191 # message, and error details. The error code should be an enum value of
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]192 # google.rpc.Code, but it may accept additional error codes if needed. The
193 # error message should be a developer-facing English message that helps
194 # developers *understand* and *resolve* the error. If a localized user-facing
195 # error message is needed, put the localized message in the error details or
196 # localize it in the client. The optional error details may contain arbitrary
197 # information about the error. There is a predefined set of error detail types
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]198 # in the package `google.rpc` that can be used for common error conditions.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]199 #
200 # # Language mapping
201 #
202 # The `Status` message is the logical representation of the error model, but it
203 # is not necessarily the actual wire format. When the `Status` message is
204 # exposed in different client libraries and different wire protocols, it can be
205 # mapped differently. For example, it will likely be mapped to some exceptions
206 # in Java, but more likely mapped to some error codes in C.
207 #
208 # # Other uses
209 #
210 # The error model and the `Status` message can be used in a variety of
211 # environments, either with or without APIs, to provide a
212 # consistent developer experience across different environments.
213 #
214 # Example uses of this error model include:
215 #
216 # - Partial errors. If a service needs to return partial errors to the client,
217 # it may embed the `Status` in the normal response to indicate the partial
218 # errors.
219 #
220 # - Workflow errors. A typical workflow has multiple steps. Each step may
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]221 # have a `Status` message for error reporting.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]222 #
223 # - Batch operations. If a client uses batch request and batch response, the
224 # `Status` message should be used directly inside batch response, one for
225 # each error sub-response.
226 #
227 # - Asynchronous operations. If an API call embeds asynchronous operation
228 # results in its response, the status of those operations should be
229 # represented directly using the `Status` message.
230 #
231 # - Logging. If some API errors are stored in logs, the message `Status` could
232 # be used directly after any stripping needed for security/privacy reasons.
233 "message": "A String", # A developer-facing error message, which should be in English. Any
234 # user-facing error message should be localized and sent in the
235 # google.rpc.Status.details field, or localized by the client.
236 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]237 "details": [ # A list of messages that carry the error details. There is a common set of
238 # message types for APIs to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]239 {
240 "a_key": "", # Properties of the object. Contains field @type with type URL.
241 },
242 ],
243 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]244 "done": True or False, # If the value is `false`, it means the operation is still in progress.
245 # If `true`, the operation is completed, and either `error` or `response` is
246 # available.
247 "response": { # The normal response of the operation in case of success. If the original
248 # method returns no data on success, such as `Delete`, the response is
249 # `google.protobuf.Empty`. If the original method is standard
250 # `Get`/`Create`/`Update`, the response should be the resource. For other
251 # methods, the response should have the type `XxxResponse`, where `Xxx`
252 # is the original method name. For example, if the original method name
253 # is `TakeSnapshot()`, the inferred response type is
254 # `TakeSnapshotResponse`.
255 "a_key": "", # Properties of the object. Contains field @type with type URL.
256 },
257 "name": "A String", # The server-assigned name, which is only unique within the same service that
258 # originally returns it. If you use the default HTTP mapping, the
259 # `name` should be a resource name ending with `operations/{unique_id}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]260 }</pre>
261</div>
262
263<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]264 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]265 <pre>Lists operations that match the specified filter in the request. If the
266server doesn't support this method, it returns `UNIMPLEMENTED`.
267
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]268NOTE: the `name` binding allows API services to override the binding
269to use different resource name schemes, such as `users/*/operations`. To
270override the binding, API services can add a binding such as
271`"/v1/{name=users/*}/operations"` to their service configuration.
272For backwards compatibility, the default name includes the operations
273collection id, however overriding users must ensure the name binding
274is the parent resource, without the operations collection id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]275
276Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]277 name: string, The name of the operation's parent resource. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]278 pageToken: string, The standard list page token.
279 x__xgafv: string, V1 error format.
280 Allowed values
281 1 - v1 error format
282 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]283 pageSize: integer, The standard list page size.
284 filter: string, The standard list filter.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]285
286Returns:
287 An object of the form:
288
289 { # The response message for Operations.ListOperations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]290 "operations": [ # A list of operations that matches the specified filter in the request.
291 { # This resource represents a long-running operation that is the result of a
292 # network API call.
293 "metadata": { # Service-specific metadata associated with the operation. It typically
294 # contains progress information and common metadata such as create time.
295 # Some services might not provide such metadata. Any method that returns a
296 # long-running operation should document the metadata type, if any.
297 "a_key": "", # Properties of the object. Contains field @type with type URL.
298 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]299 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
300 # different programming environments, including REST APIs and RPC APIs. It is
301 # used by [gRPC](https://github.com/grpc). The error model is designed to be:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]302 #
303 # - Simple to use and understand for most users
304 # - Flexible enough to meet unexpected needs
305 #
306 # # Overview
307 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]308 # The `Status` message contains three pieces of data: error code, error
309 # message, and error details. The error code should be an enum value of
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]310 # google.rpc.Code, but it may accept additional error codes if needed. The
311 # error message should be a developer-facing English message that helps
312 # developers *understand* and *resolve* the error. If a localized user-facing
313 # error message is needed, put the localized message in the error details or
314 # localize it in the client. The optional error details may contain arbitrary
315 # information about the error. There is a predefined set of error detail types
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]316 # in the package `google.rpc` that can be used for common error conditions.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]317 #
318 # # Language mapping
319 #
320 # The `Status` message is the logical representation of the error model, but it
321 # is not necessarily the actual wire format. When the `Status` message is
322 # exposed in different client libraries and different wire protocols, it can be
323 # mapped differently. For example, it will likely be mapped to some exceptions
324 # in Java, but more likely mapped to some error codes in C.
325 #
326 # # Other uses
327 #
328 # The error model and the `Status` message can be used in a variety of
329 # environments, either with or without APIs, to provide a
330 # consistent developer experience across different environments.
331 #
332 # Example uses of this error model include:
333 #
334 # - Partial errors. If a service needs to return partial errors to the client,
335 # it may embed the `Status` in the normal response to indicate the partial
336 # errors.
337 #
338 # - Workflow errors. A typical workflow has multiple steps. Each step may
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]339 # have a `Status` message for error reporting.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]340 #
341 # - Batch operations. If a client uses batch request and batch response, the
342 # `Status` message should be used directly inside batch response, one for
343 # each error sub-response.
344 #
345 # - Asynchronous operations. If an API call embeds asynchronous operation
346 # results in its response, the status of those operations should be
347 # represented directly using the `Status` message.
348 #
349 # - Logging. If some API errors are stored in logs, the message `Status` could
350 # be used directly after any stripping needed for security/privacy reasons.
351 "message": "A String", # A developer-facing error message, which should be in English. Any
352 # user-facing error message should be localized and sent in the
353 # google.rpc.Status.details field, or localized by the client.
354 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]355 "details": [ # A list of messages that carry the error details. There is a common set of
356 # message types for APIs to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]357 {
358 "a_key": "", # Properties of the object. Contains field @type with type URL.
359 },
360 ],
361 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame^]362 "done": True or False, # If the value is `false`, it means the operation is still in progress.
363 # If `true`, the operation is completed, and either `error` or `response` is
364 # available.
365 "response": { # The normal response of the operation in case of success. If the original
366 # method returns no data on success, such as `Delete`, the response is
367 # `google.protobuf.Empty`. If the original method is standard
368 # `Get`/`Create`/`Update`, the response should be the resource. For other
369 # methods, the response should have the type `XxxResponse`, where `Xxx`
370 # is the original method name. For example, if the original method name
371 # is `TakeSnapshot()`, the inferred response type is
372 # `TakeSnapshotResponse`.
373 "a_key": "", # Properties of the object. Contains field @type with type URL.
374 },
375 "name": "A String", # The server-assigned name, which is only unique within the same service that
376 # originally returns it. If you use the default HTTP mapping, the
377 # `name` should be a resource name ending with `operations/{unique_id}`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]378 },
379 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]380 "nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]381 }</pre>
382</div>
383
384<div class="method">
385 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
386 <pre>Retrieves the next page of results.
387
388Args:
389 previous_request: The request for the previous page. (required)
390 previous_response: The response from the request for the previous page. (required)
391
392Returns:
393 A request object that you can call 'execute()' on to request the next
394 page. Returns None if there are no more items in the collection.
395 </pre>
396</div>
397
398</body></html>