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, body=None, x__xgafv=None)</a></code></p> 79<p class="firstline">Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the `cancel` request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, `cancel` does nothing. *Caution:* Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the `cancel` request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</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 method to poll the operation result at intervals as recommended by the API service.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(name, filter, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists transfer operations. Operations are ordered by their creation time in reverse chronological order.</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, body=None, x__xgafv=None)</code> 101 <pre>Cancels a transfer. Use the transferOperations.get method to check if the cancellation succeeded or if the operation completed despite the `cancel` request. When you cancel an operation, the currently running transfer is interrupted. For recurring transfer jobs, the next instance of the transfer job will still run. For example, if your job is configured to run every day at 1pm and you cancel Monday's operation at 1:05pm, Monday's transfer will stop. However, a transfer job will still be attempted on Tuesday. This applies only to currently running operations. If an operation is not currently running, `cancel` does nothing. *Caution:* Canceling a transfer job can leave your data in an unknown state. We recommend that you restore the state at both the destination and the source after the `cancel` request completes so that your data is in a consistent state. When you cancel a job, the next job computes a delta of files and may repair any inconsistent state. For instance, if you run a job every day, and today's job found 10 new files and transferred five files before you canceled the job, tomorrow's transfer operation will compute a new delta with the five files that were not copied today plus any new files discovered tomorrow. 102 103Args: 104 name: string, The name of the operation resource to be cancelled. (required) 105 body: object, The request body. 106 The object takes the form of: 107 108{ # The request message for Operations.CancelOperation. 109} 110 111 x__xgafv: string, V1 error format. 112 Allowed values 113 1 - v1 error format 114 2 - v2 error format 115 116Returns: 117 An object of the form: 118 119 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 120}</pre> 121</div> 122 123<div class="method"> 124 <code class="details" id="close">close()</code> 125 <pre>Close httplib2 connections.</pre> 126</div> 127 128<div class="method"> 129 <code class="details" id="get">get(name, x__xgafv=None)</code> 130 <pre>Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. 131 132Args: 133 name: string, The name of the operation resource. (required) 134 x__xgafv: string, V1 error format. 135 Allowed values 136 1 - v1 error format 137 2 - v2 error format 138 139Returns: 140 An object of the form: 141 142 { # This resource represents a long-running operation that is the result of a network API call. 143 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 144 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 145 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 146 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 147 { 148 "a_key": "", # Properties of the object. Contains field @type with type URL. 149 }, 150 ], 151 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 152 }, 153 "metadata": { # Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get. 154 "a_key": "", # Properties of the object. Contains field @type with type URL. 155 }, 156 "name": "A String", # The server-assigned unique name. The format of `name` is `transferOperations/some/unique/name`. 157 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 158 "a_key": "", # Properties of the object. Contains field @type with type URL. 159 }, 160}</pre> 161</div> 162 163<div class="method"> 164 <code class="details" id="list">list(name, filter, pageSize=None, pageToken=None, x__xgafv=None)</code> 165 <pre>Lists transfer operations. Operations are ordered by their creation time in reverse chronological order. 166 167Args: 168 name: string, Not used. (required) 169 filter: string, Required. A list of query parameters specified as JSON text in the form of: `{"projectId":"my_project_id", "jobNames":["jobid1","jobid2",...], "operationNames":["opid1","opid2",...], "transferStatuses":["status1","status2",...]}` Since `jobNames`, `operationNames`, and `transferStatuses` support multiple values, they must be specified with array notation. `projectId` is required. `jobNames`, `operationNames`, and `transferStatuses` are optional. The valid values for `transferStatuses` are case-insensitive: IN_PROGRESS, PAUSED, SUCCESS, FAILED, and ABORTED. (required) 170 pageSize: integer, The list page size. The max allowed value is 256. 171 pageToken: string, The list page token. 172 x__xgafv: string, V1 error format. 173 Allowed values 174 1 - v1 error format 175 2 - v2 error format 176 177Returns: 178 An object of the form: 179 180 { # The response message for Operations.ListOperations. 181 "nextPageToken": "A String", # The standard List next-page token. 182 "operations": [ # A list of operations that matches the specified filter in the request. 183 { # This resource represents a long-running operation that is the result of a network API call. 184 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 185 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 186 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 187 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 188 { 189 "a_key": "", # Properties of the object. Contains field @type with type URL. 190 }, 191 ], 192 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 193 }, 194 "metadata": { # Represents the transfer operation object. To request a TransferOperation object, use transferOperations.get. 195 "a_key": "", # Properties of the object. Contains field @type with type URL. 196 }, 197 "name": "A String", # The server-assigned unique name. The format of `name` is `transferOperations/some/unique/name`. 198 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 199 "a_key": "", # Properties of the object. Contains field @type with type URL. 200 }, 201 }, 202 ], 203}</pre> 204</div> 205 206<div class="method"> 207 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 208 <pre>Retrieves the next page of results. 209 210Args: 211 previous_request: The request for the previous page. (required) 212 previous_response: The response from the request for the previous page. (required) 213 214Returns: 215 A request object that you can call 'execute()' on to request the next 216 page. Returns None if there are no more items in the collection. 217 </pre> 218</div> 219 220<div class="method"> 221 <code class="details" id="pause">pause(name, body=None, x__xgafv=None)</code> 222 <pre>Pauses a transfer operation. 223 224Args: 225 name: string, Required. The name of the transfer operation. (required) 226 body: object, The request body. 227 The object takes the form of: 228 229{ # Request passed to PauseTransferOperation. 230} 231 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 241}</pre> 242</div> 243 244<div class="method"> 245 <code class="details" id="resume">resume(name, body=None, x__xgafv=None)</code> 246 <pre>Resumes a transfer operation that is paused. 247 248Args: 249 name: string, Required. The name of the transfer operation. (required) 250 body: object, The request body. 251 The object takes the form of: 252 253{ # Request passed to ResumeTransferOperation. 254} 255 256 x__xgafv: string, V1 error format. 257 Allowed values 258 1 - v1 error format 259 2 - v2 error format 260 261Returns: 262 An object of the form: 263 264 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 265}</pre> 266</div> 267 268</body></html>