OLD | NEW |
1 // This is a generated file (see the discoveryapis_generator project). | 1 // This is a generated file (see the discoveryapis_generator project). |
2 | 2 |
3 library googleapis.storagetransfer.v1; | 3 library googleapis.storagetransfer.v1; |
4 | 4 |
5 import 'dart:core' as core; | 5 import 'dart:core' as core; |
6 import 'dart:async' as async; | 6 import 'dart:async' as async; |
7 import 'dart:convert' as convert; | 7 import 'dart:convert' as convert; |
8 | 8 |
9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; | 9 import 'package:_discoveryapis_commons/_discoveryapis_commons.dart' as commons; |
10 import 'package:http/http.dart' as http; | 10 import 'package:http/http.dart' as http; |
(...skipping 10 matching lines...) Expand all Loading... |
21 class StoragetransferApi { | 21 class StoragetransferApi { |
22 /** View and manage your data across Google Cloud Platform services */ | 22 /** View and manage your data across Google Cloud Platform services */ |
23 static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platf
orm"; | 23 static const CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platf
orm"; |
24 | 24 |
25 | 25 |
26 final commons.ApiRequester _requester; | 26 final commons.ApiRequester _requester; |
27 | 27 |
28 GoogleServiceAccountsResourceApi get googleServiceAccounts => new GoogleServic
eAccountsResourceApi(_requester); | 28 GoogleServiceAccountsResourceApi get googleServiceAccounts => new GoogleServic
eAccountsResourceApi(_requester); |
29 TransferJobsResourceApi get transferJobs => new TransferJobsResourceApi(_reque
ster); | 29 TransferJobsResourceApi get transferJobs => new TransferJobsResourceApi(_reque
ster); |
30 TransferOperationsResourceApi get transferOperations => new TransferOperations
ResourceApi(_requester); | 30 TransferOperationsResourceApi get transferOperations => new TransferOperations
ResourceApi(_requester); |
31 V1ResourceApi get v1 => new V1ResourceApi(_requester); | |
32 | 31 |
33 StoragetransferApi(http.Client client, {core.String rootUrl: "https://storaget
ransfer.googleapis.com/", core.String servicePath: ""}) : | 32 StoragetransferApi(http.Client client, {core.String rootUrl: "https://storaget
ransfer.googleapis.com/", core.String servicePath: ""}) : |
34 _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_A
GENT); | 33 _requester = new commons.ApiRequester(client, rootUrl, servicePath, USER_A
GENT); |
35 } | 34 } |
36 | 35 |
37 | 36 |
38 class GoogleServiceAccountsResourceApi { | 37 class GoogleServiceAccountsResourceApi { |
39 final commons.ApiRequester _requester; | 38 final commons.ApiRequester _requester; |
40 | 39 |
41 GoogleServiceAccountsResourceApi(commons.ApiRequester client) : | 40 GoogleServiceAccountsResourceApi(commons.ApiRequester client) : |
42 _requester = client; | 41 _requester = client; |
43 | 42 |
44 /** | 43 /** |
45 * Returns the Google service account that is used by Storage Transfer Service | 44 * Returns the Google service account that is used by Storage Transfer |
46 * to access buckets in the project where transfers run or in other projects. | 45 * Service to access buckets in the project where transfers |
47 * Each Google service account is associated with one Google Developers | 46 * run or in other projects. Each Google service account is associated |
48 * Console project. Users should add this service account to the Google Cloud | 47 * with one Google Cloud Platform Console project. Users |
49 * Storage bucket ACLs to grant access to Storage Transfer Service. This | 48 * should add this service account to the Google Cloud Storage bucket |
50 * service account is created and owned by Storage Transfer Service and can | 49 * ACLs to grant access to Storage Transfer Service. This service |
| 50 * account is created and owned by Storage Transfer Service and can |
51 * only be used by Storage Transfer Service. | 51 * only be used by Storage Transfer Service. |
52 * | 52 * |
53 * Request parameters: | 53 * Request parameters: |
54 * | 54 * |
55 * [projectId] - The ID of the Google Developers Console project that the | 55 * [projectId] - The ID of the Google Cloud Platform Console project that the |
56 * Google service account is associated with. Required. | 56 * Google service |
| 57 * account is associated with. |
| 58 * Required. |
57 * | 59 * |
58 * Completes with a [GoogleServiceAccount]. | 60 * Completes with a [GoogleServiceAccount]. |
59 * | 61 * |
60 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 62 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
61 * error. | 63 * error. |
62 * | 64 * |
63 * If the used [http.Client] completes with an error when making a REST call, | 65 * If the used [http.Client] completes with an error when making a REST call, |
64 * this method will complete with the same error. | 66 * this method will complete with the same error. |
65 */ | 67 */ |
66 async.Future<GoogleServiceAccount> get(core.String projectId) { | 68 async.Future<GoogleServiceAccount> get(core.String projectId) { |
(...skipping 66 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
133 uploadMedia: _uploadMedia, | 135 uploadMedia: _uploadMedia, |
134 downloadOptions: _downloadOptions); | 136 downloadOptions: _downloadOptions); |
135 return _response.then((data) => new TransferJob.fromJson(data)); | 137 return _response.then((data) => new TransferJob.fromJson(data)); |
136 } | 138 } |
137 | 139 |
138 /** | 140 /** |
139 * Gets a transfer job. | 141 * Gets a transfer job. |
140 * | 142 * |
141 * Request parameters: | 143 * Request parameters: |
142 * | 144 * |
143 * [jobName] - The job to get. Required. | 145 * [jobName] - The job to get. |
144 * Value must have pattern "^transferJobs/.*$". | 146 * Required. |
| 147 * Value must have pattern "^transferJobs/.+$". |
145 * | 148 * |
146 * [projectId] - The ID of the Google Developers Console project that owns the | 149 * [projectId] - The ID of the Google Cloud Platform Console project that owns |
147 * job. Required. | 150 * the job. |
| 151 * Required. |
148 * | 152 * |
149 * Completes with a [TransferJob]. | 153 * Completes with a [TransferJob]. |
150 * | 154 * |
151 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 155 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
152 * error. | 156 * error. |
153 * | 157 * |
154 * If the used [http.Client] completes with an error when making a REST call, | 158 * If the used [http.Client] completes with an error when making a REST call, |
155 * this method will complete with the same error. | 159 * this method will complete with the same error. |
156 */ | 160 */ |
157 async.Future<TransferJob> get(core.String jobName, {core.String projectId}) { | 161 async.Future<TransferJob> get(core.String jobName, {core.String projectId}) { |
(...skipping 21 matching lines...) Expand all Loading... |
179 uploadMedia: _uploadMedia, | 183 uploadMedia: _uploadMedia, |
180 downloadOptions: _downloadOptions); | 184 downloadOptions: _downloadOptions); |
181 return _response.then((data) => new TransferJob.fromJson(data)); | 185 return _response.then((data) => new TransferJob.fromJson(data)); |
182 } | 186 } |
183 | 187 |
184 /** | 188 /** |
185 * Lists transfer jobs. | 189 * Lists transfer jobs. |
186 * | 190 * |
187 * Request parameters: | 191 * Request parameters: |
188 * | 192 * |
189 * [filter] - A list of query parameters specified as JSON text in the form of | 193 * [pageToken] - The list page token. |
190 * {"`project_id`":"my_project_id", "`job_names`":["jobid1","jobid2",...], | |
191 * "`job_statuses`":["status1","status2",...]}. Since `job_names` and | |
192 * `job_statuses` support multiple values, their values must be specified with | |
193 * array notation. `project_id` is required. `job_names` and `job_statuses` | |
194 * are optional. The valid values for `job_statuses` are case-insensitive: | |
195 * `ENABLED`, `DISABLED`, and `DELETED`. | |
196 * | 194 * |
197 * [pageSize] - The list page size. The max allowed value is 256. | 195 * [pageSize] - The list page size. The max allowed value is 256. |
198 * | 196 * |
199 * [pageToken] - The list page token. | 197 * [filter] - A list of query parameters specified as JSON text in the form of |
| 198 * {"project_id":"my_project_id", |
| 199 * "job_names":["jobid1","jobid2",...], |
| 200 * "job_statuses":["status1","status2",...]}. |
| 201 * Since `job_names` and `job_statuses` support multiple values, their values |
| 202 * must be specified with array notation. `project_id` is required. |
| 203 * `job_names` |
| 204 * and `job_statuses` are optional. The valid values for `job_statuses` are |
| 205 * case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`. |
200 * | 206 * |
201 * Completes with a [ListTransferJobsResponse]. | 207 * Completes with a [ListTransferJobsResponse]. |
202 * | 208 * |
203 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 209 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
204 * error. | 210 * error. |
205 * | 211 * |
206 * If the used [http.Client] completes with an error when making a REST call, | 212 * If the used [http.Client] completes with an error when making a REST call, |
207 * this method will complete with the same error. | 213 * this method will complete with the same error. |
208 */ | 214 */ |
209 async.Future<ListTransferJobsResponse> list({core.String filter, core.int page
Size, core.String pageToken}) { | 215 async.Future<ListTransferJobsResponse> list({core.String pageToken, core.int p
ageSize, core.String filter}) { |
210 var _url = null; | 216 var _url = null; |
211 var _queryParams = new core.Map(); | 217 var _queryParams = new core.Map(); |
212 var _uploadMedia = null; | 218 var _uploadMedia = null; |
213 var _uploadOptions = null; | 219 var _uploadOptions = null; |
214 var _downloadOptions = commons.DownloadOptions.Metadata; | 220 var _downloadOptions = commons.DownloadOptions.Metadata; |
215 var _body = null; | 221 var _body = null; |
216 | 222 |
217 if (filter != null) { | 223 if (pageToken != null) { |
218 _queryParams["filter"] = [filter]; | 224 _queryParams["pageToken"] = [pageToken]; |
219 } | 225 } |
220 if (pageSize != null) { | 226 if (pageSize != null) { |
221 _queryParams["pageSize"] = ["${pageSize}"]; | 227 _queryParams["pageSize"] = ["${pageSize}"]; |
222 } | 228 } |
223 if (pageToken != null) { | 229 if (filter != null) { |
224 _queryParams["pageToken"] = [pageToken]; | 230 _queryParams["filter"] = [filter]; |
225 } | 231 } |
226 | 232 |
227 _url = 'v1/transferJobs'; | 233 _url = 'v1/transferJobs'; |
228 | 234 |
229 var _response = _requester.request(_url, | 235 var _response = _requester.request(_url, |
230 "GET", | 236 "GET", |
231 body: _body, | 237 body: _body, |
232 queryParams: _queryParams, | 238 queryParams: _queryParams, |
233 uploadOptions: _uploadOptions, | 239 uploadOptions: _uploadOptions, |
234 uploadMedia: _uploadMedia, | 240 uploadMedia: _uploadMedia, |
235 downloadOptions: _downloadOptions); | 241 downloadOptions: _downloadOptions); |
236 return _response.then((data) => new ListTransferJobsResponse.fromJson(data))
; | 242 return _response.then((data) => new ListTransferJobsResponse.fromJson(data))
; |
237 } | 243 } |
238 | 244 |
239 /** | 245 /** |
240 * Updates a transfer job. Updating a job's transfer spec does not affect | 246 * Updates a transfer job. Updating a job's transfer spec does not affect |
241 * transfer operations that are running already. Updating the scheduling of a | 247 * transfer operations that are running already. Updating the scheduling |
242 * job is not allowed. | 248 * of a job is not allowed. |
243 * | 249 * |
244 * [request] - The metadata request object. | 250 * [request] - The metadata request object. |
245 * | 251 * |
246 * Request parameters: | 252 * Request parameters: |
247 * | 253 * |
248 * [jobName] - The name of job to update. Required. | 254 * [jobName] - The name of job to update. |
249 * Value must have pattern "^transferJobs/.*$". | 255 * Required. |
| 256 * Value must have pattern "^transferJobs/.+$". |
250 * | 257 * |
251 * Completes with a [TransferJob]. | 258 * Completes with a [TransferJob]. |
252 * | 259 * |
253 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 260 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
254 * error. | 261 * error. |
255 * | 262 * |
256 * If the used [http.Client] completes with an error when making a REST call, | 263 * If the used [http.Client] completes with an error when making a REST call, |
257 * this method will complete with the same error. | 264 * this method will complete with the same error. |
258 */ | 265 */ |
259 async.Future<TransferJob> patch(UpdateTransferJobRequest request, core.String
jobName) { | 266 async.Future<TransferJob> patch(UpdateTransferJobRequest request, core.String
jobName) { |
(...skipping 32 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
292 TransferOperationsResourceApi(commons.ApiRequester client) : | 299 TransferOperationsResourceApi(commons.ApiRequester client) : |
293 _requester = client; | 300 _requester = client; |
294 | 301 |
295 /** | 302 /** |
296 * Cancels a transfer. Use the get method to check whether the cancellation | 303 * Cancels a transfer. Use the get method to check whether the cancellation |
297 * succeeded or whether the operation completed despite cancellation. | 304 * succeeded or whether the operation completed despite cancellation. |
298 * | 305 * |
299 * Request parameters: | 306 * Request parameters: |
300 * | 307 * |
301 * [name] - The name of the operation resource to be cancelled. | 308 * [name] - The name of the operation resource to be cancelled. |
302 * Value must have pattern "^transferOperations/.*$". | 309 * Value must have pattern "^transferOperations/.+$". |
303 * | 310 * |
304 * Completes with a [Empty]. | 311 * Completes with a [Empty]. |
305 * | 312 * |
306 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 313 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
307 * error. | 314 * error. |
308 * | 315 * |
309 * If the used [http.Client] completes with an error when making a REST call, | 316 * If the used [http.Client] completes with an error when making a REST call, |
310 * this method will complete with the same error. | 317 * this method will complete with the same error. |
311 */ | 318 */ |
312 async.Future<Empty> cancel(core.String name) { | 319 async.Future<Empty> cancel(core.String name) { |
(...skipping 19 matching lines...) Expand all Loading... |
332 downloadOptions: _downloadOptions); | 339 downloadOptions: _downloadOptions); |
333 return _response.then((data) => new Empty.fromJson(data)); | 340 return _response.then((data) => new Empty.fromJson(data)); |
334 } | 341 } |
335 | 342 |
336 /** | 343 /** |
337 * This method is not supported and the server returns `UNIMPLEMENTED`. | 344 * This method is not supported and the server returns `UNIMPLEMENTED`. |
338 * | 345 * |
339 * Request parameters: | 346 * Request parameters: |
340 * | 347 * |
341 * [name] - The name of the operation resource to be deleted. | 348 * [name] - The name of the operation resource to be deleted. |
342 * Value must have pattern "^transferOperations/.*$". | 349 * Value must have pattern "^transferOperations/.+$". |
343 * | 350 * |
344 * Completes with a [Empty]. | 351 * Completes with a [Empty]. |
345 * | 352 * |
346 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 353 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
347 * error. | 354 * error. |
348 * | 355 * |
349 * If the used [http.Client] completes with an error when making a REST call, | 356 * If the used [http.Client] completes with an error when making a REST call, |
350 * this method will complete with the same error. | 357 * this method will complete with the same error. |
351 */ | 358 */ |
352 async.Future<Empty> delete(core.String name) { | 359 async.Future<Empty> delete(core.String name) { |
(...skipping 14 matching lines...) Expand all Loading... |
367 "DELETE", | 374 "DELETE", |
368 body: _body, | 375 body: _body, |
369 queryParams: _queryParams, | 376 queryParams: _queryParams, |
370 uploadOptions: _uploadOptions, | 377 uploadOptions: _uploadOptions, |
371 uploadMedia: _uploadMedia, | 378 uploadMedia: _uploadMedia, |
372 downloadOptions: _downloadOptions); | 379 downloadOptions: _downloadOptions); |
373 return _response.then((data) => new Empty.fromJson(data)); | 380 return _response.then((data) => new Empty.fromJson(data)); |
374 } | 381 } |
375 | 382 |
376 /** | 383 /** |
377 * Gets the latest state of a long-running operation. Clients can use this | 384 * Gets the latest state of a long-running operation. Clients can use this |
378 * method to poll the operation result at intervals as recommended by the API | 385 * method to poll the operation result at intervals as recommended by the API |
379 * service. | 386 * service. |
380 * | 387 * |
381 * Request parameters: | 388 * Request parameters: |
382 * | 389 * |
383 * [name] - The name of the operation resource. | 390 * [name] - The name of the operation resource. |
384 * Value must have pattern "^transferOperations/.*$". | 391 * Value must have pattern "^transferOperations/.+$". |
385 * | 392 * |
386 * Completes with a [Operation]. | 393 * Completes with a [Operation]. |
387 * | 394 * |
388 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 395 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
389 * error. | 396 * error. |
390 * | 397 * |
391 * If the used [http.Client] completes with an error when making a REST call, | 398 * If the used [http.Client] completes with an error when making a REST call, |
392 * this method will complete with the same error. | 399 * this method will complete with the same error. |
393 */ | 400 */ |
394 async.Future<Operation> get(core.String name) { | 401 async.Future<Operation> get(core.String name) { |
(...skipping 15 matching lines...) Expand all Loading... |
410 body: _body, | 417 body: _body, |
411 queryParams: _queryParams, | 418 queryParams: _queryParams, |
412 uploadOptions: _uploadOptions, | 419 uploadOptions: _uploadOptions, |
413 uploadMedia: _uploadMedia, | 420 uploadMedia: _uploadMedia, |
414 downloadOptions: _downloadOptions); | 421 downloadOptions: _downloadOptions); |
415 return _response.then((data) => new Operation.fromJson(data)); | 422 return _response.then((data) => new Operation.fromJson(data)); |
416 } | 423 } |
417 | 424 |
418 /** | 425 /** |
419 * Lists operations that match the specified filter in the request. If the | 426 * Lists operations that match the specified filter in the request. If the |
420 * server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the | 427 * server doesn't support this method, it returns `UNIMPLEMENTED`. |
421 * `name` binding below allows API services to override the binding to use | 428 * |
422 * different resource name schemes, such as `users / * /operations`. | 429 * NOTE: the `name` binding below allows API services to override the binding |
| 430 * to use different resource name schemes, such as `users / * /operations`. |
423 * | 431 * |
424 * Request parameters: | 432 * Request parameters: |
425 * | 433 * |
426 * [name] - The value `transferOperations`. | 434 * [name] - The value `transferOperations`. |
427 * Value must have pattern "^transferOperations$". | 435 * Value must have pattern "^transferOperations$". |
428 * | 436 * |
429 * [filter] - The standard list filter. | 437 * [filter] - A list of query parameters specified as JSON text in the form of |
| 438 * {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", |
| 439 * \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], |
| 440 * \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, |
| 441 * `operation_names`, and `transfer_statuses` support multiple values, they |
| 442 * must be specified with array notation. `job_names`, `operation_names`, and |
| 443 * `transfer_statuses` are optional. |
430 * | 444 * |
431 * [pageSize] - The standard list page size. | 445 * [pageToken] - The list page token. |
432 * | 446 * |
433 * [pageToken] - The standard list page token. | 447 * [pageSize] - The list page size. The max allowed value is 256. |
434 * | 448 * |
435 * Completes with a [ListOperationsResponse]. | 449 * Completes with a [ListOperationsResponse]. |
436 * | 450 * |
437 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 451 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
438 * error. | 452 * error. |
439 * | 453 * |
440 * If the used [http.Client] completes with an error when making a REST call, | 454 * If the used [http.Client] completes with an error when making a REST call, |
441 * this method will complete with the same error. | 455 * this method will complete with the same error. |
442 */ | 456 */ |
443 async.Future<ListOperationsResponse> list(core.String name, {core.String filte
r, core.int pageSize, core.String pageToken}) { | 457 async.Future<ListOperationsResponse> list(core.String name, {core.String filte
r, core.String pageToken, core.int pageSize}) { |
444 var _url = null; | 458 var _url = null; |
445 var _queryParams = new core.Map(); | 459 var _queryParams = new core.Map(); |
446 var _uploadMedia = null; | 460 var _uploadMedia = null; |
447 var _uploadOptions = null; | 461 var _uploadOptions = null; |
448 var _downloadOptions = commons.DownloadOptions.Metadata; | 462 var _downloadOptions = commons.DownloadOptions.Metadata; |
449 var _body = null; | 463 var _body = null; |
450 | 464 |
451 if (name == null) { | 465 if (name == null) { |
452 throw new core.ArgumentError("Parameter name is required."); | 466 throw new core.ArgumentError("Parameter name is required."); |
453 } | 467 } |
454 if (filter != null) { | 468 if (filter != null) { |
455 _queryParams["filter"] = [filter]; | 469 _queryParams["filter"] = [filter]; |
456 } | 470 } |
| 471 if (pageToken != null) { |
| 472 _queryParams["pageToken"] = [pageToken]; |
| 473 } |
457 if (pageSize != null) { | 474 if (pageSize != null) { |
458 _queryParams["pageSize"] = ["${pageSize}"]; | 475 _queryParams["pageSize"] = ["${pageSize}"]; |
459 } | 476 } |
460 if (pageToken != null) { | |
461 _queryParams["pageToken"] = [pageToken]; | |
462 } | |
463 | 477 |
464 _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); | 478 _url = 'v1/' + commons.Escaper.ecapeVariableReserved('$name'); |
465 | 479 |
466 var _response = _requester.request(_url, | 480 var _response = _requester.request(_url, |
467 "GET", | 481 "GET", |
468 body: _body, | 482 body: _body, |
469 queryParams: _queryParams, | 483 queryParams: _queryParams, |
470 uploadOptions: _uploadOptions, | 484 uploadOptions: _uploadOptions, |
471 uploadMedia: _uploadMedia, | 485 uploadMedia: _uploadMedia, |
472 downloadOptions: _downloadOptions); | 486 downloadOptions: _downloadOptions); |
473 return _response.then((data) => new ListOperationsResponse.fromJson(data)); | 487 return _response.then((data) => new ListOperationsResponse.fromJson(data)); |
474 } | 488 } |
475 | 489 |
476 /** | 490 /** |
477 * Pauses a transfer operation. | 491 * Pauses a transfer operation. |
478 * | 492 * |
479 * [request] - The metadata request object. | 493 * [request] - The metadata request object. |
480 * | 494 * |
481 * Request parameters: | 495 * Request parameters: |
482 * | 496 * |
483 * [name] - The name of the transfer operation. Required. | 497 * [name] - The name of the transfer operation. |
484 * Value must have pattern "^transferOperations/.*$". | 498 * Required. |
| 499 * Value must have pattern "^transferOperations/.+$". |
485 * | 500 * |
486 * Completes with a [Empty]. | 501 * Completes with a [Empty]. |
487 * | 502 * |
488 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 503 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
489 * error. | 504 * error. |
490 * | 505 * |
491 * If the used [http.Client] completes with an error when making a REST call, | 506 * If the used [http.Client] completes with an error when making a REST call, |
492 * this method will complete with the same error. | 507 * this method will complete with the same error. |
493 */ | 508 */ |
494 async.Future<Empty> pause(PauseTransferOperationRequest request, core.String n
ame) { | 509 async.Future<Empty> pause(PauseTransferOperationRequest request, core.String n
ame) { |
(...skipping 23 matching lines...) Expand all Loading... |
518 return _response.then((data) => new Empty.fromJson(data)); | 533 return _response.then((data) => new Empty.fromJson(data)); |
519 } | 534 } |
520 | 535 |
521 /** | 536 /** |
522 * Resumes a transfer operation that is paused. | 537 * Resumes a transfer operation that is paused. |
523 * | 538 * |
524 * [request] - The metadata request object. | 539 * [request] - The metadata request object. |
525 * | 540 * |
526 * Request parameters: | 541 * Request parameters: |
527 * | 542 * |
528 * [name] - The name of the transfer operation. Required. | 543 * [name] - The name of the transfer operation. |
529 * Value must have pattern "^transferOperations/.*$". | 544 * Required. |
| 545 * Value must have pattern "^transferOperations/.+$". |
530 * | 546 * |
531 * Completes with a [Empty]. | 547 * Completes with a [Empty]. |
532 * | 548 * |
533 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | 549 * Completes with a [commons.ApiRequestError] if the API endpoint returned an |
534 * error. | 550 * error. |
535 * | 551 * |
536 * If the used [http.Client] completes with an error when making a REST call, | 552 * If the used [http.Client] completes with an error when making a REST call, |
537 * this method will complete with the same error. | 553 * this method will complete with the same error. |
538 */ | 554 */ |
539 async.Future<Empty> resume(ResumeTransferOperationRequest request, core.String
name) { | 555 async.Future<Empty> resume(ResumeTransferOperationRequest request, core.String
name) { |
(...skipping 19 matching lines...) Expand all Loading... |
559 queryParams: _queryParams, | 575 queryParams: _queryParams, |
560 uploadOptions: _uploadOptions, | 576 uploadOptions: _uploadOptions, |
561 uploadMedia: _uploadMedia, | 577 uploadMedia: _uploadMedia, |
562 downloadOptions: _downloadOptions); | 578 downloadOptions: _downloadOptions); |
563 return _response.then((data) => new Empty.fromJson(data)); | 579 return _response.then((data) => new Empty.fromJson(data)); |
564 } | 580 } |
565 | 581 |
566 } | 582 } |
567 | 583 |
568 | 584 |
569 class V1ResourceApi { | |
570 final commons.ApiRequester _requester; | |
571 | |
572 V1ResourceApi(commons.ApiRequester client) : | |
573 _requester = client; | |
574 | |
575 /** | |
576 * Returns the Google service account that is used by Storage Transfer Service | |
577 * to access buckets in the project where transfers run or in other projects. | |
578 * Each Google service account is associated with one Google Developers | |
579 * Console project. Users should add this service account to the Google Cloud | |
580 * Storage bucket ACLs to grant access to Storage Transfer Service. This | |
581 * service account is created and owned by Storage Transfer Service and can | |
582 * only be used by Storage Transfer Service. | |
583 * | |
584 * Request parameters: | |
585 * | |
586 * [projectId] - The ID of the Google Developers Console project that the | |
587 * Google service account is associated with. Required. | |
588 * | |
589 * Completes with a [GoogleServiceAccount]. | |
590 * | |
591 * Completes with a [commons.ApiRequestError] if the API endpoint returned an | |
592 * error. | |
593 * | |
594 * If the used [http.Client] completes with an error when making a REST call, | |
595 * this method will complete with the same error. | |
596 */ | |
597 async.Future<GoogleServiceAccount> getGoogleServiceAccount({core.String projec
tId}) { | |
598 var _url = null; | |
599 var _queryParams = new core.Map(); | |
600 var _uploadMedia = null; | |
601 var _uploadOptions = null; | |
602 var _downloadOptions = commons.DownloadOptions.Metadata; | |
603 var _body = null; | |
604 | |
605 if (projectId != null) { | |
606 _queryParams["projectId"] = [projectId]; | |
607 } | |
608 | |
609 _url = 'v1:getGoogleServiceAccount'; | |
610 | |
611 var _response = _requester.request(_url, | |
612 "GET", | |
613 body: _body, | |
614 queryParams: _queryParams, | |
615 uploadOptions: _uploadOptions, | |
616 uploadMedia: _uploadMedia, | |
617 downloadOptions: _downloadOptions); | |
618 return _response.then((data) => new GoogleServiceAccount.fromJson(data)); | |
619 } | |
620 | |
621 } | |
622 | |
623 | |
624 | 585 |
625 /** | 586 /** |
626 * AWS access key (see [AWS Security | 587 * AWS access key (see |
| 588 * [AWS Security |
627 * Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-creden
tials.html)). | 589 * Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-creden
tials.html)). |
628 */ | 590 */ |
629 class AwsAccessKey { | 591 class AwsAccessKey { |
630 /** AWS access key ID. Required. */ | 592 /** |
| 593 * AWS access key ID. |
| 594 * Required. |
| 595 */ |
631 core.String accessKeyId; | 596 core.String accessKeyId; |
632 /** | 597 /** |
633 * AWS secret access key. This field is not returned in RPC responses. | 598 * AWS secret access key. This field is not returned in RPC responses. |
634 * Required. | 599 * Required. |
635 */ | 600 */ |
636 core.String secretAccessKey; | 601 core.String secretAccessKey; |
637 | 602 |
638 AwsAccessKey(); | 603 AwsAccessKey(); |
639 | 604 |
640 AwsAccessKey.fromJson(core.Map _json) { | 605 AwsAccessKey.fromJson(core.Map _json) { |
(...skipping 11 matching lines...) Expand all Loading... |
652 _json["accessKeyId"] = accessKeyId; | 617 _json["accessKeyId"] = accessKeyId; |
653 } | 618 } |
654 if (secretAccessKey != null) { | 619 if (secretAccessKey != null) { |
655 _json["secretAccessKey"] = secretAccessKey; | 620 _json["secretAccessKey"] = secretAccessKey; |
656 } | 621 } |
657 return _json; | 622 return _json; |
658 } | 623 } |
659 } | 624 } |
660 | 625 |
661 /** | 626 /** |
662 * An AwsS3Data can be a data source, but not a data sink. In an AwsS3Data, an | 627 * An AwsS3Data can be a data source, but not a data sink. |
663 * object's name is the S3 object's key name. | 628 * In an AwsS3Data, an object's name is the S3 object's key name. |
664 */ | 629 */ |
665 class AwsS3Data { | 630 class AwsS3Data { |
666 /** | 631 /** |
667 * AWS access key used to sign the API requests to the AWS S3 bucket. | 632 * AWS access key used to sign the API requests to the AWS S3 bucket. |
668 * Permissions on the bucket must be granted to the access ID of the AWS | 633 * Permissions on the bucket must be granted to the access ID of the |
669 * access key. Required. | 634 * AWS access key. |
| 635 * Required. |
670 */ | 636 */ |
671 AwsAccessKey awsAccessKey; | 637 AwsAccessKey awsAccessKey; |
672 /** | 638 /** |
673 * S3 Bucket name (see [Creating a | 639 * S3 Bucket name (see |
| 640 * [Creating a |
674 * bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-lo
cation-example.html)). | 641 * bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-lo
cation-example.html)). |
675 * Required. | 642 * Required. |
676 */ | 643 */ |
677 core.String bucketName; | 644 core.String bucketName; |
678 | 645 |
679 AwsS3Data(); | 646 AwsS3Data(); |
680 | 647 |
681 AwsS3Data.fromJson(core.Map _json) { | 648 AwsS3Data.fromJson(core.Map _json) { |
682 if (_json.containsKey("awsAccessKey")) { | 649 if (_json.containsKey("awsAccessKey")) { |
683 awsAccessKey = new AwsAccessKey.fromJson(_json["awsAccessKey"]); | 650 awsAccessKey = new AwsAccessKey.fromJson(_json["awsAccessKey"]); |
(...skipping 10 matching lines...) Expand all Loading... |
694 } | 661 } |
695 if (bucketName != null) { | 662 if (bucketName != null) { |
696 _json["bucketName"] = bucketName; | 663 _json["bucketName"] = bucketName; |
697 } | 664 } |
698 return _json; | 665 return _json; |
699 } | 666 } |
700 } | 667 } |
701 | 668 |
702 /** | 669 /** |
703 * Represents a whole calendar date, e.g. date of birth. The time of day and | 670 * Represents a whole calendar date, e.g. date of birth. The time of day and |
704 * time zone are either specified elsewhere or are not significant. The date is | 671 * time zone are either specified elsewhere or are not significant. The date |
705 * relative to the Proleptic Gregorian Calendar. The day may be 0 to represent a | 672 * is relative to the Proleptic Gregorian Calendar. The day may be 0 to |
706 * year and month where the day is not significant, e.g. credit card expiration | 673 * represent a year and month where the day is not significant, e.g. credit card |
707 * date. The year may be 0 to represent a month and day independent of year, | 674 * expiration date. The year may be 0 to represent a month and day independent |
708 * e.g. anniversary date. Related types are | 675 * of year, e.g. anniversary date. Related types are google.type.TimeOfDay |
709 * [google.type.TimeOfDay][google.type.TimeOfDay] and | 676 * and `google.protobuf.Timestamp`. |
710 * `google.protobuf.Timestamp`. | |
711 */ | 677 */ |
712 class Date { | 678 class Date { |
713 /** | 679 /** |
714 * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 | 680 * Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
715 * if specifying a year/month where the day is not sigificant. | 681 * if specifying a year/month where the day is not significant. |
716 */ | 682 */ |
717 core.int day; | 683 core.int day; |
718 /** Month of year of date. Must be from 1 to 12. */ | 684 /** Month of year. Must be from 1 to 12. */ |
719 core.int month; | 685 core.int month; |
720 /** | 686 /** |
721 * Year of date. Must be from 1 to 9,999, or 0 if specifying a date without a | 687 * Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
722 * year. | 688 * a year. |
723 */ | 689 */ |
724 core.int year; | 690 core.int year; |
725 | 691 |
726 Date(); | 692 Date(); |
727 | 693 |
728 Date.fromJson(core.Map _json) { | 694 Date.fromJson(core.Map _json) { |
729 if (_json.containsKey("day")) { | 695 if (_json.containsKey("day")) { |
730 day = _json["day"]; | 696 day = _json["day"]; |
731 } | 697 } |
732 if (_json.containsKey("month")) { | 698 if (_json.containsKey("month")) { |
(...skipping 14 matching lines...) Expand all Loading... |
747 } | 713 } |
748 if (year != null) { | 714 if (year != null) { |
749 _json["year"] = year; | 715 _json["year"] = year; |
750 } | 716 } |
751 return _json; | 717 return _json; |
752 } | 718 } |
753 } | 719 } |
754 | 720 |
755 /** | 721 /** |
756 * A generic empty message that you can re-use to avoid defining duplicated | 722 * A generic empty message that you can re-use to avoid defining duplicated |
757 * empty messages in your APIs. A typical example is to use it as the request or | 723 * empty messages in your APIs. A typical example is to use it as the request |
758 * the response type of an API method. For instance: service Foo { rpc | 724 * or the response type of an API method. For instance: |
759 * Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON | 725 * |
760 * representation for `Empty` is empty JSON object `{}`. | 726 * service Foo { |
| 727 * rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 728 * } |
| 729 * |
| 730 * The JSON representation for `Empty` is empty JSON object `{}`. |
761 */ | 731 */ |
762 class Empty { | 732 class Empty { |
763 | 733 |
764 Empty(); | 734 Empty(); |
765 | 735 |
766 Empty.fromJson(core.Map _json) { | 736 Empty.fromJson(core.Map _json) { |
767 } | 737 } |
768 | 738 |
769 core.Map toJson() { | 739 core.Map toJson() { |
770 var _json = new core.Map(); | 740 var _json = new core.Map(); |
771 return _json; | 741 return _json; |
772 } | 742 } |
773 } | 743 } |
774 | 744 |
775 /** An entry describing an error that has occurred. */ | 745 /** An entry describing an error that has occurred. */ |
776 class ErrorLogEntry { | 746 class ErrorLogEntry { |
777 /** A list of messages that carry the error details. */ | 747 /** A list of messages that carry the error details. */ |
778 core.List<core.String> errorDetails; | 748 core.List<core.String> errorDetails; |
779 /** | 749 /** |
780 * A URL that refers to the target (a data source, a data sink, or an object) | 750 * A URL that refers to the target (a data source, a data sink, |
781 * with which the error is associated. Required. | 751 * or an object) with which the error is associated. |
| 752 * Required. |
782 */ | 753 */ |
783 core.String url; | 754 core.String url; |
784 | 755 |
785 ErrorLogEntry(); | 756 ErrorLogEntry(); |
786 | 757 |
787 ErrorLogEntry.fromJson(core.Map _json) { | 758 ErrorLogEntry.fromJson(core.Map _json) { |
788 if (_json.containsKey("errorDetails")) { | 759 if (_json.containsKey("errorDetails")) { |
789 errorDetails = _json["errorDetails"]; | 760 errorDetails = _json["errorDetails"]; |
790 } | 761 } |
791 if (_json.containsKey("url")) { | 762 if (_json.containsKey("url")) { |
792 url = _json["url"]; | 763 url = _json["url"]; |
793 } | 764 } |
794 } | 765 } |
795 | 766 |
796 core.Map toJson() { | 767 core.Map toJson() { |
797 var _json = new core.Map(); | 768 var _json = new core.Map(); |
798 if (errorDetails != null) { | 769 if (errorDetails != null) { |
799 _json["errorDetails"] = errorDetails; | 770 _json["errorDetails"] = errorDetails; |
800 } | 771 } |
801 if (url != null) { | 772 if (url != null) { |
802 _json["url"] = url; | 773 _json["url"] = url; |
803 } | 774 } |
804 return _json; | 775 return _json; |
805 } | 776 } |
806 } | 777 } |
807 | 778 |
808 /** | 779 /** |
809 * A summary of errors by error code, plus a count and sample error log entries. | 780 * A summary of errors by error code, plus a count and sample error log |
| 781 * entries. |
810 */ | 782 */ |
811 class ErrorSummary { | 783 class ErrorSummary { |
812 /** | 784 /** |
813 * Required. | 785 * Required. |
814 * Possible string values are: | 786 * Possible string values are: |
815 * - "OK" : A OK. | 787 * - "OK" : Not an error; returned on success |
816 * - "CANCELLED" : A CANCELLED. | 788 * |
817 * - "UNKNOWN" : A UNKNOWN. | 789 * HTTP Mapping: 200 OK |
818 * - "INVALID_ARGUMENT" : A INVALID_ARGUMENT. | 790 * - "CANCELLED" : The operation was cancelled, typically by the caller. |
819 * - "DEADLINE_EXCEEDED" : A DEADLINE_EXCEEDED. | 791 * |
820 * - "NOT_FOUND" : A NOT_FOUND. | 792 * HTTP Mapping: 499 Client Closed Request |
821 * - "ALREADY_EXISTS" : A ALREADY_EXISTS. | 793 * - "UNKNOWN" : Unknown error. For example, this error may be returned when |
822 * - "PERMISSION_DENIED" : A PERMISSION_DENIED. | 794 * a `Status` value received from another address space belongs to |
823 * - "UNAUTHENTICATED" : A UNAUTHENTICATED. | 795 * an error space that is not known in this address space. Also |
824 * - "RESOURCE_EXHAUSTED" : A RESOURCE_EXHAUSTED. | 796 * errors raised by APIs that do not return enough error information |
825 * - "FAILED_PRECONDITION" : A FAILED_PRECONDITION. | 797 * may be converted to this error. |
826 * - "ABORTED" : A ABORTED. | 798 * |
827 * - "OUT_OF_RANGE" : A OUT_OF_RANGE. | 799 * HTTP Mapping: 500 Internal Server Error |
828 * - "UNIMPLEMENTED" : A UNIMPLEMENTED. | 800 * - "INVALID_ARGUMENT" : The client specified an invalid argument. Note that |
829 * - "INTERNAL" : A INTERNAL. | 801 * this differs |
830 * - "UNAVAILABLE" : A UNAVAILABLE. | 802 * from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments |
831 * - "DATA_LOSS" : A DATA_LOSS. | 803 * that are problematic regardless of the state of the system |
| 804 * (e.g., a malformed file name). |
| 805 * |
| 806 * HTTP Mapping: 400 Bad Request |
| 807 * - "DEADLINE_EXCEEDED" : The deadline expired before the operation could |
| 808 * complete. For operations |
| 809 * that change the state of the system, this error may be returned |
| 810 * even if the operation has completed successfully. For example, a |
| 811 * successful response from a server could have been delayed long |
| 812 * enough for the deadline to expire. |
| 813 * |
| 814 * HTTP Mapping: 504 Gateway Timeout |
| 815 * - "NOT_FOUND" : Some requested entity (e.g., file or directory) was not |
| 816 * found. |
| 817 * |
| 818 * Note to server developers: if a request is denied for an entire class |
| 819 * of users, such as gradual feature rollout or undocumented whitelist, |
| 820 * `NOT_FOUND` may be used. If a request is denied for some users within |
| 821 * a class of users, such as user-based access control, `PERMISSION_DENIED` |
| 822 * must be used. |
| 823 * |
| 824 * HTTP Mapping: 404 Not Found |
| 825 * - "ALREADY_EXISTS" : The entity that a client attempted to create (e.g., |
| 826 * file or directory) |
| 827 * already exists. |
| 828 * |
| 829 * HTTP Mapping: 409 Conflict |
| 830 * - "PERMISSION_DENIED" : The caller does not have permission to execute the |
| 831 * specified |
| 832 * operation. `PERMISSION_DENIED` must not be used for rejections |
| 833 * caused by exhausting some resource (use `RESOURCE_EXHAUSTED` |
| 834 * instead for those errors). `PERMISSION_DENIED` must not be |
| 835 * used if the caller can not be identified (use `UNAUTHENTICATED` |
| 836 * instead for those errors). This error code does not imply the |
| 837 * request is valid or the requested entity exists or satisfies |
| 838 * other pre-conditions. |
| 839 * |
| 840 * HTTP Mapping: 403 Forbidden |
| 841 * - "UNAUTHENTICATED" : The request does not have valid authentication |
| 842 * credentials for the |
| 843 * operation. |
| 844 * |
| 845 * HTTP Mapping: 401 Unauthorized |
| 846 * - "RESOURCE_EXHAUSTED" : Some resource has been exhausted, perhaps a |
| 847 * per-user quota, or |
| 848 * perhaps the entire file system is out of space. |
| 849 * |
| 850 * HTTP Mapping: 429 Too Many Requests |
| 851 * - "FAILED_PRECONDITION" : The operation was rejected because the system is |
| 852 * not in a state |
| 853 * required for the operation's execution. For example, the directory |
| 854 * to be deleted is non-empty, an rmdir operation is applied to |
| 855 * a non-directory, etc. |
| 856 * |
| 857 * Service implementors can use the following guidelines to decide |
| 858 * between `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`: |
| 859 * (a) Use `UNAVAILABLE` if the client can retry just the failing call. |
| 860 * (b) Use `ABORTED` if the client should retry at a higher level |
| 861 * (e.g., when a client-specified test-and-set fails, indicating the |
| 862 * client should restart a read-modify-write sequence). |
| 863 * (c) Use `FAILED_PRECONDITION` if the client should not retry until |
| 864 * the system state has been explicitly fixed. E.g., if an "rmdir" |
| 865 * fails because the directory is non-empty, `FAILED_PRECONDITION` |
| 866 * should be returned since the client should not retry unless |
| 867 * the files are deleted from the directory. |
| 868 * |
| 869 * HTTP Mapping: 400 Bad Request |
| 870 * - "ABORTED" : The operation was aborted, typically due to a concurrency |
| 871 * issue such as |
| 872 * a sequencer check failure or transaction abort. |
| 873 * |
| 874 * See the guidelines above for deciding between `FAILED_PRECONDITION`, |
| 875 * `ABORTED`, and `UNAVAILABLE`. |
| 876 * |
| 877 * HTTP Mapping: 409 Conflict |
| 878 * - "OUT_OF_RANGE" : The operation was attempted past the valid range. E.g., |
| 879 * seeking or |
| 880 * reading past end-of-file. |
| 881 * |
| 882 * Unlike `INVALID_ARGUMENT`, this error indicates a problem that may |
| 883 * be fixed if the system state changes. For example, a 32-bit file |
| 884 * system will generate `INVALID_ARGUMENT` if asked to read at an |
| 885 * offset that is not in the range [0,2^32-1], but it will generate |
| 886 * `OUT_OF_RANGE` if asked to read from an offset past the current |
| 887 * file size. |
| 888 * |
| 889 * There is a fair bit of overlap between `FAILED_PRECONDITION` and |
| 890 * `OUT_OF_RANGE`. We recommend using `OUT_OF_RANGE` (the more specific |
| 891 * error) when it applies so that callers who are iterating through |
| 892 * a space can easily look for an `OUT_OF_RANGE` error to detect when |
| 893 * they are done. |
| 894 * |
| 895 * HTTP Mapping: 400 Bad Request |
| 896 * - "UNIMPLEMENTED" : The operation is not implemented or is not |
| 897 * supported/enabled in this |
| 898 * service. |
| 899 * |
| 900 * HTTP Mapping: 501 Not Implemented |
| 901 * - "INTERNAL" : Internal errors. This means that some invariants expected |
| 902 * by the |
| 903 * underlying system have been broken. This error code is reserved |
| 904 * for serious errors. |
| 905 * |
| 906 * HTTP Mapping: 500 Internal Server Error |
| 907 * - "UNAVAILABLE" : The service is currently unavailable. This is most |
| 908 * likely a |
| 909 * transient condition, which can be corrected by retrying with |
| 910 * a backoff. |
| 911 * |
| 912 * See the guidelines above for deciding between `FAILED_PRECONDITION`, |
| 913 * `ABORTED`, and `UNAVAILABLE`. |
| 914 * |
| 915 * HTTP Mapping: 503 Service Unavailable |
| 916 * - "DATA_LOSS" : Unrecoverable data loss or corruption. |
| 917 * |
| 918 * HTTP Mapping: 500 Internal Server Error |
832 */ | 919 */ |
833 core.String errorCode; | 920 core.String errorCode; |
834 /** Count of this type of error. Required. */ | 921 /** |
| 922 * Count of this type of error. |
| 923 * Required. |
| 924 */ |
835 core.String errorCount; | 925 core.String errorCount; |
836 /** Error samples. */ | 926 /** Error samples. */ |
837 core.List<ErrorLogEntry> errorLogEntries; | 927 core.List<ErrorLogEntry> errorLogEntries; |
838 | 928 |
839 ErrorSummary(); | 929 ErrorSummary(); |
840 | 930 |
841 ErrorSummary.fromJson(core.Map _json) { | 931 ErrorSummary.fromJson(core.Map _json) { |
842 if (_json.containsKey("errorCode")) { | 932 if (_json.containsKey("errorCode")) { |
843 errorCode = _json["errorCode"]; | 933 errorCode = _json["errorCode"]; |
844 } | 934 } |
(...skipping 20 matching lines...) Expand all Loading... |
865 } | 955 } |
866 } | 956 } |
867 | 957 |
868 /** | 958 /** |
869 * In a GcsData, an object's name is the Google Cloud Storage object's name and | 959 * In a GcsData, an object's name is the Google Cloud Storage object's name and |
870 * its `lastModificationTime` refers to the object's updated time, which changes | 960 * its `lastModificationTime` refers to the object's updated time, which changes |
871 * when the content or the metadata of the object is updated. | 961 * when the content or the metadata of the object is updated. |
872 */ | 962 */ |
873 class GcsData { | 963 class GcsData { |
874 /** | 964 /** |
875 * Google Cloud Storage bucket name (see [Bucket Name | 965 * Google Cloud Storage bucket name (see |
| 966 * [Bucket Name |
876 * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requireme
nts)). | 967 * Requirements](https://cloud.google.com/storage/docs/bucket-naming#requireme
nts)). |
877 * Required. | 968 * Required. |
878 */ | 969 */ |
879 core.String bucketName; | 970 core.String bucketName; |
880 | 971 |
881 GcsData(); | 972 GcsData(); |
882 | 973 |
883 GcsData.fromJson(core.Map _json) { | 974 GcsData.fromJson(core.Map _json) { |
884 if (_json.containsKey("bucketName")) { | 975 if (_json.containsKey("bucketName")) { |
885 bucketName = _json["bucketName"]; | 976 bucketName = _json["bucketName"]; |
(...skipping 26 matching lines...) Expand all Loading... |
912 var _json = new core.Map(); | 1003 var _json = new core.Map(); |
913 if (accountEmail != null) { | 1004 if (accountEmail != null) { |
914 _json["accountEmail"] = accountEmail; | 1005 _json["accountEmail"] = accountEmail; |
915 } | 1006 } |
916 return _json; | 1007 return _json; |
917 } | 1008 } |
918 } | 1009 } |
919 | 1010 |
920 /** | 1011 /** |
921 * An HttpData specifies a list of objects on the web to be transferred over | 1012 * An HttpData specifies a list of objects on the web to be transferred over |
922 * HTTP. The information of the objects to be transferred is contained in a file | 1013 * HTTP. The information of the objects to be transferred is contained in a |
923 * referenced by a URL. The first line in the file must be "TsvHttpData-1.0", | 1014 * file referenced by a URL. The first line in the file must be |
924 * which specifies the format of the file. Subsequent lines specify the | 1015 * "TsvHttpData-1.0", which specifies the format of the file. Subsequent lines |
925 * information of the list of objects, one object per list entry. Each entry has | 1016 * specify the information of the list of objects, one object per list entry. |
926 * the following tab-delimited fields: * HTTP URL * Length * MD5 - This field is | 1017 * Each entry has the following tab-delimited fields: |
927 * a base64-encoded MD5 hash of the object An HTTP URL that points to the object | 1018 * |
928 * to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When | 1019 * * HTTP URL - The location of the object. |
929 * an object with URL `http(s)://hostname:port/` is transferred to the data | 1020 * |
930 * sink, the name of the object at the data sink is `/`. Length and MD5 provide | 1021 * * Length - The size of the object in bytes. |
931 * the size and the base64-encoded MD5 hash of the object. If Length does not | 1022 * |
932 * match the actual length of the object fetched, the object will not be | 1023 * * MD5 - The base64-encoded MD5 hash of the object. |
933 * transferred. If MD5 does not match the MD5 computed from the transferred | 1024 * |
934 * bytes, the object transfer will fail. `lastModificationTime` is not available | 1025 * For an example of a valid TSV file, see |
935 * in HttpData objects. The objects that the URL list points to must allow | 1026 * [Transferring data from |
936 * public access. Storage Transfer Service obeys `robots.txt` rules and requires | 1027 * URLs](https://cloud.google.com/storage/transfer/#urls) |
937 * the HTTP server to support Range requests and to return a Content-Length | 1028 * |
| 1029 * When transferring data based on a URL list, keep the following in mind: |
| 1030 * |
| 1031 * * When an object located at `http(s)://hostname:port/<URL-path>` is |
| 1032 * transferred |
| 1033 * to a data sink, the name of the object at the data sink is |
| 1034 * `<hostname>/<URL-path>`. |
| 1035 * |
| 1036 * * If the specified size of an object does not match the actual size of the |
| 1037 * object fetched, the object will not be transferred. |
| 1038 * |
| 1039 * * If the specified MD5 does not match the MD5 computed from the transferred |
| 1040 * bytes, the object transfer will fail. For more information, see |
| 1041 * [Generating MD5 hashes](https://cloud.google.com/storage/transfer/#md5) |
| 1042 * |
| 1043 * * Ensure that each URL you specify is publicly accessible. For |
| 1044 * example, in Google Cloud Storage you can |
| 1045 * [share an object publicly] |
| 1046 * (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get |
| 1047 * a link to it. |
| 1048 * |
| 1049 * * Storage Transfer Service obeys `robots.txt` rules and requires the source |
| 1050 * HTTP server to support `Range` requests and to return a `Content-Length` |
938 * header in each response. | 1051 * header in each response. |
| 1052 * |
| 1053 * * [ObjectConditions](#ObjectConditions) have no effect when filtering objects |
| 1054 * to transfer. |
939 */ | 1055 */ |
940 class HttpData { | 1056 class HttpData { |
941 /** | 1057 /** |
942 * The URL that points to the file that stores the object list entries. This | 1058 * The URL that points to the file that stores the object list entries. |
943 * file must allow public access. Currently, only URLs with HTTP and HTTPS | 1059 * This file must allow public access. Currently, only URLs with HTTP and |
944 * schemes are supported. Required. | 1060 * HTTPS schemes are supported. |
| 1061 * Required. |
945 */ | 1062 */ |
946 core.String listUrl; | 1063 core.String listUrl; |
947 | 1064 |
948 HttpData(); | 1065 HttpData(); |
949 | 1066 |
950 HttpData.fromJson(core.Map _json) { | 1067 HttpData.fromJson(core.Map _json) { |
951 if (_json.containsKey("listUrl")) { | 1068 if (_json.containsKey("listUrl")) { |
952 listUrl = _json["listUrl"]; | 1069 listUrl = _json["listUrl"]; |
953 } | 1070 } |
954 } | 1071 } |
955 | 1072 |
956 core.Map toJson() { | 1073 core.Map toJson() { |
957 var _json = new core.Map(); | 1074 var _json = new core.Map(); |
958 if (listUrl != null) { | 1075 if (listUrl != null) { |
959 _json["listUrl"] = listUrl; | 1076 _json["listUrl"] = listUrl; |
960 } | 1077 } |
961 return _json; | 1078 return _json; |
962 } | 1079 } |
963 } | 1080 } |
964 | 1081 |
965 /** | 1082 /** The response message for Operations.ListOperations. */ |
966 * The response message for | |
967 * [Operations.ListOperations][google.longrunning.Operations.ListOperations]. | |
968 */ | |
969 class ListOperationsResponse { | 1083 class ListOperationsResponse { |
970 /** The standard List next-page token. */ | 1084 /** The standard List next-page token. */ |
971 core.String nextPageToken; | 1085 core.String nextPageToken; |
972 /** A list of operations that matches the specified filter in the request. */ | 1086 /** A list of operations that matches the specified filter in the request. */ |
973 core.List<Operation> operations; | 1087 core.List<Operation> operations; |
974 | 1088 |
975 ListOperationsResponse(); | 1089 ListOperationsResponse(); |
976 | 1090 |
977 ListOperationsResponse.fromJson(core.Map _json) { | 1091 ListOperationsResponse.fromJson(core.Map _json) { |
978 if (_json.containsKey("nextPageToken")) { | 1092 if (_json.containsKey("nextPageToken")) { |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1022 _json["transferJobs"] = transferJobs.map((value) => (value).toJson()).toLi
st(); | 1136 _json["transferJobs"] = transferJobs.map((value) => (value).toJson()).toLi
st(); |
1023 } | 1137 } |
1024 return _json; | 1138 return _json; |
1025 } | 1139 } |
1026 } | 1140 } |
1027 | 1141 |
1028 /** Conditions that determine which objects will be transferred. */ | 1142 /** Conditions that determine which objects will be transferred. */ |
1029 class ObjectConditions { | 1143 class ObjectConditions { |
1030 /** | 1144 /** |
1031 * `excludePrefixes` must follow the requirements described for | 1145 * `excludePrefixes` must follow the requirements described for |
1032 * `includePrefixes`. The max size of `excludePrefixes` is 20. | 1146 * `includePrefixes`. |
| 1147 * |
| 1148 * The max size of `excludePrefixes` is 1000. |
1033 */ | 1149 */ |
1034 core.List<core.String> excludePrefixes; | 1150 core.List<core.String> excludePrefixes; |
1035 /** | 1151 /** |
1036 * If `includePrefixes` is specified, objects that satisfy the object | 1152 * If `includePrefixes` is specified, objects that satisfy the object |
1037 * conditions must have names that start with one of the `includePrefixes` and | 1153 * conditions must have names that start with one of the `includePrefixes` |
1038 * that do not start with any of the `excludePrefixes`. If `includePrefixes` | 1154 * and that do not start with any of the `excludePrefixes`. If |
| 1155 * `includePrefixes` |
1039 * is not specified, all objects except those that have names starting with | 1156 * is not specified, all objects except those that have names starting with |
1040 * one of the `excludePrefixes` must satisfy the object conditions. | 1157 * one of the `excludePrefixes` must satisfy the object conditions. |
1041 * Requirements: * Each include-prefix and exclude-prefix can contain any | 1158 * |
1042 * sequence of Unicode characters, of max length 1024 bytes when UTF8-encoded, | 1159 * Requirements: |
1043 * and must not contain Carriage Return or Line Feed characters. Wildcard | 1160 * |
1044 * matching and regular expression matching are not supported. * None of the | 1161 * * Each include-prefix and exclude-prefix can contain any sequence of |
1045 * include-prefix or the exclude-prefix values can be empty, if specified. * | 1162 * Unicode characters, of max length 1024 bytes when UTF8-encoded, and |
1046 * Each include-prefix must include a distinct portion of the object | 1163 * must not contain Carriage Return or Line Feed characters. Wildcard |
1047 * namespace, i.e., no include-prefix may be a prefix of another | 1164 * matching and regular expression matching are not supported. |
1048 * include-prefix. * Each exclude-prefix must exclude a distinct portion of | 1165 * |
1049 * the object namespace, i.e., no exclude-prefix may be a prefix of another | 1166 * * Each include-prefix and exclude-prefix must omit the leading slash. |
1050 * exclude-prefix. * If `includePrefixes` is specified, then each | 1167 * For example, to include the `requests.gz` object in a transfer from |
1051 * exclude-prefix must start with the value of a path explicitly included by | 1168 * `s3://my-aws-bucket/logs/y=2015/requests.gz`, specify the include |
1052 * `includePrefixes`. The max size of `includePrefixes` is 20. | 1169 * prefix as `logs/y=2015/requests.gz`. |
| 1170 * |
| 1171 * * None of the include-prefix or the exclude-prefix values can be empty, |
| 1172 * if specified. |
| 1173 * |
| 1174 * * Each include-prefix must include a distinct portion of the object |
| 1175 * namespace, i.e., no include-prefix may be a prefix of another |
| 1176 * include-prefix. |
| 1177 * |
| 1178 * * Each exclude-prefix must exclude a distinct portion of the object |
| 1179 * namespace, i.e., no exclude-prefix may be a prefix of another |
| 1180 * exclude-prefix. |
| 1181 * |
| 1182 * * If `includePrefixes` is specified, then each exclude-prefix must start |
| 1183 * with the value of a path explicitly included by `includePrefixes`. |
| 1184 * |
| 1185 * The max size of `includePrefixes` is 1000. |
1053 */ | 1186 */ |
1054 core.List<core.String> includePrefixes; | 1187 core.List<core.String> includePrefixes; |
1055 /** | 1188 /** |
1056 * `maxTimeElapsedSinceLastModification` is the complement to | 1189 * `maxTimeElapsedSinceLastModification` is the complement to |
1057 * `minTimeElapsedSinceLastModification`. | 1190 * `minTimeElapsedSinceLastModification`. |
1058 */ | 1191 */ |
1059 core.String maxTimeElapsedSinceLastModification; | 1192 core.String maxTimeElapsedSinceLastModification; |
1060 /** | 1193 /** |
1061 * If unspecified, `minTimeElapsedSinceLastModification` takes a zero value | 1194 * If unspecified, `minTimeElapsedSinceLastModification` takes a zero value |
1062 * and `maxTimeElapsedSinceLastModification` takes the maximum possible value | 1195 * and `maxTimeElapsedSinceLastModification` takes the maximum possible |
1063 * of Duration. Objects that satisfy the object conditions must either have a | 1196 * value of Duration. Objects that satisfy the object conditions |
1064 * `lastModificationTime` greater or equal to `NOW` - | 1197 * must either have a `lastModificationTime` greater or equal to |
1065 * `maxTimeElapsedSinceLastModification` and less than `NOW` - | 1198 * `NOW` - `maxTimeElapsedSinceLastModification` and less than |
1066 * `minTimeElapsedSinceLastModification`, or not have a | 1199 * `NOW` - `minTimeElapsedSinceLastModification`, or not have a |
1067 * `lastModificationTime`. | 1200 * `lastModificationTime`. |
1068 */ | 1201 */ |
1069 core.String minTimeElapsedSinceLastModification; | 1202 core.String minTimeElapsedSinceLastModification; |
1070 | 1203 |
1071 ObjectConditions(); | 1204 ObjectConditions(); |
1072 | 1205 |
1073 ObjectConditions.fromJson(core.Map _json) { | 1206 ObjectConditions.fromJson(core.Map _json) { |
1074 if (_json.containsKey("excludePrefixes")) { | 1207 if (_json.containsKey("excludePrefixes")) { |
1075 excludePrefixes = _json["excludePrefixes"]; | 1208 excludePrefixes = _json["excludePrefixes"]; |
1076 } | 1209 } |
(...skipping 25 matching lines...) Expand all Loading... |
1102 return _json; | 1235 return _json; |
1103 } | 1236 } |
1104 } | 1237 } |
1105 | 1238 |
1106 /** | 1239 /** |
1107 * This resource represents a long-running operation that is the result of a | 1240 * This resource represents a long-running operation that is the result of a |
1108 * network API call. | 1241 * network API call. |
1109 */ | 1242 */ |
1110 class Operation { | 1243 class Operation { |
1111 /** | 1244 /** |
1112 * If the value is `false`, it means the operation is still in progress. If | 1245 * If the value is `false`, it means the operation is still in progress. |
1113 * true, the operation is completed and the `result` is available. | 1246 * If true, the operation is completed, and either `error` or `response` is |
| 1247 * available. |
1114 */ | 1248 */ |
1115 core.bool done; | 1249 core.bool done; |
1116 /** The error result of the operation in case of failure. */ | 1250 /** The error result of the operation in case of failure or cancellation. */ |
1117 Status error; | 1251 Status error; |
1118 /** | 1252 /** |
1119 * Represents the transfer operation object. | 1253 * Represents the transfer operation object. |
1120 * | 1254 * |
1121 * The values for Object must be JSON objects. It can consist of `num`, | 1255 * The values for Object must be JSON objects. It can consist of `num`, |
1122 * `String`, `bool` and `null` as well as `Map` and `List` values. | 1256 * `String`, `bool` and `null` as well as `Map` and `List` values. |
1123 */ | 1257 */ |
1124 core.Map<core.String, core.Object> metadata; | 1258 core.Map<core.String, core.Object> metadata; |
1125 /** | 1259 /** |
1126 * The server-assigned name, which is only unique within the same service that | 1260 * The server-assigned name, which is only unique within the same service that |
1127 * originally returns it. If you use the default HTTP mapping above, the | 1261 * originally returns it. If you use the default HTTP mapping, the `name` |
1128 * `name` should have the format of `operations/some/unique/name`. | 1262 * should have the format of `transferOperations/some/unique/name`. |
1129 */ | 1263 */ |
1130 core.String name; | 1264 core.String name; |
1131 /** | 1265 /** |
1132 * The normal response of the operation in case of success. If the original | 1266 * The normal response of the operation in case of success. If the original |
1133 * method returns no data on success, such as `Delete`, the response is | 1267 * method returns no data on success, such as `Delete`, the response is |
1134 * `google.protobuf.Empty`. If the original method is standard | 1268 * `google.protobuf.Empty`. If the original method is standard |
1135 * `Get`/`Create`/`Update`, the response should be the resource. For other | 1269 * `Get`/`Create`/`Update`, the response should be the resource. For other |
1136 * methods, the response should have the type `XxxResponse`, where `Xxx` is | 1270 * methods, the response should have the type `XxxResponse`, where `Xxx` |
1137 * the original method name. For example, if the original method name is | 1271 * is the original method name. For example, if the original method name |
1138 * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. | 1272 * is `TakeSnapshot()`, the inferred response type is |
| 1273 * `TakeSnapshotResponse`. |
1139 * | 1274 * |
1140 * The values for Object must be JSON objects. It can consist of `num`, | 1275 * The values for Object must be JSON objects. It can consist of `num`, |
1141 * `String`, `bool` and `null` as well as `Map` and `List` values. | 1276 * `String`, `bool` and `null` as well as `Map` and `List` values. |
1142 */ | 1277 */ |
1143 core.Map<core.String, core.Object> response; | 1278 core.Map<core.String, core.Object> response; |
1144 | 1279 |
1145 Operation(); | 1280 Operation(); |
1146 | 1281 |
1147 Operation.fromJson(core.Map _json) { | 1282 Operation.fromJson(core.Map _json) { |
1148 if (_json.containsKey("done")) { | 1283 if (_json.containsKey("done")) { |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1207 | 1342 |
1208 core.Map toJson() { | 1343 core.Map toJson() { |
1209 var _json = new core.Map(); | 1344 var _json = new core.Map(); |
1210 return _json; | 1345 return _json; |
1211 } | 1346 } |
1212 } | 1347 } |
1213 | 1348 |
1214 /** Transfers can be scheduled to recur or to run just once. */ | 1349 /** Transfers can be scheduled to recur or to run just once. */ |
1215 class Schedule { | 1350 class Schedule { |
1216 /** | 1351 /** |
1217 * The last day the recurring transfer will be run. If `scheduleEndDate` is | 1352 * The last day the recurring transfer will be run. If `scheduleEndDate` |
1218 * the same as `scheduleStartDate`, the transfer will be executed only once. | 1353 * is the same as `scheduleStartDate`, the transfer will be executed only |
| 1354 * once. |
1219 */ | 1355 */ |
1220 Date scheduleEndDate; | 1356 Date scheduleEndDate; |
1221 /** The first day the recurring transfer is scheduled to run. Required. */ | 1357 /** |
| 1358 * The first day the recurring transfer is scheduled to run. If |
| 1359 * `scheduleStartDate` is in the past, the transfer will run for the first |
| 1360 * time on the following day. |
| 1361 * Required. |
| 1362 */ |
1222 Date scheduleStartDate; | 1363 Date scheduleStartDate; |
1223 /** | 1364 /** |
1224 * The time in UTC at which the transfer will be scheduled to start in a day. | 1365 * The time in UTC at which the transfer will be scheduled to start in a day. |
1225 * Transfers may start later than this time. If not specified, transfers are | 1366 * Transfers may start later than this time. If not specified, recurring and |
1226 * scheduled to start at midnight UTC. | 1367 * one-time transfers that are scheduled to run today will run immediately; |
| 1368 * recurring transfers that are scheduled to run on a future date will start |
| 1369 * at approximately midnight UTC on that date. Note that when configuring a |
| 1370 * transfer with the Cloud Platform Console, the transfer's start time in a |
| 1371 * day is specified in your local timezone. |
1227 */ | 1372 */ |
1228 TimeOfDay startTimeOfDay; | 1373 TimeOfDay startTimeOfDay; |
1229 | 1374 |
1230 Schedule(); | 1375 Schedule(); |
1231 | 1376 |
1232 Schedule.fromJson(core.Map _json) { | 1377 Schedule.fromJson(core.Map _json) { |
1233 if (_json.containsKey("scheduleEndDate")) { | 1378 if (_json.containsKey("scheduleEndDate")) { |
1234 scheduleEndDate = new Date.fromJson(_json["scheduleEndDate"]); | 1379 scheduleEndDate = new Date.fromJson(_json["scheduleEndDate"]); |
1235 } | 1380 } |
1236 if (_json.containsKey("scheduleStartDate")) { | 1381 if (_json.containsKey("scheduleStartDate")) { |
(...skipping 14 matching lines...) Expand all Loading... |
1251 } | 1396 } |
1252 if (startTimeOfDay != null) { | 1397 if (startTimeOfDay != null) { |
1253 _json["startTimeOfDay"] = (startTimeOfDay).toJson(); | 1398 _json["startTimeOfDay"] = (startTimeOfDay).toJson(); |
1254 } | 1399 } |
1255 return _json; | 1400 return _json; |
1256 } | 1401 } |
1257 } | 1402 } |
1258 | 1403 |
1259 /** | 1404 /** |
1260 * The `Status` type defines a logical error model that is suitable for | 1405 * The `Status` type defines a logical error model that is suitable for |
1261 * different programming environments, including REST APIs and RPC APIs. It is | 1406 * different |
1262 * used by [gRPC](https://github.com/grpc). The error model is designed to be: - | 1407 * programming environments, including REST APIs and RPC APIs. It is used by |
1263 * Simple to use and understand for most users - Flexible enough to meet | 1408 * [gRPC](https://github.com/grpc). The error model is designed to be: |
1264 * unexpected needs # Overview The `Status` message contains three pieces of | 1409 * |
1265 * data: error code, error message, and error details. The error code should be | 1410 * - Simple to use and understand for most users |
1266 * an enum value of [google.rpc.Code][google.rpc.Code], but it may accept | 1411 * - Flexible enough to meet unexpected needs |
1267 * additional error codes if needed. The error message should be a | 1412 * |
1268 * developer-facing English message that helps developers *understand* and | 1413 * # Overview |
1269 * *resolve* the error. If a localized user-facing error message is needed, put | 1414 * |
1270 * the localized message in the error details or localize it in the client. The | 1415 * The `Status` message contains three pieces of data: error code, error |
1271 * optional error details may contain arbitrary information about the error. | 1416 * message, |
1272 * There is a predefined set of error detail types in the package `google.rpc` | 1417 * and error details. The error code should be an enum value of |
1273 * which can be used for common error conditions. # Language mapping The | 1418 * google.rpc.Code, but it may accept additional error codes if needed. The |
1274 * `Status` message is the logical representation of the error model, but it is | 1419 * error message should be a developer-facing English message that helps |
1275 * not necessarily the actual wire format. When the `Status` message is exposed | 1420 * developers *understand* and *resolve* the error. If a localized user-facing |
1276 * in different client libraries and different wire protocols, it can be mapped | 1421 * error message is needed, put the localized message in the error details or |
1277 * differently. For example, it will likely be mapped to some exceptions in | 1422 * localize it in the client. The optional error details may contain arbitrary |
1278 * Java, but more likely mapped to some error codes in C. # Other uses The error | 1423 * information about the error. There is a predefined set of error detail types |
1279 * model and the `Status` message can be used in a variety of environments, | 1424 * in the package `google.rpc` which can be used for common error conditions. |
1280 * either with or without APIs, to provide a consistent developer experience | 1425 * |
1281 * across different environments. Example uses of this error model include: - | 1426 * # Language mapping |
1282 * Partial errors. If a service needs to return partial errors to the client, it | 1427 * |
1283 * may embed the `Status` in the normal response to indicate the partial errors. | 1428 * The `Status` message is the logical representation of the error model, but it |
1284 * - Workflow errors. A typical workflow has multiple steps. Each step may have | 1429 * is not necessarily the actual wire format. When the `Status` message is |
1285 * a `Status` message for error reporting purpose. - Batch operations. If a | 1430 * exposed in different client libraries and different wire protocols, it can be |
1286 * client uses batch request and batch response, the `Status` message should be | 1431 * mapped differently. For example, it will likely be mapped to some exceptions |
1287 * used directly inside batch response, one for each error sub-response. - | 1432 * in Java, but more likely mapped to some error codes in C. |
1288 * Asynchronous operations. If an API call embeds asynchronous operation results | 1433 * |
1289 * in its response, the status of those operations should be represented | 1434 * # Other uses |
1290 * directly using the `Status` message. - Logging. If some API errors are stored | 1435 * |
1291 * in logs, the message `Status` could be used directly after any stripping | 1436 * The error model and the `Status` message can be used in a variety of |
1292 * needed for security/privacy reasons. | 1437 * environments, either with or without APIs, to provide a |
| 1438 * consistent developer experience across different environments. |
| 1439 * |
| 1440 * Example uses of this error model include: |
| 1441 * |
| 1442 * - Partial errors. If a service needs to return partial errors to the client, |
| 1443 * it may embed the `Status` in the normal response to indicate the partial |
| 1444 * errors. |
| 1445 * |
| 1446 * - Workflow errors. A typical workflow has multiple steps. Each step may |
| 1447 * have a `Status` message for error reporting purpose. |
| 1448 * |
| 1449 * - Batch operations. If a client uses batch request and batch response, the |
| 1450 * `Status` message should be used directly inside batch response, one for |
| 1451 * each error sub-response. |
| 1452 * |
| 1453 * - Asynchronous operations. If an API call embeds asynchronous operation |
| 1454 * results in its response, the status of those operations should be |
| 1455 * represented directly using the `Status` message. |
| 1456 * |
| 1457 * - Logging. If some API errors are stored in logs, the message `Status` could |
| 1458 * be used directly after any stripping needed for security/privacy reasons. |
1293 */ | 1459 */ |
1294 class Status { | 1460 class Status { |
1295 /** | 1461 /** The status code, which should be an enum value of google.rpc.Code. */ |
1296 * The status code, which should be an enum value of | |
1297 * [google.rpc.Code][google.rpc.Code]. | |
1298 */ | |
1299 core.int code; | 1462 core.int code; |
1300 /** | 1463 /** |
1301 * A list of messages that carry the error details. There will be a common set | 1464 * A list of messages that carry the error details. There will be a |
1302 * of message types for APIs to use. | 1465 * common set of message types for APIs to use. |
1303 * | 1466 * |
1304 * The values for Object must be JSON objects. It can consist of `num`, | 1467 * The values for Object must be JSON objects. It can consist of `num`, |
1305 * `String`, `bool` and `null` as well as `Map` and `List` values. | 1468 * `String`, `bool` and `null` as well as `Map` and `List` values. |
1306 */ | 1469 */ |
1307 core.List<core.Map<core.String, core.Object>> details; | 1470 core.List<core.Map<core.String, core.Object>> details; |
1308 /** | 1471 /** |
1309 * A developer-facing error message, which should be in English. Any | 1472 * A developer-facing error message, which should be in English. Any |
1310 * user-facing error message should be localized and sent in the | 1473 * user-facing error message should be localized and sent in the |
1311 * [google.rpc.Status.details][google.rpc.Status.details] field, or localized | 1474 * google.rpc.Status.details field, or localized by the client. |
1312 * by the client. | |
1313 */ | 1475 */ |
1314 core.String message; | 1476 core.String message; |
1315 | 1477 |
1316 Status(); | 1478 Status(); |
1317 | 1479 |
1318 Status.fromJson(core.Map _json) { | 1480 Status.fromJson(core.Map _json) { |
1319 if (_json.containsKey("code")) { | 1481 if (_json.containsKey("code")) { |
1320 code = _json["code"]; | 1482 code = _json["code"]; |
1321 } | 1483 } |
1322 if (_json.containsKey("details")) { | 1484 if (_json.containsKey("details")) { |
(...skipping 14 matching lines...) Expand all Loading... |
1337 } | 1499 } |
1338 if (message != null) { | 1500 if (message != null) { |
1339 _json["message"] = message; | 1501 _json["message"] = message; |
1340 } | 1502 } |
1341 return _json; | 1503 return _json; |
1342 } | 1504 } |
1343 } | 1505 } |
1344 | 1506 |
1345 /** | 1507 /** |
1346 * Represents a time of day. The date and time zone are either not significant | 1508 * Represents a time of day. The date and time zone are either not significant |
1347 * or are specified elsewhere. An API may chose to allow leap seconds. Related | 1509 * or are specified elsewhere. An API may choose to allow leap seconds. Related |
1348 * types are [google.type.Date][google.type.Date] and | 1510 * types are google.type.Date and `google.protobuf.Timestamp`. |
1349 * `google.protobuf.Timestamp`. | |
1350 */ | 1511 */ |
1351 class TimeOfDay { | 1512 class TimeOfDay { |
1352 /** | 1513 /** |
1353 * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose | 1514 * Hours of day in 24 hour format. Should be from 0 to 23. An API may choose |
1354 * to allow the value "24:00:00" for scenarios like business closing time. | 1515 * to allow the value "24:00:00" for scenarios like business closing time. |
1355 */ | 1516 */ |
1356 core.int hours; | 1517 core.int hours; |
1357 /** Minutes of hour of day. Must be from 0 to 59. */ | 1518 /** Minutes of hour of day. Must be from 0 to 59. */ |
1358 core.int minutes; | 1519 core.int minutes; |
1359 /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ | 1520 /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */ |
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1405 class TransferCounters { | 1566 class TransferCounters { |
1406 /** Bytes that are copied to the data sink. */ | 1567 /** Bytes that are copied to the data sink. */ |
1407 core.String bytesCopiedToSink; | 1568 core.String bytesCopiedToSink; |
1408 /** Bytes that are deleted from the data sink. */ | 1569 /** Bytes that are deleted from the data sink. */ |
1409 core.String bytesDeletedFromSink; | 1570 core.String bytesDeletedFromSink; |
1410 /** Bytes that are deleted from the data source. */ | 1571 /** Bytes that are deleted from the data source. */ |
1411 core.String bytesDeletedFromSource; | 1572 core.String bytesDeletedFromSource; |
1412 /** Bytes that failed to be deleted from the data sink. */ | 1573 /** Bytes that failed to be deleted from the data sink. */ |
1413 core.String bytesFailedToDeleteFromSink; | 1574 core.String bytesFailedToDeleteFromSink; |
1414 /** | 1575 /** |
1415 * Bytes found in the data source that are scheduled to be transferred, which | 1576 * Bytes found in the data source that are scheduled to be transferred, |
1416 * will be copied, excluded based on conditions, or skipped due to failures. | 1577 * which will be copied, excluded based on conditions, or skipped due to |
| 1578 * failures. |
1417 */ | 1579 */ |
1418 core.String bytesFoundFromSource; | 1580 core.String bytesFoundFromSource; |
1419 /** Bytes found only in the data sink that are scheduled to be deleted. */ | 1581 /** Bytes found only in the data sink that are scheduled to be deleted. */ |
1420 core.String bytesFoundOnlyFromSink; | 1582 core.String bytesFoundOnlyFromSink; |
1421 /** Bytes in the data source that failed during the transfer. */ | 1583 /** Bytes in the data source that failed during the transfer. */ |
1422 core.String bytesFromSourceFailed; | 1584 core.String bytesFromSourceFailed; |
1423 /** | 1585 /** |
1424 * Bytes in the data source that are not transferred because they already | 1586 * Bytes in the data source that are not transferred because they already |
1425 * exist in the data sink. | 1587 * exist in the data sink. |
1426 */ | 1588 */ |
(...skipping 139 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1566 /** This field cannot be changed by user requests. */ | 1728 /** This field cannot be changed by user requests. */ |
1567 core.String deletionTime; | 1729 core.String deletionTime; |
1568 /** | 1730 /** |
1569 * A description provided by the user for the job. Its max length is 1024 | 1731 * A description provided by the user for the job. Its max length is 1024 |
1570 * bytes when Unicode-encoded. | 1732 * bytes when Unicode-encoded. |
1571 */ | 1733 */ |
1572 core.String description; | 1734 core.String description; |
1573 /** This field cannot be changed by user requests. */ | 1735 /** This field cannot be changed by user requests. */ |
1574 core.String lastModificationTime; | 1736 core.String lastModificationTime; |
1575 /** | 1737 /** |
1576 * A globally unique name assigned by Storage Transfer Service when the job is | 1738 * A globally unique name assigned by Storage Transfer Service when the |
1577 * created. This field should be left empty in requests to create a new | 1739 * job is created. This field should be left empty in requests to create a new |
1578 * transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` | 1740 * transfer job; otherwise, the requests result in an `INVALID_ARGUMENT` |
1579 * error. | 1741 * error. |
1580 */ | 1742 */ |
1581 core.String name; | 1743 core.String name; |
1582 /** | 1744 /** |
1583 * The ID of the Google Developers Console project that owns the job. | 1745 * The ID of the Google Cloud Platform Console project that owns the job. |
1584 * Required. | 1746 * Required. |
1585 */ | 1747 */ |
1586 core.String projectId; | 1748 core.String projectId; |
1587 /** Schedule specification. Required. */ | 1749 /** |
| 1750 * Schedule specification. |
| 1751 * Required. |
| 1752 */ |
1588 Schedule schedule; | 1753 Schedule schedule; |
1589 /** | 1754 /** |
1590 * Status of the job. This value MUST be specified for | 1755 * Status of the job. This value MUST be specified for |
1591 * `CreateTransferJobRequests`. NOTE: The effect of the new job status takes | 1756 * `CreateTransferJobRequests`. |
1592 * place during a subsequent job run. For example, if you change the job | 1757 * |
1593 * status from `ENABLED` to `DISABLED`, and an operation spawned by the | 1758 * NOTE: The effect of the new job status takes place during a subsequent job |
1594 * transfer is running, the status change would not affect the current | 1759 * run. For example, if you change the job status from `ENABLED` to |
1595 * operation. | 1760 * `DISABLED`, and an operation spawned by the transfer is running, the status |
| 1761 * change would not affect the current operation. |
1596 * Possible string values are: | 1762 * Possible string values are: |
1597 * - "STATUS_UNSPECIFIED" : A STATUS_UNSPECIFIED. | 1763 * - "STATUS_UNSPECIFIED" : Zero is an illegal value. |
1598 * - "ENABLED" : A ENABLED. | 1764 * - "ENABLED" : New transfers will be performed based on the schedule. |
1599 * - "DISABLED" : A DISABLED. | 1765 * - "DISABLED" : New transfers will not be scheduled. |
1600 * - "DELETED" : A DELETED. | 1766 * - "DELETED" : This is a soft delete state. After a transfer job is set to |
| 1767 * this |
| 1768 * state, the job and all the transfer executions are subject to |
| 1769 * garbage collection. |
1601 */ | 1770 */ |
1602 core.String status; | 1771 core.String status; |
1603 /** Transfer specification. Required. */ | 1772 /** |
| 1773 * Transfer specification. |
| 1774 * Required. |
| 1775 */ |
1604 TransferSpec transferSpec; | 1776 TransferSpec transferSpec; |
1605 | 1777 |
1606 TransferJob(); | 1778 TransferJob(); |
1607 | 1779 |
1608 TransferJob.fromJson(core.Map _json) { | 1780 TransferJob.fromJson(core.Map _json) { |
1609 if (_json.containsKey("creationTime")) { | 1781 if (_json.containsKey("creationTime")) { |
1610 creationTime = _json["creationTime"]; | 1782 creationTime = _json["creationTime"]; |
1611 } | 1783 } |
1612 if (_json.containsKey("deletionTime")) { | 1784 if (_json.containsKey("deletionTime")) { |
1613 deletionTime = _json["deletionTime"]; | 1785 deletionTime = _json["deletionTime"]; |
(...skipping 58 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1672 class TransferOperation { | 1844 class TransferOperation { |
1673 /** Information about the progress of the transfer operation. */ | 1845 /** Information about the progress of the transfer operation. */ |
1674 TransferCounters counters; | 1846 TransferCounters counters; |
1675 /** End time of this transfer execution. */ | 1847 /** End time of this transfer execution. */ |
1676 core.String endTime; | 1848 core.String endTime; |
1677 /** Summarizes errors encountered with sample error log entries. */ | 1849 /** Summarizes errors encountered with sample error log entries. */ |
1678 core.List<ErrorSummary> errorBreakdowns; | 1850 core.List<ErrorSummary> errorBreakdowns; |
1679 /** A globally unique ID assigned by the system. */ | 1851 /** A globally unique ID assigned by the system. */ |
1680 core.String name; | 1852 core.String name; |
1681 /** | 1853 /** |
1682 * The ID of the Google Developers Console project that owns the operation. | 1854 * The ID of the Google Cloud Platform Console project that owns the |
| 1855 * operation. |
1683 * Required. | 1856 * Required. |
1684 */ | 1857 */ |
1685 core.String projectId; | 1858 core.String projectId; |
1686 /** Start time of this transfer execution. */ | 1859 /** Start time of this transfer execution. */ |
1687 core.String startTime; | 1860 core.String startTime; |
1688 /** | 1861 /** |
1689 * Status of the transfer operation. | 1862 * Status of the transfer operation. |
1690 * Possible string values are: | 1863 * Possible string values are: |
1691 * - "STATUS_UNSPECIFIED" : A STATUS_UNSPECIFIED. | 1864 * - "STATUS_UNSPECIFIED" : Zero is an illegal value. |
1692 * - "IN_PROGRESS" : A IN_PROGRESS. | 1865 * - "IN_PROGRESS" : In progress. |
1693 * - "PAUSED" : A PAUSED. | 1866 * - "PAUSED" : Paused. |
1694 * - "SUCCESS" : A SUCCESS. | 1867 * - "SUCCESS" : Completed successfully. |
1695 * - "FAILED" : A FAILED. | 1868 * - "FAILED" : Terminated due to an unrecoverable failure. |
1696 * - "ABORTED" : A ABORTED. | 1869 * - "ABORTED" : Aborted by the user. |
1697 */ | 1870 */ |
1698 core.String status; | 1871 core.String status; |
1699 /** The name of the transfer job that triggers this transfer operation. */ | 1872 /** The name of the transfer job that triggers this transfer operation. */ |
1700 core.String transferJobName; | 1873 core.String transferJobName; |
1701 /** Transfer specification. Required. */ | 1874 /** |
| 1875 * Transfer specification. |
| 1876 * Required. |
| 1877 */ |
1702 TransferSpec transferSpec; | 1878 TransferSpec transferSpec; |
1703 | 1879 |
1704 TransferOperation(); | 1880 TransferOperation(); |
1705 | 1881 |
1706 TransferOperation.fromJson(core.Map _json) { | 1882 TransferOperation.fromJson(core.Map _json) { |
1707 if (_json.containsKey("counters")) { | 1883 if (_json.containsKey("counters")) { |
1708 counters = new TransferCounters.fromJson(_json["counters"]); | 1884 counters = new TransferCounters.fromJson(_json["counters"]); |
1709 } | 1885 } |
1710 if (_json.containsKey("endTime")) { | 1886 if (_json.containsKey("endTime")) { |
1711 endTime = _json["endTime"]; | 1887 endTime = _json["endTime"]; |
(...skipping 48 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1760 _json["transferJobName"] = transferJobName; | 1936 _json["transferJobName"] = transferJobName; |
1761 } | 1937 } |
1762 if (transferSpec != null) { | 1938 if (transferSpec != null) { |
1763 _json["transferSpec"] = (transferSpec).toJson(); | 1939 _json["transferSpec"] = (transferSpec).toJson(); |
1764 } | 1940 } |
1765 return _json; | 1941 return _json; |
1766 } | 1942 } |
1767 } | 1943 } |
1768 | 1944 |
1769 /** | 1945 /** |
1770 * TransferOptions uses three boolean parameters to define the actions to be | 1946 * TransferOptions uses three boolean parameters to define the actions |
1771 * performed on objects in a transfer. | 1947 * to be performed on objects in a transfer. |
1772 */ | 1948 */ |
1773 class TransferOptions { | 1949 class TransferOptions { |
1774 /** | 1950 /** |
1775 * Whether objects should be deleted from the source after they are | 1951 * Whether objects should be deleted from the source after they are |
1776 * transferred to the sink. | 1952 * transferred to the sink. |
1777 */ | 1953 */ |
1778 core.bool deleteObjectsFromSourceAfterTransfer; | 1954 core.bool deleteObjectsFromSourceAfterTransfer; |
1779 /** Whether objects that exist only in the sink should be deleted. */ | 1955 /** Whether objects that exist only in the sink should be deleted. */ |
1780 core.bool deleteObjectsUniqueInSink; | 1956 core.bool deleteObjectsUniqueInSink; |
1781 /** Whether overwriting objects that already exist in the sink is allowed. */ | 1957 /** Whether overwriting objects that already exist in the sink is allowed. */ |
(...skipping 33 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1815 /** An AWS S3 data source. */ | 1991 /** An AWS S3 data source. */ |
1816 AwsS3Data awsS3DataSource; | 1992 AwsS3Data awsS3DataSource; |
1817 /** A Google Cloud Storage data sink. */ | 1993 /** A Google Cloud Storage data sink. */ |
1818 GcsData gcsDataSink; | 1994 GcsData gcsDataSink; |
1819 /** A Google Cloud Storage data source. */ | 1995 /** A Google Cloud Storage data source. */ |
1820 GcsData gcsDataSource; | 1996 GcsData gcsDataSource; |
1821 /** An HTTP URL data source. */ | 1997 /** An HTTP URL data source. */ |
1822 HttpData httpDataSource; | 1998 HttpData httpDataSource; |
1823 /** | 1999 /** |
1824 * Only objects that satisfy these object conditions are included in the set | 2000 * Only objects that satisfy these object conditions are included in the set |
1825 * of data source and data sink objects. Object conditions based on objects' | 2001 * of data source and data sink objects. Object conditions based on |
1826 * `lastModificationTime` do not exclude objects in a data sink. | 2002 * objects' `lastModificationTime` do not exclude objects in a data sink. |
1827 */ | 2003 */ |
1828 ObjectConditions objectConditions; | 2004 ObjectConditions objectConditions; |
1829 /** | 2005 /** |
1830 * If the option `deleteObjectsUniqueInSink` is `true`, object conditions | 2006 * If the option `deleteObjectsUniqueInSink` is `true`, object conditions |
1831 * based on objects' `lastModificationTime` are ignored and do not exclude | 2007 * based on objects' `lastModificationTime` are ignored and do not exclude |
1832 * objects in a data source or a data sink. | 2008 * objects in a data source or a data sink. |
1833 */ | 2009 */ |
1834 TransferOptions transferOptions; | 2010 TransferOptions transferOptions; |
1835 | 2011 |
1836 TransferSpec(); | 2012 TransferSpec(); |
(...skipping 39 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1876 if (transferOptions != null) { | 2052 if (transferOptions != null) { |
1877 _json["transferOptions"] = (transferOptions).toJson(); | 2053 _json["transferOptions"] = (transferOptions).toJson(); |
1878 } | 2054 } |
1879 return _json; | 2055 return _json; |
1880 } | 2056 } |
1881 } | 2057 } |
1882 | 2058 |
1883 /** Request passed to UpdateTransferJob. */ | 2059 /** Request passed to UpdateTransferJob. */ |
1884 class UpdateTransferJobRequest { | 2060 class UpdateTransferJobRequest { |
1885 /** | 2061 /** |
1886 * The ID of the Google Developers Console project that owns the job. | 2062 * The ID of the Google Cloud Platform Console project that owns the job. |
1887 * Required. | 2063 * Required. |
1888 */ | 2064 */ |
1889 core.String projectId; | 2065 core.String projectId; |
1890 /** The job to update. Required. */ | 2066 /** |
| 2067 * The job to update. |
| 2068 * Required. |
| 2069 */ |
1891 TransferJob transferJob; | 2070 TransferJob transferJob; |
1892 /** | 2071 /** |
1893 * The field mask of the fields in `transferJob` that are to be updated in | 2072 * The field mask of the fields in `transferJob` that are to be updated in |
1894 * this request. Fields in `transferJob` that can be updated are: | 2073 * this request. Fields in `transferJob` that can be updated are: |
1895 * `description`, `transferSpec`, and `status`. To update the `transferSpec` | 2074 * `description`, `transferSpec`, and `status`. To update the `transferSpec` |
1896 * of the job, a complete transfer specification has to be provided. An | 2075 * of the job, a complete transfer specification has to be provided. An |
1897 * incomplete specification which misses any required fields will be rejected | 2076 * incomplete specification which misses any required fields will be rejected |
1898 * with the error `INVALID_ARGUMENT`. | 2077 * with the error `INVALID_ARGUMENT`. |
1899 */ | 2078 */ |
1900 core.String updateTransferJobFieldMask; | 2079 core.String updateTransferJobFieldMask; |
1901 | 2080 |
1902 UpdateTransferJobRequest(); | 2081 UpdateTransferJobRequest(); |
1903 | 2082 |
1904 UpdateTransferJobRequest.fromJson(core.Map _json) { | 2083 UpdateTransferJobRequest.fromJson(core.Map _json) { |
1905 if (_json.containsKey("projectId")) { | 2084 if (_json.containsKey("projectId")) { |
(...skipping 14 matching lines...) Expand all Loading... |
1920 } | 2099 } |
1921 if (transferJob != null) { | 2100 if (transferJob != null) { |
1922 _json["transferJob"] = (transferJob).toJson(); | 2101 _json["transferJob"] = (transferJob).toJson(); |
1923 } | 2102 } |
1924 if (updateTransferJobFieldMask != null) { | 2103 if (updateTransferJobFieldMask != null) { |
1925 _json["updateTransferJobFieldMask"] = updateTransferJobFieldMask; | 2104 _json["updateTransferJobFieldMask"] = updateTransferJobFieldMask; |
1926 } | 2105 } |
1927 return _json; | 2106 return _json; |
1928 } | 2107 } |
1929 } | 2108 } |
OLD | NEW |