1type: google.api.Service 2config_version: 3 3name: storagetransfer.googleapis.com 4title: Storage Transfer API 5 6apis: 7- name: google.longrunning.Operations 8- name: google.storagetransfer.v1.StorageTransferService 9 10types: 11- name: google.storagetransfer.v1.TransferOperation 12 13documentation: 14 summary: |- 15 Transfers data from external data sources to a Google Cloud Storage bucket 16 or between Google Cloud Storage buckets. 17 rules: 18 - selector: google.longrunning.Operations.CancelOperation 19 description: |- 20 Cancels a transfer. Use 21 the [transferOperations.get][google.longrunning.Operations.GetOperation] 22 method to check if the cancellation succeeded or if the operation 23 completed despite the `cancel` request. 24 25 When you cancel an operation, the currently running transfer is 26 interrupted. For recurring transfer jobs, the next instance of the 27 transfer job will still run. For example, if your job is configured 28 to run every day at 1pm and you cancel Monday's operation at 1:05pm, 29 Monday's transfer 30 will stop. However, a transfer job will still be attempted on Tuesday. 31 32 This applies only to currently running operations. If an operation is 33 not currently running, `cancel` does nothing. 34 35 <aside class="caution"> 36 <b>Caution:</b> Canceling a transfer job can leave your data in an 37 unknown state. We recommend that you restore the state at both the 38 destination and the source after the `cancel` request completes so 39 that your data is in a consistent state. </aside> 40 41 When you cancel a job, the next job computes a delta of files and may 42 repair any inconsistent state. For instance, if you run a job every 43 day, and today's job found 10 new files and transferred five files 44 before you canceled the job, tomorrow's transfer operation will 45 compute a new delta with the five files that were not copied today 46 plus any new files discovered tomorrow. 47 48 - selector: google.longrunning.Operations.ListOperations 49 description: |- 50 Lists transfer operations. Operations are ordered by their creation 51 time in reverse chronological order. 52 53backend: 54 rules: 55 - selector: 'google.longrunning.Operations.*' 56 deadline: 30.0 57 - selector: 'google.storagetransfer.v1.StorageTransferService.*' 58 deadline: 30.0 59 60http: 61 rules: 62 - selector: google.longrunning.Operations.CancelOperation 63 post: '/v1/{name=transferOperations/**}:cancel' 64 body: '*' 65 - selector: google.longrunning.Operations.GetOperation 66 get: '/v1/{name=transferOperations/**}' 67 - selector: google.longrunning.Operations.ListOperations 68 get: '/v1/{name=transferOperations}' 69 70authentication: 71 rules: 72 - selector: 'google.longrunning.Operations.*' 73 oauth: 74 canonical_scopes: |- 75 https://www.googleapis.com/auth/cloud-platform 76 - selector: 'google.storagetransfer.v1.StorageTransferService.*' 77 oauth: 78 canonical_scopes: |- 79 https://www.googleapis.com/auth/cloud-platform 80