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.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"> 87 <code><a href="#list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p> 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 }, 181 "done": True or False, # If the value is `false`, it means the operation is still in progress. 182 # If true, the operation is completed, and either `error` or `response` is 183 # available. 184 "response": { # The normal response of the operation in case of success. If the original 185 # method returns no data on success, such as `Delete`, the response is 186 # `google.protobuf.Empty`. If the original method is standard 187 # `Get`/`Create`/`Update`, the response should be the resource. For other 188 # methods, the response should have the type `XxxResponse`, where `Xxx` 189 # is the original method name. For example, if the original method name 190 # is `TakeSnapshot()`, the inferred response type is 191 # `TakeSnapshotResponse`. 192 "a_key": "", # Properties of the object. Contains field @type with type URL. 193 }, 194 "name": "A String", # The server-assigned name, which is only unique within the same service that 195 # originally returns it. If you use the default HTTP mapping, the 196 # `name` should have the format of `operations/some/unique/name`. 197 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. 198 # programming environments, including REST APIs and RPC APIs. It is used by 199 # [gRPC](https://github.com/grpc). The error model is designed to be: 200 # 201 # - Simple to use and understand for most users 202 # - Flexible enough to meet unexpected needs 203 # 204 # # Overview 205 # 206 # The `Status` message contains three pieces of data: error code, error message, 207 # and error details. The error code should be an enum value of 208 # google.rpc.Code, but it may accept additional error codes if needed. The 209 # error message should be a developer-facing English message that helps 210 # developers *understand* and *resolve* the error. If a localized user-facing 211 # error message is needed, put the localized message in the error details or 212 # localize it in the client. The optional error details may contain arbitrary 213 # information about the error. There is a predefined set of error detail types 214 # in the package `google.rpc` which can be used for common error conditions. 215 # 216 # # Language mapping 217 # 218 # The `Status` message is the logical representation of the error model, but it 219 # is not necessarily the actual wire format. When the `Status` message is 220 # exposed in different client libraries and different wire protocols, it can be 221 # mapped differently. For example, it will likely be mapped to some exceptions 222 # in Java, but more likely mapped to some error codes in C. 223 # 224 # # Other uses 225 # 226 # The error model and the `Status` message can be used in a variety of 227 # environments, either with or without APIs, to provide a 228 # consistent developer experience across different environments. 229 # 230 # Example uses of this error model include: 231 # 232 # - Partial errors. If a service needs to return partial errors to the client, 233 # it may embed the `Status` in the normal response to indicate the partial 234 # errors. 235 # 236 # - Workflow errors. A typical workflow has multiple steps. Each step may 237 # have a `Status` message for error reporting purpose. 238 # 239 # - Batch operations. If a client uses batch request and batch response, the 240 # `Status` message should be used directly inside batch response, one for 241 # each error sub-response. 242 # 243 # - Asynchronous operations. If an API call embeds asynchronous operation 244 # results in its response, the status of those operations should be 245 # represented directly using the `Status` message. 246 # 247 # - Logging. If some API errors are stored in logs, the message `Status` could 248 # be used directly after any stripping needed for security/privacy reasons. 249 "message": "A String", # A developer-facing error message, which should be in English. Any 250 # user-facing error message should be localized and sent in the 251 # google.rpc.Status.details field, or localized by the client. 252 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 253 "details": [ # A list of messages that carry the error details. There will be a 254 # common set of message types for APIs to use. 255 { 256 "a_key": "", # Properties of the object. Contains field @type with type URL. 257 }, 258 ], 259 }, 260 }</pre> 261</div> 262 263<div class="method"> 264 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> 265 <pre>Lists operations that match the specified filter in the request. If the 266server doesn't support this method, it returns `UNIMPLEMENTED`. 267 268NOTE: the `name` binding below allows API services to override the binding 269to use different resource name schemes, such as `users/*/operations`. 270 271Args: 272 name: string, The name of the operation collection. (required) 273 pageSize: integer, The standard list page size. 274 filter: string, The standard list filter. 275 pageToken: string, The standard list page token. 276 x__xgafv: string, V1 error format. 277 Allowed values 278 1 - v1 error format 279 2 - v2 error format 280 281Returns: 282 An object of the form: 283 284 { # The response message for Operations.ListOperations. 285 "operations": [ # A list of operations that matches the specified filter in the request. 286 { # This resource represents a long-running operation that is the result of a 287 # network API call. 288 "metadata": { # Service-specific metadata associated with the operation. It typically 289 # contains progress information and common metadata such as create time. 290 # Some services might not provide such metadata. Any method that returns a 291 # long-running operation should document the metadata type, if any. 292 "a_key": "", # Properties of the object. Contains field @type with type URL. 293 }, 294 "done": True or False, # If the value is `false`, it means the operation is still in progress. 295 # If true, the operation is completed, and either `error` or `response` is 296 # available. 297 "response": { # The normal response of the operation in case of success. If the original 298 # method returns no data on success, such as `Delete`, the response is 299 # `google.protobuf.Empty`. If the original method is standard 300 # `Get`/`Create`/`Update`, the response should be the resource. For other 301 # methods, the response should have the type `XxxResponse`, where `Xxx` 302 # is the original method name. For example, if the original method name 303 # is `TakeSnapshot()`, the inferred response type is 304 # `TakeSnapshotResponse`. 305 "a_key": "", # Properties of the object. Contains field @type with type URL. 306 }, 307 "name": "A String", # The server-assigned name, which is only unique within the same service that 308 # originally returns it. If you use the default HTTP mapping, the 309 # `name` should have the format of `operations/some/unique/name`. 310 "error": { # The `Status` type defines a logical error model that is suitable for different # The error result of the operation in case of failure or cancellation. 311 # programming environments, including REST APIs and RPC APIs. It is used by 312 # [gRPC](https://github.com/grpc). The error model is designed to be: 313 # 314 # - Simple to use and understand for most users 315 # - Flexible enough to meet unexpected needs 316 # 317 # # Overview 318 # 319 # The `Status` message contains three pieces of data: error code, error message, 320 # and error details. The error code should be an enum value of 321 # google.rpc.Code, but it may accept additional error codes if needed. The 322 # error message should be a developer-facing English message that helps 323 # developers *understand* and *resolve* the error. If a localized user-facing 324 # error message is needed, put the localized message in the error details or 325 # localize it in the client. The optional error details may contain arbitrary 326 # information about the error. There is a predefined set of error detail types 327 # in the package `google.rpc` which can be used for common error conditions. 328 # 329 # # Language mapping 330 # 331 # The `Status` message is the logical representation of the error model, but it 332 # is not necessarily the actual wire format. When the `Status` message is 333 # exposed in different client libraries and different wire protocols, it can be 334 # mapped differently. For example, it will likely be mapped to some exceptions 335 # in Java, but more likely mapped to some error codes in C. 336 # 337 # # Other uses 338 # 339 # The error model and the `Status` message can be used in a variety of 340 # environments, either with or without APIs, to provide a 341 # consistent developer experience across different environments. 342 # 343 # Example uses of this error model include: 344 # 345 # - Partial errors. If a service needs to return partial errors to the client, 346 # it may embed the `Status` in the normal response to indicate the partial 347 # errors. 348 # 349 # - Workflow errors. A typical workflow has multiple steps. Each step may 350 # have a `Status` message for error reporting purpose. 351 # 352 # - Batch operations. If a client uses batch request and batch response, the 353 # `Status` message should be used directly inside batch response, one for 354 # each error sub-response. 355 # 356 # - Asynchronous operations. If an API call embeds asynchronous operation 357 # results in its response, the status of those operations should be 358 # represented directly using the `Status` message. 359 # 360 # - Logging. If some API errors are stored in logs, the message `Status` could 361 # be used directly after any stripping needed for security/privacy reasons. 362 "message": "A String", # A developer-facing error message, which should be in English. Any 363 # user-facing error message should be localized and sent in the 364 # google.rpc.Status.details field, or localized by the client. 365 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 366 "details": [ # A list of messages that carry the error details. There will be a 367 # common set of message types for APIs to use. 368 { 369 "a_key": "", # Properties of the object. Contains field @type with type URL. 370 }, 371 ], 372 }, 373 }, 374 ], 375 "nextPageToken": "A String", # The standard List next-page token. 376 }</pre> 377</div> 378 379<div class="method"> 380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 381 <pre>Retrieves the next page of results. 382 383Args: 384 previous_request: The request for the previous page. (required) 385 previous_response: The response from the request for the previous page. (required) 386 387Returns: 388 A request object that you can call 'execute()' on to request the next 389 page. Returns None if there are no more items in the collection. 390 </pre> 391</div> 392 393</body></html>