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="storagetransfer_v1.html">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, pageToken=None, x__xgafv=None, pageSize=None, filter=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=None, 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=None, 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 103Args: 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 110Returns: 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 129Args: 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 136Returns: 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 154method to poll the operation result at intervals as recommended by the API 155service. 156 157Args: 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 164Returns: 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 # The error result of the operation in case of failure or cancellation. 170 # different programming environments, including REST APIs and RPC APIs. It is 171 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 172 # three pieces of data: error code, error message, and error details. 173 # 174 # You can find out more about this error model and how to work with it in the 175 # [API Design Guide](https://cloud.google.com/apis/design/errors). 176 "message": "A String", # A developer-facing error message, which should be in English. Any 177 # user-facing error message should be localized and sent in the 178 # google.rpc.Status.details field, or localized by the client. 179 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 180 "details": [ # A list of messages that carry the error details. There is a common set of 181 # message types for APIs to use. 182 { 183 "a_key": "", # Properties of the object. Contains field @type with type URL. 184 }, 185 ], 186 }, 187 "done": True or False, # If the value is `false`, it means the operation is still in progress. 188 # If `true`, the operation is completed, and either `error` or `response` is 189 # available. 190 "response": { # The normal response of the operation in case of success. If the original 191 # method returns no data on success, such as `Delete`, the response is 192 # `google.protobuf.Empty`. If the original method is standard 193 # `Get`/`Create`/`Update`, the response should be the resource. For other 194 # methods, the response should have the type `XxxResponse`, where `Xxx` 195 # is the original method name. For example, if the original method name 196 # is `TakeSnapshot()`, the inferred response type is 197 # `TakeSnapshotResponse`. 198 "a_key": "", # Properties of the object. Contains field @type with type URL. 199 }, 200 "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`. 201 "metadata": { # Represents the transfer operation object. 202 "a_key": "", # Properties of the object. Contains field @type with type URL. 203 }, 204 }</pre> 205</div> 206 207<div class="method"> 208 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code> 209 <pre>Lists operations that match the specified filter in the request. If the 210server doesn't support this method, it returns `UNIMPLEMENTED`. 211 212NOTE: the `name` binding allows API services to override the binding 213to use different resource name schemes, such as `users/*/operations`. To 214override the binding, API services can add a binding such as 215`"/v1/{name=users/*}/operations"` to their service configuration. 216For backwards compatibility, the default name includes the operations 217collection id, however overriding users must ensure the name binding 218is the parent resource, without the operations collection id. 219 220Args: 221 name: string, Required. The value `transferOperations`. (required) 222 pageToken: string, The list page token. 223 x__xgafv: string, V1 error format. 224 Allowed values 225 1 - v1 error format 226 2 - v2 error format 227 pageSize: integer, The list page size. The max allowed value is 256. 228 filter: string, Required. A list of query parameters specified as JSON text in the form of: {"project_id":"my_project_id", 229 "job_names":["jobid1","jobid2",...], 230 "operation_names":["opid1","opid2",...], 231 "transfer_statuses":["status1","status2",...]}. 232Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `project_id` is required. `job_names`, `operation_names`, and `transfer_statuses` are optional. The valid values for `transfer_statuses` are case-insensitive: `IN_PROGRESS`, `PAUSED`, `SUCCESS`, `FAILED`, and `ABORTED`. 233 234Returns: 235 An object of the form: 236 237 { # The response message for Operations.ListOperations. 238 "operations": [ # A list of operations that matches the specified filter in the request. 239 { # This resource represents a long-running operation that is the result of a 240 # network API call. 241 "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. 242 # different programming environments, including REST APIs and RPC APIs. It is 243 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 244 # three pieces of data: error code, error message, and error details. 245 # 246 # You can find out more about this error model and how to work with it in the 247 # [API Design Guide](https://cloud.google.com/apis/design/errors). 248 "message": "A String", # A developer-facing error message, which should be in English. Any 249 # user-facing error message should be localized and sent in the 250 # google.rpc.Status.details field, or localized by the client. 251 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 252 "details": [ # A list of messages that carry the error details. There is a common set of 253 # message types for APIs to use. 254 { 255 "a_key": "", # Properties of the object. Contains field @type with type URL. 256 }, 257 ], 258 }, 259 "done": True or False, # If the value is `false`, it means the operation is still in progress. 260 # If `true`, the operation is completed, and either `error` or `response` is 261 # available. 262 "response": { # The normal response of the operation in case of success. If the original 263 # method returns no data on success, such as `Delete`, the response is 264 # `google.protobuf.Empty`. If the original method is standard 265 # `Get`/`Create`/`Update`, the response should be the resource. For other 266 # methods, the response should have the type `XxxResponse`, where `Xxx` 267 # is the original method name. For example, if the original method name 268 # is `TakeSnapshot()`, the inferred response type is 269 # `TakeSnapshotResponse`. 270 "a_key": "", # Properties of the object. Contains field @type with type URL. 271 }, 272 "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`. 273 "metadata": { # Represents the transfer operation object. 274 "a_key": "", # Properties of the object. Contains field @type with type URL. 275 }, 276 }, 277 ], 278 "nextPageToken": "A String", # The standard List next-page token. 279 }</pre> 280</div> 281 282<div class="method"> 283 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 284 <pre>Retrieves the next page of results. 285 286Args: 287 previous_request: The request for the previous page. (required) 288 previous_response: The response from the request for the previous page. (required) 289 290Returns: 291 A request object that you can call 'execute()' on to request the next 292 page. Returns None if there are no more items in the collection. 293 </pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code> 298 <pre>Pauses a transfer operation. 299 300Args: 301 name: string, Required. The name of the transfer operation. (required) 302 body: object, The request body. 303 The object takes the form of: 304 305{ # Request passed to PauseTransferOperation. 306 } 307 308 x__xgafv: string, V1 error format. 309 Allowed values 310 1 - v1 error format 311 2 - v2 error format 312 313Returns: 314 An object of the form: 315 316 { # A generic empty message that you can re-use to avoid defining duplicated 317 # empty messages in your APIs. A typical example is to use it as the request 318 # or the response type of an API method. For instance: 319 # 320 # service Foo { 321 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 322 # } 323 # 324 # The JSON representation for `Empty` is empty JSON object `{}`. 325 }</pre> 326</div> 327 328<div class="method"> 329 <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code> 330 <pre>Resumes a transfer operation that is paused. 331 332Args: 333 name: string, Required. The name of the transfer operation. (required) 334 body: object, The request body. 335 The object takes the form of: 336 337{ # Request passed to ResumeTransferOperation. 338 } 339 340 x__xgafv: string, V1 error format. 341 Allowed values 342 1 - v1 error format 343 2 - v2 error format 344 345Returns: 346 An object of the form: 347 348 { # A generic empty message that you can re-use to avoid defining duplicated 349 # empty messages in your APIs. A typical example is to use it as the request 350 # or the response type of an API method. For instance: 351 # 352 # service Foo { 353 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 354 # } 355 # 356 # The JSON representation for `Empty` is empty JSON object `{}`. 357 }</pre> 358</div> 359 360</body></html>