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