Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / spanner_v1.projects.instances.databases.operations.html
blob: 03ce5504839fd4eb4d807b396c98e7e4ed9b40d1 [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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]175 "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.
176 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
178 # three pieces of data: error code, error message, and error details.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]179 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 # You can find out more about this error model and how to work with it in the
181 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]182 "message": "A String", # A developer-facing error message, which should be in English. Any
183 # user-facing error message should be localized and sent in the
184 # google.rpc.Status.details field, or localized by the client.
185 "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]186 "details": [ # A list of messages that carry the error details. There is a common set of
187 # message types for APIs to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]188 {
189 "a_key": "", # Properties of the object. Contains field @type with type URL.
190 },
191 ],
192 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]193 "done": True or False, # If the value is `false`, it means the operation is still in progress.
194 # If `true`, the operation is completed, and either `error` or `response` is
195 # available.
196 "response": { # The normal response of the operation in case of success. If the original
197 # method returns no data on success, such as `Delete`, the response is
198 # `google.protobuf.Empty`. If the original method is standard
199 # `Get`/`Create`/`Update`, the response should be the resource. For other
200 # methods, the response should have the type `XxxResponse`, where `Xxx`
201 # is the original method name. For example, if the original method name
202 # is `TakeSnapshot()`, the inferred response type is
203 # `TakeSnapshotResponse`.
204 "a_key": "", # Properties of the object. Contains field @type with type URL.
205 },
206 "name": "A String", # The server-assigned name, which is only unique within the same service that
207 # originally returns it. If you use the default HTTP mapping, the
208 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]209 "metadata": { # Service-specific metadata associated with the operation. It typically
210 # contains progress information and common metadata such as create time.
211 # Some services might not provide such metadata. Any method that returns a
212 # long-running operation should document the metadata type, if any.
213 "a_key": "", # Properties of the object. Contains field @type with type URL.
214 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]215 }</pre>
216</div>
217
218<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]219 <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]220 <pre>Lists operations that match the specified filter in the request. If the
221server doesn't support this method, it returns `UNIMPLEMENTED`.
222
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]223NOTE: the `name` binding allows API services to override the binding
224to use different resource name schemes, such as `users/*/operations`. To
225override the binding, API services can add a binding such as
226`"/v1/{name=users/*}/operations"` to their service configuration.
227For backwards compatibility, the default name includes the operations
228collection id, however overriding users must ensure the name binding
229is the parent resource, without the operations collection id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]230
231Args:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 name: string, The name of the operation's parent resource. (required)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]233 pageToken: string, The standard list page token.
234 x__xgafv: string, V1 error format.
235 Allowed values
236 1 - v1 error format
237 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]238 pageSize: integer, The standard list page size.
239 filter: string, The standard list filter.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]240
241Returns:
242 An object of the form:
243
244 { # The response message for Operations.ListOperations.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]245 "nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]246 "operations": [ # A list of operations that matches the specified filter in the request.
247 { # This resource represents a long-running operation that is the result of a
248 # network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249 "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.
250 # different programming environments, including REST APIs and RPC APIs. It is
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]251 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
252 # three pieces of data: error code, error message, and error details.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]253 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]254 # You can find out more about this error model and how to work with it in the
255 # [API Design Guide](https://cloud.google.com/apis/design/errors).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]256 "message": "A String", # A developer-facing error message, which should be in English. Any
257 # user-facing error message should be localized and sent in the
258 # google.rpc.Status.details field, or localized by the client.
259 "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]260 "details": [ # A list of messages that carry the error details. There is a common set of
261 # message types for APIs to use.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]262 {
263 "a_key": "", # Properties of the object. Contains field @type with type URL.
264 },
265 ],
266 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 "done": True or False, # If the value is `false`, it means the operation is still in progress.
268 # If `true`, the operation is completed, and either `error` or `response` is
269 # available.
270 "response": { # The normal response of the operation in case of success. If the original
271 # method returns no data on success, such as `Delete`, the response is
272 # `google.protobuf.Empty`. If the original method is standard
273 # `Get`/`Create`/`Update`, the response should be the resource. For other
274 # methods, the response should have the type `XxxResponse`, where `Xxx`
275 # is the original method name. For example, if the original method name
276 # is `TakeSnapshot()`, the inferred response type is
277 # `TakeSnapshotResponse`.
278 "a_key": "", # Properties of the object. Contains field @type with type URL.
279 },
280 "name": "A String", # The server-assigned name, which is only unique within the same service that
281 # originally returns it. If you use the default HTTP mapping, the
282 # `name` should be a resource name ending with `operations/{unique_id}`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]283 "metadata": { # Service-specific metadata associated with the operation. It typically
284 # contains progress information and common metadata such as create time.
285 # Some services might not provide such metadata. Any method that returns a
286 # long-running operation should document the metadata type, if any.
287 "a_key": "", # Properties of the object. Contains field @type with type URL.
288 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]289 },
290 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]291 }</pre>
292</div>
293
294<div class="method">
295 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
296 <pre>Retrieves the next page of results.
297
298Args:
299 previous_request: The request for the previous page. (required)
300 previous_response: The response from the request for the previous page. (required)
301
302Returns:
303 A request object that you can call 'execute()' on to request the next
304 page. Returns None if there are no more items in the collection.
305 </pre>
306</div>
307
308</body></html>