1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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="storagetransfer_v1.html">Google Storage Transfer API</a> . <a href="storagetransfer_v1.transferOperations.html">transferOperations</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">Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82 <p class="firstline">This method is not supported and the server returns `UNIMPLEMENTED`.</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 <p class="toc_element"> 93 <code><a href="#pause">pause(name, body, x__xgafv=None)</a></code></p> 94 <p class="firstline">Pauses a transfer operation.</p> 95 <p class="toc_element"> 96 <code><a href="#resume">resume(name, body, x__xgafv=None)</a></code></p> 97 <p class="firstline">Resumes a transfer operation that is paused.</p> 98 <h3>Method Details</h3> 99 <div class="method"> 100 <code class="details" id="cancel">cancel(name, x__xgafv=None)</code> 101 <pre>Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation. 102 103 Args: 104 name: string, The name of the operation resource to be cancelled. (required) 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110 Returns: 111 An object of the form: 112 113 { # A generic empty message that you can re-use to avoid defining duplicated 114 # empty messages in your APIs. A typical example is to use it as the request 115 # or the response type of an API method. For instance: 116 # 117 # service Foo { 118 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 119 # } 120 # 121 # The JSON representation for `Empty` is empty JSON object `{}`. 122 }</pre> 123 </div> 124 125 <div class="method"> 126 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 127 <pre>This method is not supported and the server returns `UNIMPLEMENTED`. 128 129 Args: 130 name: string, The name of the operation resource to be deleted. (required) 131 x__xgafv: string, V1 error format. 132 Allowed values 133 1 - v1 error format 134 2 - v2 error format 135 136 Returns: 137 An object of the form: 138 139 { # A generic empty message that you can re-use to avoid defining duplicated 140 # empty messages in your APIs. A typical example is to use it as the request 141 # or the response type of an API method. For instance: 142 # 143 # service Foo { 144 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 145 # } 146 # 147 # The JSON representation for `Empty` is empty JSON object `{}`. 148 }</pre> 149 </div> 150 151 <div class="method"> 152 <code class="details" id="get">get(name, x__xgafv=None)</code> 153 <pre>Gets the latest state of a long-running operation. Clients can use this 154 method to poll the operation result at intervals as recommended by the API 155 service. 156 157 Args: 158 name: string, The name of the operation resource. (required) 159 x__xgafv: string, V1 error format. 160 Allowed values 161 1 - v1 error format 162 2 - v2 error format 163 164 Returns: 165 An object of the form: 166 167 { # This resource represents a long-running operation that is the result of a 168 # network API call. 169 "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. 170 # programming environments, including REST APIs and RPC APIs. It is used by 171 # [gRPC](https://github.com/grpc). The error model is designed to be: 172 # 173 # - Simple to use and understand for most users 174 # - Flexible enough to meet unexpected needs 175 # 176 # # Overview 177 # 178 # The `Status` message contains three pieces of data: error code, error message, 179 # and error details. The error code should be an enum value of 180 # google.rpc.Code, but it may accept additional error codes if needed. The 181 # error message should be a developer-facing English message that helps 182 # developers *understand* and *resolve* the error. If a localized user-facing 183 # error message is needed, put the localized message in the error details or 184 # localize it in the client. The optional error details may contain arbitrary 185 # information about the error. There is a predefined set of error detail types 186 # in the package `google.rpc` that can be used for common error conditions. 187 # 188 # # Language mapping 189 # 190 # The `Status` message is the logical representation of the error model, but it 191 # is not necessarily the actual wire format. When the `Status` message is 192 # exposed in different client libraries and different wire protocols, it can be 193 # mapped differently. For example, it will likely be mapped to some exceptions 194 # in Java, but more likely mapped to some error codes in C. 195 # 196 # # Other uses 197 # 198 # The error model and the `Status` message can be used in a variety of 199 # environments, either with or without APIs, to provide a 200 # consistent developer experience across different environments. 201 # 202 # Example uses of this error model include: 203 # 204 # - Partial errors. If a service needs to return partial errors to the client, 205 # it may embed the `Status` in the normal response to indicate the partial 206 # errors. 207 # 208 # - Workflow errors. A typical workflow has multiple steps. Each step may 209 # have a `Status` message for error reporting. 210 # 211 # - Batch operations. If a client uses batch request and batch response, the 212 # `Status` message should be used directly inside batch response, one for 213 # each error sub-response. 214 # 215 # - Asynchronous operations. If an API call embeds asynchronous operation 216 # results in its response, the status of those operations should be 217 # represented directly using the `Status` message. 218 # 219 # - Logging. If some API errors are stored in logs, the message `Status` could 220 # be used directly after any stripping needed for security/privacy reasons. 221 "message": "A String", # A developer-facing error message, which should be in English. Any 222 # user-facing error message should be localized and sent in the 223 # google.rpc.Status.details field, or localized by the client. 224 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 225 "details": [ # A list of messages that carry the error details. There will be a 226 # common set of message types for APIs to use. 227 { 228 "a_key": "", # Properties of the object. Contains field @type with type URL. 229 }, 230 ], 231 }, 232 "done": True or False, # If the value is `false`, it means the operation is still in progress. 233 # If true, the operation is completed, and either `error` or `response` is 234 # available. 235 "response": { # The normal response of the operation in case of success. If the original 236 # method returns no data on success, such as `Delete`, the response is 237 # `google.protobuf.Empty`. If the original method is standard 238 # `Get`/`Create`/`Update`, the response should be the resource. For other 239 # methods, the response should have the type `XxxResponse`, where `Xxx` 240 # is the original method name. For example, if the original method name 241 # is `TakeSnapshot()`, the inferred response type is 242 # `TakeSnapshotResponse`. 243 "a_key": "", # Properties of the object. Contains field @type with type URL. 244 }, 245 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`. 246 "metadata": { # Represents the transfer operation object. 247 "a_key": "", # Properties of the object. Contains field @type with type URL. 248 }, 249 }</pre> 250 </div> 251 252 <div class="method"> 253 <code class="details" id="list">list(name, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code> 254 <pre>Lists operations that match the specified filter in the request. If the 255 server doesn't support this method, it returns `UNIMPLEMENTED`. 256 257 NOTE: the `name` binding allows API services to override the binding 258 to use different resource name schemes, such as `users/*/operations`. To 259 override the binding, API services can add a binding such as 260 `"/v1/{name=users/*}/operations"` to their service configuration. 261 For backwards compatibility, the default name includes the operations 262 collection id, however overriding users must ensure the name binding 263 is the parent resource, without the operations collection id. 264 265 Args: 266 name: string, The value `transferOperations`. (required) 267 pageSize: integer, The list page size. The max allowed value is 256. 268 filter: string, A list of query parameters specified as JSON text in the form of {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional. 269 pageToken: string, The list page token. 270 x__xgafv: string, V1 error format. 271 Allowed values 272 1 - v1 error format 273 2 - v2 error format 274 275 Returns: 276 An object of the form: 277 278 { # The response message for Operations.ListOperations. 279 "nextPageToken": "A String", # The standard List next-page token. 280 "operations": [ # A list of operations that matches the specified filter in the request. 281 { # This resource represents a long-running operation that is the result of a 282 # network API call. 283 "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. 284 # programming environments, including REST APIs and RPC APIs. It is used by 285 # [gRPC](https://github.com/grpc). The error model is designed to be: 286 # 287 # - Simple to use and understand for most users 288 # - Flexible enough to meet unexpected needs 289 # 290 # # Overview 291 # 292 # The `Status` message contains three pieces of data: error code, error message, 293 # and error details. The error code should be an enum value of 294 # google.rpc.Code, but it may accept additional error codes if needed. The 295 # error message should be a developer-facing English message that helps 296 # developers *understand* and *resolve* the error. If a localized user-facing 297 # error message is needed, put the localized message in the error details or 298 # localize it in the client. The optional error details may contain arbitrary 299 # information about the error. There is a predefined set of error detail types 300 # in the package `google.rpc` that can be used for common error conditions. 301 # 302 # # Language mapping 303 # 304 # The `Status` message is the logical representation of the error model, but it 305 # is not necessarily the actual wire format. When the `Status` message is 306 # exposed in different client libraries and different wire protocols, it can be 307 # mapped differently. For example, it will likely be mapped to some exceptions 308 # in Java, but more likely mapped to some error codes in C. 309 # 310 # # Other uses 311 # 312 # The error model and the `Status` message can be used in a variety of 313 # environments, either with or without APIs, to provide a 314 # consistent developer experience across different environments. 315 # 316 # Example uses of this error model include: 317 # 318 # - Partial errors. If a service needs to return partial errors to the client, 319 # it may embed the `Status` in the normal response to indicate the partial 320 # errors. 321 # 322 # - Workflow errors. A typical workflow has multiple steps. Each step may 323 # have a `Status` message for error reporting. 324 # 325 # - Batch operations. If a client uses batch request and batch response, the 326 # `Status` message should be used directly inside batch response, one for 327 # each error sub-response. 328 # 329 # - Asynchronous operations. If an API call embeds asynchronous operation 330 # results in its response, the status of those operations should be 331 # represented directly using the `Status` message. 332 # 333 # - Logging. If some API errors are stored in logs, the message `Status` could 334 # be used directly after any stripping needed for security/privacy reasons. 335 "message": "A String", # A developer-facing error message, which should be in English. Any 336 # user-facing error message should be localized and sent in the 337 # google.rpc.Status.details field, or localized by the client. 338 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 339 "details": [ # A list of messages that carry the error details. There will be a 340 # common set of message types for APIs to use. 341 { 342 "a_key": "", # Properties of the object. Contains field @type with type URL. 343 }, 344 ], 345 }, 346 "done": True or False, # If the value is `false`, it means the operation is still in progress. 347 # If true, the operation is completed, and either `error` or `response` is 348 # available. 349 "response": { # The normal response of the operation in case of success. If the original 350 # method returns no data on success, such as `Delete`, the response is 351 # `google.protobuf.Empty`. If the original method is standard 352 # `Get`/`Create`/`Update`, the response should be the resource. For other 353 # methods, the response should have the type `XxxResponse`, where `Xxx` 354 # is the original method name. For example, if the original method name 355 # is `TakeSnapshot()`, the inferred response type is 356 # `TakeSnapshotResponse`. 357 "a_key": "", # Properties of the object. Contains field @type with type URL. 358 }, 359 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should have the format of `transferOperations/some/unique/name`. 360 "metadata": { # Represents the transfer operation object. 361 "a_key": "", # Properties of the object. Contains field @type with type URL. 362 }, 363 }, 364 ], 365 }</pre> 366 </div> 367 368 <div class="method"> 369 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 370 <pre>Retrieves the next page of results. 371 372 Args: 373 previous_request: The request for the previous page. (required) 374 previous_response: The response from the request for the previous page. (required) 375 376 Returns: 377 A request object that you can call 'execute()' on to request the next 378 page. Returns None if there are no more items in the collection. 379 </pre> 380 </div> 381 382 <div class="method"> 383 <code class="details" id="pause">pause(name, body, x__xgafv=None)</code> 384 <pre>Pauses a transfer operation. 385 386 Args: 387 name: string, The name of the transfer operation. 388 Required. (required) 389 body: object, The request body. (required) 390 The object takes the form of: 391 392 { # Request passed to PauseTransferOperation. 393 } 394 395 x__xgafv: string, V1 error format. 396 Allowed values 397 1 - v1 error format 398 2 - v2 error format 399 400 Returns: 401 An object of the form: 402 403 { # A generic empty message that you can re-use to avoid defining duplicated 404 # empty messages in your APIs. A typical example is to use it as the request 405 # or the response type of an API method. For instance: 406 # 407 # service Foo { 408 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 409 # } 410 # 411 # The JSON representation for `Empty` is empty JSON object `{}`. 412 }</pre> 413 </div> 414 415 <div class="method"> 416 <code class="details" id="resume">resume(name, body, x__xgafv=None)</code> 417 <pre>Resumes a transfer operation that is paused. 418 419 Args: 420 name: string, The name of the transfer operation. 421 Required. (required) 422 body: object, The request body. (required) 423 The object takes the form of: 424 425 { # Request passed to ResumeTransferOperation. 426 } 427 428 x__xgafv: string, V1 error format. 429 Allowed values 430 1 - v1 error format 431 2 - v2 error format 432 433 Returns: 434 An object of the form: 435 436 { # A generic empty message that you can re-use to avoid defining duplicated 437 # empty messages in your APIs. A typical example is to use it as the request 438 # or the response type of an API method. For instance: 439 # 440 # service Foo { 441 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 442 # } 443 # 444 # The JSON representation for `Empty` is empty JSON object `{}`. 445 }</pre> 446 </div> 447 448 </body></html>
