OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://storagetransfer.googleapis.com/", | 12 "baseUrl": "https://storagetransfer.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "description": "Transfers data from external data sources to a Google Cloud
Storage bucket or between Google Cloud Storage buckets.", | 14 "description": "Transfers data from external data sources to a Google Cloud
Storage bucket or between Google Cloud Storage buckets.", |
15 "discoveryVersion": "v1", | 15 "discoveryVersion": "v1", |
16 "documentationLink": "https://cloud.google.com/storage/transfer", | 16 "documentationLink": "https://cloud.google.com/storage/transfer", |
17 "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/fmXUMBI6Gn2x3crK-Doz-fh96kI\"", | |
18 "icons": { | 17 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 18 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 19 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 20 }, |
22 "id": "storagetransfer:v1", | 21 "id": "storagetransfer:v1", |
23 "kind": "discovery#restDescription", | 22 "kind": "discovery#restDescription", |
24 "name": "storagetransfer", | 23 "name": "storagetransfer", |
25 "ownerDomain": "google.com", | 24 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 25 "ownerName": "Google", |
27 "parameters": { | 26 "parameters": { |
28 "access_token": { | 27 "uploadType": { |
29 "description": "OAuth access token.", | 28 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
30 "location": "query", | 29 "location": "query", |
31 "type": "string" | 30 "type": "string" |
32 }, | 31 }, |
33 "alt": { | 32 "fields": { |
34 "default": "json", | 33 "description": "Selector specifying which fields to include in a par
tial response.", |
35 "description": "Data format for response.", | 34 "location": "query", |
| 35 "type": "string" |
| 36 }, |
| 37 "$.xgafv": { |
| 38 "description": "V1 error format.", |
| 39 "enum": [ |
| 40 "1", |
| 41 "2" |
| 42 ], |
36 "enumDescriptions": [ | 43 "enumDescriptions": [ |
37 "Responses with Content-Type of application/json", | 44 "v1 error format", |
38 "Media download with context-dependent Content-Type", | 45 "v2 error format" |
39 "Responses with Content-Type of application/x-protobuf" | |
40 ], | 46 ], |
41 "location": "query", | 47 "location": "query", |
42 "type": "string" | 48 "type": "string" |
43 }, | 49 }, |
44 "bearer_token": { | |
45 "description": "OAuth bearer token.", | |
46 "location": "query", | |
47 "type": "string" | |
48 }, | |
49 "callback": { | 50 "callback": { |
50 "description": "JSONP", | 51 "description": "JSONP", |
51 "location": "query", | 52 "location": "query", |
52 "type": "string" | 53 "type": "string" |
53 }, | 54 }, |
54 "fields": { | 55 "alt": { |
55 "description": "Selector specifying which fields to include in a par
tial response.", | 56 "default": "json", |
| 57 "description": "Data format for response.", |
| 58 "enum": [ |
| 59 "json", |
| 60 "media", |
| 61 "proto" |
| 62 ], |
| 63 "enumDescriptions": [ |
| 64 "Responses with Content-Type of application/json", |
| 65 "Media download with context-dependent Content-Type", |
| 66 "Responses with Content-Type of application/x-protobuf" |
| 67 ], |
56 "location": "query", | 68 "location": "query", |
57 "type": "string" | 69 "type": "string" |
58 }, | 70 }, |
| 71 "access_token": { |
| 72 "description": "OAuth access token.", |
| 73 "location": "query", |
| 74 "type": "string" |
| 75 }, |
59 "key": { | 76 "key": { |
60 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | 77 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
61 "location": "query", | 78 "location": "query", |
62 "type": "string" | 79 "type": "string" |
63 }, | 80 }, |
64 "oauth_token": { | 81 "quotaUser": { |
65 "description": "OAuth 2.0 token for the current user.", | 82 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
66 "location": "query", | 83 "location": "query", |
67 "type": "string" | 84 "type": "string" |
68 }, | 85 }, |
69 "pp": { | 86 "pp": { |
70 "default": "true", | 87 "default": "true", |
71 "description": "Pretty-print response.", | 88 "description": "Pretty-print response.", |
72 "location": "query", | 89 "location": "query", |
73 "type": "boolean" | 90 "type": "boolean" |
74 }, | 91 }, |
75 "prettyPrint": { | 92 "oauth_token": { |
76 "default": "true", | 93 "description": "OAuth 2.0 token for the current user.", |
77 "description": "Returns response with indentations and line breaks."
, | |
78 "location": "query", | |
79 "type": "boolean" | |
80 }, | |
81 "quotaUser": { | |
82 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | |
83 "location": "query", | 94 "location": "query", |
84 "type": "string" | 95 "type": "string" |
85 }, | 96 }, |
| 97 "bearer_token": { |
| 98 "description": "OAuth bearer token.", |
| 99 "location": "query", |
| 100 "type": "string" |
| 101 }, |
86 "upload_protocol": { | 102 "upload_protocol": { |
87 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 103 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
88 "location": "query", | 104 "location": "query", |
89 "type": "string" | 105 "type": "string" |
90 }, | 106 }, |
91 "uploadType": { | 107 "prettyPrint": { |
92 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 108 "default": "true", |
| 109 "description": "Returns response with indentations and line breaks."
, |
93 "location": "query", | 110 "location": "query", |
94 "type": "string" | 111 "type": "boolean" |
95 }, | |
96 "$.xgafv": { | |
97 "description": "V1 error format.", | |
98 "enumDescriptions": [ | |
99 "v1 error format", | |
100 "v2 error format" | |
101 ], | |
102 "location": "query", | |
103 "type": "string" | |
104 } | 112 } |
105 }, | 113 }, |
106 "protocol": "rest", | 114 "protocol": "rest", |
107 "resources": { | 115 "resources": { |
108 "googleServiceAccounts": { | 116 "googleServiceAccounts": { |
109 "methods": { | 117 "methods": { |
110 "get": { | 118 "get": { |
111 "description": "Returns the Google service account that is u
sed by Storage Transfer Service to access buckets in the project where transfers
run or in other projects. Each Google service account is associated with one Go
ogle Developers Console project. Users should add this service account to the Go
ogle Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This
service account is created and owned by Storage Transfer Service and can only b
e used by Storage Transfer Service.", | 119 "description": "Returns the Google service account that is u
sed by Storage Transfer\nService to access buckets in the project where transfer
s\nrun or in other projects. Each Google service account is associated\nwith one
Google Cloud Platform Console project. Users\nshould add this service account t
o the Google Cloud Storage bucket\nACLs to grant access to Storage Transfer Serv
ice. This service\naccount is created and owned by Storage Transfer Service and
can\nonly be used by Storage Transfer Service.", |
112 "httpMethod": "GET", | 120 "httpMethod": "GET", |
113 "id": "storagetransfer.googleServiceAccounts.get", | 121 "id": "storagetransfer.googleServiceAccounts.get", |
114 "parameterOrder": [ | 122 "parameterOrder": [ |
115 "projectId" | 123 "projectId" |
116 ], | 124 ], |
117 "parameters": { | 125 "parameters": { |
118 "projectId": { | 126 "projectId": { |
119 "description": "The ID of the Google Developers Cons
ole project that the Google service account is associated with. Required.", | 127 "description": "The ID of the Google Cloud Platform
Console project that the Google service\naccount is associated with.\nRequired."
, |
120 "location": "path", | 128 "location": "path", |
121 "required": true, | 129 "required": true, |
122 "type": "string" | 130 "type": "string" |
123 } | 131 } |
124 }, | 132 }, |
125 "path": "v1/googleServiceAccounts/{projectId}", | 133 "path": "v1/googleServiceAccounts/{projectId}", |
126 "response": { | 134 "response": { |
127 "$ref": "GoogleServiceAccount" | 135 "$ref": "GoogleServiceAccount" |
128 }, | 136 }, |
129 "scopes": [ | 137 "scopes": [ |
130 "https://www.googleapis.com/auth/cloud-platform" | 138 "https://www.googleapis.com/auth/cloud-platform" |
131 ] | 139 ] |
132 } | 140 } |
133 } | 141 } |
134 }, | 142 }, |
135 "v1": { | |
136 "methods": { | |
137 "getGoogleServiceAccount": { | |
138 "description": "Returns the Google service account that is u
sed by Storage Transfer Service to access buckets in the project where transfers
run or in other projects. Each Google service account is associated with one Go
ogle Developers Console project. Users should add this service account to the Go
ogle Cloud Storage bucket ACLs to grant access to Storage Transfer Service. This
service account is created and owned by Storage Transfer Service and can only b
e used by Storage Transfer Service.", | |
139 "httpMethod": "GET", | |
140 "id": "storagetransfer.getGoogleServiceAccount", | |
141 "parameters": { | |
142 "projectId": { | |
143 "description": "The ID of the Google Developers Cons
ole project that the Google service account is associated with. Required.", | |
144 "location": "query", | |
145 "type": "string" | |
146 } | |
147 }, | |
148 "path": "v1:getGoogleServiceAccount", | |
149 "response": { | |
150 "$ref": "GoogleServiceAccount" | |
151 }, | |
152 "scopes": [ | |
153 "https://www.googleapis.com/auth/cloud-platform" | |
154 ] | |
155 } | |
156 } | |
157 }, | |
158 "transferJobs": { | 143 "transferJobs": { |
159 "methods": { | 144 "methods": { |
160 "create": { | |
161 "description": "Creates a transfer job that runs periodicall
y.", | |
162 "httpMethod": "POST", | |
163 "id": "storagetransfer.transferJobs.create", | |
164 "path": "v1/transferJobs", | |
165 "request": { | |
166 "$ref": "TransferJob" | |
167 }, | |
168 "response": { | |
169 "$ref": "TransferJob" | |
170 }, | |
171 "scopes": [ | |
172 "https://www.googleapis.com/auth/cloud-platform" | |
173 ] | |
174 }, | |
175 "patch": { | 145 "patch": { |
176 "description": "Updates a transfer job. Updating a job's tra
nsfer spec does not affect transfer operations that are running already. Updatin
g the scheduling of a job is not allowed.", | 146 "description": "Updates a transfer job. Updating a job's tra
nsfer spec does not affect\ntransfer operations that are running already. Updati
ng the scheduling\nof a job is not allowed.", |
177 "httpMethod": "PATCH", | 147 "httpMethod": "PATCH", |
178 "id": "storagetransfer.transferJobs.patch", | 148 "id": "storagetransfer.transferJobs.patch", |
179 "parameterOrder": [ | 149 "parameterOrder": [ |
180 "jobName" | 150 "jobName" |
181 ], | 151 ], |
182 "parameters": { | 152 "parameters": { |
183 "jobName": { | 153 "jobName": { |
184 "description": "The name of job to update. Required.
", | 154 "description": "The name of job to update.\nRequired
.", |
185 "location": "path", | 155 "location": "path", |
186 "pattern": "^transferJobs/.*$", | 156 "pattern": "^transferJobs/.+$", |
187 "required": true, | 157 "required": true, |
188 "type": "string" | 158 "type": "string" |
189 } | 159 } |
190 }, | 160 }, |
191 "path": "v1/{+jobName}", | 161 "path": "v1/{+jobName}", |
192 "request": { | 162 "request": { |
193 "$ref": "UpdateTransferJobRequest" | 163 "$ref": "UpdateTransferJobRequest" |
194 }, | 164 }, |
195 "response": { | 165 "response": { |
196 "$ref": "TransferJob" | 166 "$ref": "TransferJob" |
197 }, | 167 }, |
198 "scopes": [ | 168 "scopes": [ |
199 "https://www.googleapis.com/auth/cloud-platform" | 169 "https://www.googleapis.com/auth/cloud-platform" |
200 ] | 170 ] |
201 }, | 171 }, |
202 "get": { | 172 "get": { |
203 "description": "Gets a transfer job.", | 173 "description": "Gets a transfer job.", |
204 "httpMethod": "GET", | 174 "httpMethod": "GET", |
205 "id": "storagetransfer.transferJobs.get", | 175 "id": "storagetransfer.transferJobs.get", |
206 "parameterOrder": [ | 176 "parameterOrder": [ |
207 "jobName" | 177 "jobName" |
208 ], | 178 ], |
209 "parameters": { | 179 "parameters": { |
210 "jobName": { | 180 "jobName": { |
211 "description": "The job to get. Required.", | 181 "description": "The job to get.\nRequired.", |
212 "location": "path", | 182 "location": "path", |
213 "pattern": "^transferJobs/.*$", | 183 "pattern": "^transferJobs/.+$", |
214 "required": true, | 184 "required": true, |
215 "type": "string" | 185 "type": "string" |
216 }, | 186 }, |
217 "projectId": { | 187 "projectId": { |
218 "description": "The ID of the Google Developers Cons
ole project that owns the job. Required.", | 188 "description": "The ID of the Google Cloud Platform
Console project that owns the job.\nRequired.", |
219 "location": "query", | 189 "location": "query", |
220 "type": "string" | 190 "type": "string" |
221 } | 191 } |
222 }, | 192 }, |
223 "path": "v1/{+jobName}", | 193 "path": "v1/{+jobName}", |
224 "response": { | 194 "response": { |
225 "$ref": "TransferJob" | 195 "$ref": "TransferJob" |
226 }, | 196 }, |
227 "scopes": [ | 197 "scopes": [ |
228 "https://www.googleapis.com/auth/cloud-platform" | 198 "https://www.googleapis.com/auth/cloud-platform" |
229 ] | 199 ] |
230 }, | 200 }, |
231 "list": { | 201 "list": { |
232 "description": "Lists transfer jobs.", | 202 "description": "Lists transfer jobs.", |
233 "httpMethod": "GET", | 203 "httpMethod": "GET", |
234 "id": "storagetransfer.transferJobs.list", | 204 "id": "storagetransfer.transferJobs.list", |
| 205 "parameterOrder": [], |
235 "parameters": { | 206 "parameters": { |
236 "filter": { | 207 "pageToken": { |
237 "description": "A list of query parameters specified
as JSON text in the form of {\"`project_id`\":\"my_project_id\", \"`job_names`\
":[\"jobid1\",\"jobid2\",...], \"`job_statuses`\":[\"status1\",\"status2\",...]}
. Since `job_names` and `job_statuses` support multiple values, their values mus
t be specified with array notation. `project_id` is required. `job_names` and `j
ob_statuses` are optional. The valid values for `job_statuses` are case-insensit
ive: `ENABLED`, `DISABLED`, and `DELETED`.", | 208 "description": "The list page token.", |
238 "location": "query", | 209 "location": "query", |
239 "type": "string" | 210 "type": "string" |
240 }, | 211 }, |
241 "pageSize": { | 212 "pageSize": { |
242 "description": "The list page size. The max allowed
value is 256.", | 213 "description": "The list page size. The max allowed
value is 256.", |
243 "format": "int32", | 214 "format": "int32", |
244 "location": "query", | 215 "location": "query", |
245 "type": "integer" | 216 "type": "integer" |
246 }, | 217 }, |
247 "pageToken": { | 218 "filter": { |
248 "description": "The list page token.", | 219 "description": "A list of query parameters specified
as JSON text in the form of\n{\"project_id\":\"my_project_id\",\n\"job_names\":
[\"jobid1\",\"jobid2\",...],\n\"job_statuses\":[\"status1\",\"status2\",...]}.\n
Since `job_names` and `job_statuses` support multiple values, their values\nmust
be specified with array notation. `project_id` is required. `job_names`\nand `j
ob_statuses` are optional. The valid values for `job_statuses` are\ncase-insens
itive: `ENABLED`, `DISABLED`, and `DELETED`.", |
249 "location": "query", | 220 "location": "query", |
250 "type": "string" | 221 "type": "string" |
251 } | 222 } |
252 }, | 223 }, |
253 "path": "v1/transferJobs", | 224 "path": "v1/transferJobs", |
254 "response": { | 225 "response": { |
255 "$ref": "ListTransferJobsResponse" | 226 "$ref": "ListTransferJobsResponse" |
256 }, | 227 }, |
257 "scopes": [ | 228 "scopes": [ |
258 "https://www.googleapis.com/auth/cloud-platform" | 229 "https://www.googleapis.com/auth/cloud-platform" |
259 ] | 230 ] |
| 231 }, |
| 232 "create": { |
| 233 "description": "Creates a transfer job that runs periodicall
y.", |
| 234 "httpMethod": "POST", |
| 235 "id": "storagetransfer.transferJobs.create", |
| 236 "parameterOrder": [], |
| 237 "parameters": {}, |
| 238 "path": "v1/transferJobs", |
| 239 "request": { |
| 240 "$ref": "TransferJob" |
| 241 }, |
| 242 "response": { |
| 243 "$ref": "TransferJob" |
| 244 }, |
| 245 "scopes": [ |
| 246 "https://www.googleapis.com/auth/cloud-platform" |
| 247 ] |
260 } | 248 } |
261 } | 249 } |
262 }, | 250 }, |
263 "transferOperations": { | 251 "transferOperations": { |
264 "methods": { | 252 "methods": { |
265 "pause": { | 253 "cancel": { |
266 "description": "Pauses a transfer operation.", | 254 "description": "Cancels a transfer. Use the get method to ch
eck whether the cancellation succeeded or whether the operation completed despit
e cancellation.", |
267 "httpMethod": "POST", | 255 "httpMethod": "POST", |
268 "id": "storagetransfer.transferOperations.pause", | 256 "id": "storagetransfer.transferOperations.cancel", |
269 "parameterOrder": [ | 257 "parameterOrder": [ |
270 "name" | 258 "name" |
271 ], | 259 ], |
272 "parameters": { | 260 "parameters": { |
273 "name": { | 261 "name": { |
274 "description": "The name of the transfer operation.
Required.", | 262 "description": "The name of the operation resource t
o be cancelled.", |
275 "location": "path", | 263 "location": "path", |
276 "pattern": "^transferOperations/.*$", | 264 "pattern": "^transferOperations/.+$", |
277 "required": true, | 265 "required": true, |
278 "type": "string" | 266 "type": "string" |
279 } | 267 } |
280 }, | 268 }, |
281 "path": "v1/{+name}:pause", | 269 "path": "v1/{+name}:cancel", |
282 "request": { | |
283 "$ref": "PauseTransferOperationRequest" | |
284 }, | |
285 "response": { | 270 "response": { |
286 "$ref": "Empty" | 271 "$ref": "Empty" |
287 }, | 272 }, |
288 "scopes": [ | 273 "scopes": [ |
289 "https://www.googleapis.com/auth/cloud-platform" | 274 "https://www.googleapis.com/auth/cloud-platform" |
290 ] | 275 ] |
291 }, | 276 }, |
292 "resume": { | 277 "get": { |
293 "description": "Resumes a transfer operation that is paused.
", | 278 "description": "Gets the latest state of a long-running oper
ation. Clients can use this\nmethod to poll the operation result at intervals a
s recommended by the API\nservice.", |
294 "httpMethod": "POST", | 279 "httpMethod": "GET", |
295 "id": "storagetransfer.transferOperations.resume", | 280 "id": "storagetransfer.transferOperations.get", |
296 "parameterOrder": [ | 281 "parameterOrder": [ |
297 "name" | 282 "name" |
298 ], | 283 ], |
299 "parameters": { | 284 "parameters": { |
300 "name": { | 285 "name": { |
301 "description": "The name of the transfer operation.
Required.", | 286 "description": "The name of the operation resource."
, |
302 "location": "path", | 287 "location": "path", |
303 "pattern": "^transferOperations/.*$", | 288 "pattern": "^transferOperations/.+$", |
304 "required": true, | 289 "required": true, |
305 "type": "string" | 290 "type": "string" |
306 } | 291 } |
307 }, | 292 }, |
308 "path": "v1/{+name}:resume", | 293 "path": "v1/{+name}", |
| 294 "response": { |
| 295 "$ref": "Operation" |
| 296 }, |
| 297 "scopes": [ |
| 298 "https://www.googleapis.com/auth/cloud-platform" |
| 299 ] |
| 300 }, |
| 301 "pause": { |
| 302 "description": "Pauses a transfer operation.", |
| 303 "httpMethod": "POST", |
| 304 "id": "storagetransfer.transferOperations.pause", |
| 305 "parameterOrder": [ |
| 306 "name" |
| 307 ], |
| 308 "parameters": { |
| 309 "name": { |
| 310 "description": "The name of the transfer operation.\
nRequired.", |
| 311 "location": "path", |
| 312 "pattern": "^transferOperations/.+$", |
| 313 "required": true, |
| 314 "type": "string" |
| 315 } |
| 316 }, |
| 317 "path": "v1/{+name}:pause", |
309 "request": { | 318 "request": { |
310 "$ref": "ResumeTransferOperationRequest" | 319 "$ref": "PauseTransferOperationRequest" |
311 }, | 320 }, |
312 "response": { | 321 "response": { |
313 "$ref": "Empty" | 322 "$ref": "Empty" |
314 }, | 323 }, |
315 "scopes": [ | 324 "scopes": [ |
316 "https://www.googleapis.com/auth/cloud-platform" | 325 "https://www.googleapis.com/auth/cloud-platform" |
317 ] | 326 ] |
318 }, | 327 }, |
319 "get": { | 328 "delete": { |
320 "description": "Gets the latest state of a long-running oper
ation. Clients can use this method to poll the operation result at intervals as
recommended by the API service.", | 329 "description": "This method is not supported and the server
returns `UNIMPLEMENTED`.", |
321 "httpMethod": "GET", | 330 "httpMethod": "DELETE", |
322 "id": "storagetransfer.transferOperations.get", | 331 "id": "storagetransfer.transferOperations.delete", |
323 "parameterOrder": [ | 332 "parameterOrder": [ |
324 "name" | 333 "name" |
325 ], | 334 ], |
326 "parameters": { | 335 "parameters": { |
327 "name": { | 336 "name": { |
328 "description": "The name of the operation resource."
, | 337 "description": "The name of the operation resource t
o be deleted.", |
329 "location": "path", | 338 "location": "path", |
330 "pattern": "^transferOperations/.*$", | 339 "pattern": "^transferOperations/.+$", |
331 "required": true, | 340 "required": true, |
332 "type": "string" | 341 "type": "string" |
333 } | 342 } |
334 }, | 343 }, |
335 "path": "v1/{+name}", | 344 "path": "v1/{+name}", |
336 "response": { | 345 "response": { |
337 "$ref": "Operation" | 346 "$ref": "Empty" |
338 }, | 347 }, |
339 "scopes": [ | 348 "scopes": [ |
340 "https://www.googleapis.com/auth/cloud-platform" | 349 "https://www.googleapis.com/auth/cloud-platform" |
341 ] | 350 ] |
342 }, | 351 }, |
343 "list": { | 352 "list": { |
344 "description": "Lists operations that match the specified fi
lter in the request. If the server doesn't support this method, it returns `UNIM
PLEMENTED`. NOTE: the `name` binding below allows API services to override the b
inding to use different resource name schemes, such as `users/*/operations`.", | 353 "description": "Lists operations that match the specified fi
lter in the request. If the\nserver doesn't support this method, it returns `UNI
MPLEMENTED`.\n\nNOTE: the `name` binding below allows API services to override t
he binding\nto use different resource name schemes, such as `users/*/operations`
.", |
345 "httpMethod": "GET", | 354 "httpMethod": "GET", |
346 "id": "storagetransfer.transferOperations.list", | 355 "id": "storagetransfer.transferOperations.list", |
347 "parameterOrder": [ | 356 "parameterOrder": [ |
348 "name" | 357 "name" |
349 ], | 358 ], |
350 "parameters": { | 359 "parameters": { |
| 360 "filter": { |
| 361 "description": "A list of query parameters specified
as JSON text in the form of {\\\"project_id\\\" : \\\"my_project_id\\\", \\\"jo
b_names\\\" : [\\\"jobid1\\\", \\\"jobid2\\\",...], \\\"operation_names\\\" : [\
\\"opid1\\\", \\\"opid2\\\",...], \\\"transfer_statuses\\\":[\\\"status1\\\", \\
\"status2\\\",...]}. Since `job_names`, `operation_names`, and `transfer_statuse
s` support multiple values, they must be specified with array notation. `job_nam
es`, `operation_names`, and `transfer_statuses` are optional.", |
| 362 "location": "query", |
| 363 "type": "string" |
| 364 }, |
351 "name": { | 365 "name": { |
352 "description": "The value `transferOperations`.", | 366 "description": "The value `transferOperations`.", |
353 "location": "path", | 367 "location": "path", |
354 "pattern": "^transferOperations$", | 368 "pattern": "^transferOperations$", |
355 "required": true, | 369 "required": true, |
356 "type": "string" | 370 "type": "string" |
357 }, | 371 }, |
358 "filter": { | 372 "pageToken": { |
359 "description": "The standard list filter.", | 373 "description": "The list page token.", |
360 "location": "query", | 374 "location": "query", |
361 "type": "string" | 375 "type": "string" |
362 }, | 376 }, |
363 "pageSize": { | 377 "pageSize": { |
364 "description": "The standard list page size.", | 378 "description": "The list page size. The max allowed
value is 256.", |
365 "format": "int32", | 379 "format": "int32", |
366 "location": "query", | 380 "location": "query", |
367 "type": "integer" | 381 "type": "integer" |
368 }, | |
369 "pageToken": { | |
370 "description": "The standard list page token.", | |
371 "location": "query", | |
372 "type": "string" | |
373 } | 382 } |
374 }, | 383 }, |
375 "path": "v1/{+name}", | 384 "path": "v1/{+name}", |
376 "response": { | 385 "response": { |
377 "$ref": "ListOperationsResponse" | 386 "$ref": "ListOperationsResponse" |
378 }, | 387 }, |
379 "scopes": [ | 388 "scopes": [ |
380 "https://www.googleapis.com/auth/cloud-platform" | 389 "https://www.googleapis.com/auth/cloud-platform" |
381 ] | 390 ] |
382 }, | 391 }, |
383 "cancel": { | 392 "resume": { |
384 "description": "Cancels a transfer. Use the get method to ch
eck whether the cancellation succeeded or whether the operation completed despit
e cancellation.", | 393 "description": "Resumes a transfer operation that is paused.
", |
385 "httpMethod": "POST", | 394 "httpMethod": "POST", |
386 "id": "storagetransfer.transferOperations.cancel", | 395 "id": "storagetransfer.transferOperations.resume", |
387 "parameterOrder": [ | 396 "parameterOrder": [ |
388 "name" | 397 "name" |
389 ], | 398 ], |
390 "parameters": { | 399 "parameters": { |
391 "name": { | 400 "name": { |
392 "description": "The name of the operation resource t
o be cancelled.", | 401 "description": "The name of the transfer operation.\
nRequired.", |
393 "location": "path", | 402 "location": "path", |
394 "pattern": "^transferOperations/.*$", | 403 "pattern": "^transferOperations/.+$", |
395 "required": true, | 404 "required": true, |
396 "type": "string" | 405 "type": "string" |
397 } | 406 } |
398 }, | 407 }, |
399 "path": "v1/{+name}:cancel", | 408 "path": "v1/{+name}:resume", |
| 409 "request": { |
| 410 "$ref": "ResumeTransferOperationRequest" |
| 411 }, |
400 "response": { | 412 "response": { |
401 "$ref": "Empty" | 413 "$ref": "Empty" |
402 }, | 414 }, |
403 "scopes": [ | |
404 "https://www.googleapis.com/auth/cloud-platform" | |
405 ] | |
406 }, | |
407 "delete": { | |
408 "description": "This method is not supported and the server
returns `UNIMPLEMENTED`.", | |
409 "httpMethod": "DELETE", | |
410 "id": "storagetransfer.transferOperations.delete", | |
411 "parameterOrder": [ | |
412 "name" | |
413 ], | |
414 "parameters": { | |
415 "name": { | |
416 "description": "The name of the operation resource t
o be deleted.", | |
417 "location": "path", | |
418 "pattern": "^transferOperations/.*$", | |
419 "required": true, | |
420 "type": "string" | |
421 } | |
422 }, | |
423 "path": "v1/{+name}", | |
424 "response": { | |
425 "$ref": "Empty" | |
426 }, | |
427 "scopes": [ | 415 "scopes": [ |
428 "https://www.googleapis.com/auth/cloud-platform" | 416 "https://www.googleapis.com/auth/cloud-platform" |
429 ] | 417 ] |
430 } | 418 } |
431 } | 419 } |
432 } | 420 } |
433 }, | 421 }, |
434 "revision": "20150811", | 422 "revision": "20170327", |
435 "rootUrl": "https://storagetransfer.googleapis.com/", | 423 "rootUrl": "https://storagetransfer.googleapis.com/", |
436 "schemas": { | 424 "schemas": { |
| 425 "Status": { |
| 426 "description": "The `Status` type defines a logical error model that
is suitable for different\nprogramming environments, including REST APIs and RP
C APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is desig
ned to be:\n\n- Simple to use and understand for most users\n- Flexible enough t
o meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pie
ces of data: error code, error message,\nand error details. The error code shoul
d be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes
if needed. The\nerror message should be a developer-facing English message tha
t helps\ndevelopers *understand* and *resolve* the error. If a localized user-fa
cing\nerror message is needed, put the localized message in the error details or
\nlocalize it in the client. The optional error details may contain arbitrary\ni
nformation about the error. There is a predefined set of error detail types\nin
the package `google.rpc` which can be used for common error conditions.\n\n# Lan
guage mapping\n\nThe `Status` message is the logical representation of the error
model, but it\nis not necessarily the actual wire format. When the `Status` mes
sage is\nexposed in different client libraries and different wire protocols, it
can be\nmapped differently. For example, it will likely be mapped to some except
ions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\
n\nThe error model and the `Status` message can be used in a variety of\nenviron
ments, either with or without APIs, to provide a\nconsistent developer experienc
e across different environments.\n\nExample uses of this error model include:\n\
n- Partial errors. If a service needs to return partial errors to the client,\n
it may embed the `Status` in the normal response to indicate the partial\n
errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step
may\n have a `Status` message for error reporting purpose.\n\n- Batch operati
ons. If a client uses batch request and batch response, the\n `Status` messag
e should be used directly inside batch response, one for\n each error sub-res
ponse.\n\n- Asynchronous operations. If an API call embeds asynchronous operatio
n\n results in its response, the status of those operations should be\n re
presented directly using the `Status` message.\n\n- Logging. If some API errors
are stored in logs, the message `Status` could\n be used directly after any s
tripping needed for security/privacy reasons.", |
| 427 "id": "Status", |
| 428 "properties": { |
| 429 "details": { |
| 430 "description": "A list of messages that carry the error deta
ils. There will be a\ncommon set of message types for APIs to use.", |
| 431 "items": { |
| 432 "additionalProperties": { |
| 433 "description": "Properties of the object. Contains f
ield @type with type URL.", |
| 434 "type": "any" |
| 435 }, |
| 436 "type": "object" |
| 437 }, |
| 438 "type": "array" |
| 439 }, |
| 440 "code": { |
| 441 "description": "The status code, which should be an enum val
ue of google.rpc.Code.", |
| 442 "format": "int32", |
| 443 "type": "integer" |
| 444 }, |
| 445 "message": { |
| 446 "description": "A developer-facing error message, which shou
ld be in English. Any\nuser-facing error message should be localized and sent in
the\ngoogle.rpc.Status.details field, or localized by the client.", |
| 447 "type": "string" |
| 448 } |
| 449 }, |
| 450 "type": "object" |
| 451 }, |
| 452 "ResumeTransferOperationRequest": { |
| 453 "description": "Request passed to ResumeTransferOperation.", |
| 454 "id": "ResumeTransferOperationRequest", |
| 455 "properties": {}, |
| 456 "type": "object" |
| 457 }, |
| 458 "ListOperationsResponse": { |
| 459 "description": "The response message for Operations.ListOperations."
, |
| 460 "id": "ListOperationsResponse", |
| 461 "properties": { |
| 462 "nextPageToken": { |
| 463 "description": "The standard List next-page token.", |
| 464 "type": "string" |
| 465 }, |
| 466 "operations": { |
| 467 "description": "A list of operations that matches the specif
ied filter in the request.", |
| 468 "items": { |
| 469 "$ref": "Operation" |
| 470 }, |
| 471 "type": "array" |
| 472 } |
| 473 }, |
| 474 "type": "object" |
| 475 }, |
437 "GoogleServiceAccount": { | 476 "GoogleServiceAccount": { |
438 "description": "Google service account", | 477 "description": "Google service account", |
439 "id": "GoogleServiceAccount", | 478 "id": "GoogleServiceAccount", |
440 "properties": { | 479 "properties": { |
441 "accountEmail": { | 480 "accountEmail": { |
442 "description": "Required.", | 481 "description": "Required.", |
443 "type": "string" | 482 "type": "string" |
444 } | 483 } |
445 }, | 484 }, |
446 "type": "object" | 485 "type": "object" |
447 }, | 486 }, |
| 487 "TimeOfDay": { |
| 488 "description": "Represents a time of day. The date and time zone are
either not significant\nor are specified elsewhere. An API may choose to allow
leap seconds. Related\ntypes are google.type.Date and `google.protobuf.Timestamp
`.", |
| 489 "id": "TimeOfDay", |
| 490 "properties": { |
| 491 "hours": { |
| 492 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose\nto allow the value \"24:00:00\" for scenarios lik
e business closing time.", |
| 493 "format": "int32", |
| 494 "type": "integer" |
| 495 }, |
| 496 "nanos": { |
| 497 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", |
| 498 "format": "int32", |
| 499 "type": "integer" |
| 500 }, |
| 501 "seconds": { |
| 502 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may\nallow the value 60 if it allows leap-seconds.", |
| 503 "format": "int32", |
| 504 "type": "integer" |
| 505 }, |
| 506 "minutes": { |
| 507 "description": "Minutes of hour of day. Must be from 0 to 59
.", |
| 508 "format": "int32", |
| 509 "type": "integer" |
| 510 } |
| 511 }, |
| 512 "type": "object" |
| 513 }, |
| 514 "ErrorLogEntry": { |
| 515 "description": "An entry describing an error that has occurred.", |
| 516 "id": "ErrorLogEntry", |
| 517 "properties": { |
| 518 "url": { |
| 519 "description": "A URL that refers to the target (a data sour
ce, a data sink,\nor an object) with which the error is associated.\nRequired.", |
| 520 "type": "string" |
| 521 }, |
| 522 "errorDetails": { |
| 523 "description": "A list of messages that carry the error deta
ils.", |
| 524 "items": { |
| 525 "type": "string" |
| 526 }, |
| 527 "type": "array" |
| 528 } |
| 529 }, |
| 530 "type": "object" |
| 531 }, |
448 "TransferJob": { | 532 "TransferJob": { |
449 "description": "This resource represents the configuration of a tran
sfer job that runs periodically.", | 533 "description": "This resource represents the configuration of a tran
sfer job that runs\nperiodically.", |
450 "id": "TransferJob", | 534 "id": "TransferJob", |
451 "properties": { | 535 "properties": { |
452 "name": { | |
453 "description": "A globally unique name assigned by Storage T
ransfer Service when the job is created. This field should be left empty in requ
ests to create a new transfer job; otherwise, the requests result in an `INVALID
_ARGUMENT` error.", | |
454 "type": "string" | |
455 }, | |
456 "description": { | |
457 "description": "A description provided by the user for the j
ob. Its max length is 1024 bytes when Unicode-encoded.", | |
458 "type": "string" | |
459 }, | |
460 "projectId": { | |
461 "description": "The ID of the Google Developers Console proj
ect that owns the job. Required.", | |
462 "type": "string" | |
463 }, | |
464 "transferSpec": { | |
465 "$ref": "TransferSpec", | |
466 "description": "Transfer specification. Required." | |
467 }, | |
468 "schedule": { | |
469 "$ref": "Schedule", | |
470 "description": "Schedule specification. Required." | |
471 }, | |
472 "status": { | 536 "status": { |
473 "description": "Status of the job. This value MUST be specif
ied for `CreateTransferJobRequests`. NOTE: The effect of the new job status take
s place during a subsequent job run. For example, if you change the job status f
rom `ENABLED` to `DISABLED`, and an operation spawned by the transfer is running
, the status change would not affect the current operation.", | 537 "description": "Status of the job. This value MUST be specif
ied for\n`CreateTransferJobRequests`.\n\nNOTE: The effect of the new job status
takes place during a subsequent job\nrun. For example, if you change the job sta
tus from `ENABLED` to\n`DISABLED`, and an operation spawned by the transfer is r
unning, the status\nchange would not affect the current operation.", |
474 "enum": [ | 538 "enum": [ |
475 "STATUS_UNSPECIFIED", | 539 "STATUS_UNSPECIFIED", |
476 "ENABLED", | 540 "ENABLED", |
477 "DISABLED", | 541 "DISABLED", |
478 "DELETED" | 542 "DELETED" |
479 ], | 543 ], |
480 "type": "string" | 544 "enumDescriptions": [ |
| 545 "Zero is an illegal value.", |
| 546 "New transfers will be performed based on the schedule."
, |
| 547 "New transfers will not be scheduled.", |
| 548 "This is a soft delete state. After a transfer job is se
t to this\nstate, the job and all the transfer executions are subject to\ngarbag
e collection." |
| 549 ], |
| 550 "type": "string" |
| 551 }, |
| 552 "schedule": { |
| 553 "$ref": "Schedule", |
| 554 "description": "Schedule specification.\nRequired." |
| 555 }, |
| 556 "deletionTime": { |
| 557 "description": "This field cannot be changed by user request
s.", |
| 558 "format": "google-datetime", |
| 559 "type": "string" |
| 560 }, |
| 561 "name": { |
| 562 "description": "A globally unique name assigned by Storage T
ransfer Service when the\njob is created. This field should be left empty in req
uests to create a new\ntransfer job; otherwise, the requests result in an `INVAL
ID_ARGUMENT`\nerror.", |
| 563 "type": "string" |
| 564 }, |
| 565 "lastModificationTime": { |
| 566 "description": "This field cannot be changed by user request
s.", |
| 567 "format": "google-datetime", |
| 568 "type": "string" |
| 569 }, |
| 570 "projectId": { |
| 571 "description": "The ID of the Google Cloud Platform Console
project that owns the job.\nRequired.", |
| 572 "type": "string" |
| 573 }, |
| 574 "description": { |
| 575 "description": "A description provided by the user for the j
ob. Its max length is 1024\nbytes when Unicode-encoded.", |
| 576 "type": "string" |
| 577 }, |
| 578 "transferSpec": { |
| 579 "$ref": "TransferSpec", |
| 580 "description": "Transfer specification.\nRequired." |
481 }, | 581 }, |
482 "creationTime": { | 582 "creationTime": { |
483 "description": "This field cannot be changed by user request
s.", | 583 "description": "This field cannot be changed by user request
s.", |
484 "type": "string" | 584 "format": "google-datetime", |
485 }, | 585 "type": "string" |
486 "lastModificationTime": { | |
487 "description": "This field cannot be changed by user request
s.", | |
488 "type": "string" | |
489 }, | |
490 "deletionTime": { | |
491 "description": "This field cannot be changed by user request
s.", | |
492 "type": "string" | |
493 } | |
494 }, | |
495 "type": "object" | |
496 }, | |
497 "TransferSpec": { | |
498 "description": "Configuration for running a transfer.", | |
499 "id": "TransferSpec", | |
500 "properties": { | |
501 "gcsDataSource": { | |
502 "$ref": "GcsData", | |
503 "description": "A Google Cloud Storage data source." | |
504 }, | |
505 "awsS3DataSource": { | |
506 "$ref": "AwsS3Data", | |
507 "description": "An AWS S3 data source." | |
508 }, | |
509 "httpDataSource": { | |
510 "$ref": "HttpData", | |
511 "description": "An HTTP URL data source." | |
512 }, | |
513 "gcsDataSink": { | |
514 "$ref": "GcsData", | |
515 "description": "A Google Cloud Storage data sink." | |
516 }, | |
517 "objectConditions": { | |
518 "$ref": "ObjectConditions", | |
519 "description": "Only objects that satisfy these object condi
tions are included in the set of data source and data sink objects. Object condi
tions based on objects' `lastModificationTime` do not exclude objects in a data
sink." | |
520 }, | |
521 "transferOptions": { | |
522 "$ref": "TransferOptions", | |
523 "description": "If the option `deleteObjectsUniqueInSink` is
`true`, object conditions based on objects' `lastModificationTime` are ignored
and do not exclude objects in a data source or a data sink." | |
524 } | |
525 }, | |
526 "type": "object" | |
527 }, | |
528 "GcsData": { | |
529 "description": "In a GcsData, an object's name is the Google Cloud S
torage object's name and its `lastModificationTime` refers to the object's updat
ed time, which changes when the content or the metadata of the object is updated
.", | |
530 "id": "GcsData", | |
531 "properties": { | |
532 "bucketName": { | |
533 "description": "Google Cloud Storage bucket name (see [Bucke
t Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#require
ments)). Required.", | |
534 "type": "string" | |
535 } | |
536 }, | |
537 "type": "object" | |
538 }, | |
539 "AwsS3Data": { | |
540 "description": "An AwsS3Data can be a data source, but not a data si
nk. In an AwsS3Data, an object's name is the S3 object's key name.", | |
541 "id": "AwsS3Data", | |
542 "properties": { | |
543 "bucketName": { | |
544 "description": "S3 Bucket name (see [Creating a bucket](http
://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.ht
ml)). Required.", | |
545 "type": "string" | |
546 }, | |
547 "awsAccessKey": { | |
548 "$ref": "AwsAccessKey", | |
549 "description": "AWS access key used to sign the API requests
to the AWS S3 bucket. Permissions on the bucket must be granted to the access I
D of the AWS access key. Required." | |
550 } | |
551 }, | |
552 "type": "object" | |
553 }, | |
554 "AwsAccessKey": { | |
555 "description": "AWS access key (see [AWS Security Credentials](http:
//docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).", | |
556 "id": "AwsAccessKey", | |
557 "properties": { | |
558 "accessKeyId": { | |
559 "description": "AWS access key ID. Required.", | |
560 "type": "string" | |
561 }, | |
562 "secretAccessKey": { | |
563 "description": "AWS secret access key. This field is not ret
urned in RPC responses. Required.", | |
564 "type": "string" | |
565 } | |
566 }, | |
567 "type": "object" | |
568 }, | |
569 "HttpData": { | |
570 "description": "An HttpData specifies a list of objects on the web t
o be transferred over HTTP. The information of the objects to be transferred is
contained in a file referenced by a URL. The first line in the file must be \"Ts
vHttpData-1.0\", which specifies the format of the file. Subsequent lines specif
y the information of the list of objects, one object per list entry. Each entry
has the following tab-delimited fields: * HTTP URL * Length * MD5 - This field i
s a base64-encoded MD5 hash of the object An HTTP URL that points to the object
to be transferred. It must be a valid URL with URL scheme HTTP or HTTPS. When an
object with URL `http(s)://hostname:port/` is transferred to the data sink, the
name of the object at the data sink is `/`. Length and MD5 provide the size and
the base64-encoded MD5 hash of the object. If Length does not match the actual
length of the object fetched, the object will not be transferred. If MD5 does no
t match the MD5 computed from the transferred bytes, the object transfer will fa
il. `lastModificationTime` is not available in HttpData objects. The objects tha
t the URL list points to must allow public access. Storage Transfer Service obey
s `robots.txt` rules and requires the HTTP server to support Range requests and
to return a Content-Length header in each response.", | |
571 "id": "HttpData", | |
572 "properties": { | |
573 "listUrl": { | |
574 "description": "The URL that points to the file that stores
the object list entries. This file must allow public access. Currently, only URL
s with HTTP and HTTPS schemes are supported. Required.", | |
575 "type": "string" | |
576 } | |
577 }, | |
578 "type": "object" | |
579 }, | |
580 "ObjectConditions": { | |
581 "description": "Conditions that determine which objects will be tran
sferred.", | |
582 "id": "ObjectConditions", | |
583 "properties": { | |
584 "minTimeElapsedSinceLastModification": { | |
585 "description": "If unspecified, `minTimeElapsedSinceLastModi
fication` takes a zero value and `maxTimeElapsedSinceLastModification` takes the
maximum possible value of Duration. Objects that satisfy the object conditions
must either have a `lastModificationTime` greater or equal to `NOW` - `maxTimeEl
apsedSinceLastModification` and less than `NOW` - `minTimeElapsedSinceLastModifi
cation`, or not have a `lastModificationTime`.", | |
586 "type": "string" | |
587 }, | |
588 "maxTimeElapsedSinceLastModification": { | |
589 "description": "`maxTimeElapsedSinceLastModification` is the
complement to `minTimeElapsedSinceLastModification`.", | |
590 "type": "string" | |
591 }, | |
592 "includePrefixes": { | |
593 "description": "If `includePrefixes` is specified, objects t
hat satisfy the object conditions must have names that start with one of the `in
cludePrefixes` and that do not start with any of the `excludePrefixes`. If `incl
udePrefixes` is not specified, all objects except those that have names starting
with one of the `excludePrefixes` must satisfy the object conditions. Requireme
nts: * Each include-prefix and exclude-prefix can contain any sequence of Unicod
e characters, of max length 1024 bytes when UTF8-encoded, and must not contain C
arriage Return or Line Feed characters. Wildcard matching and regular expression
matching are not supported. * None of the include-prefix or the exclude-prefix
values can be empty, if specified. * Each include-prefix must include a distinct
portion of the object namespace, i.e., no include-prefix may be a prefix of ano
ther include-prefix. * Each exclude-prefix must exclude a distinct portion of th
e object namespace, i.e., no exclude-prefix may be a prefix of another exclude-p
refix. * If `includePrefixes` is specified, then each exclude-prefix must start
with the value of a path explicitly included by `includePrefixes`. The max size
of `includePrefixes` is 20.", | |
594 "items": { | |
595 "type": "string" | |
596 }, | |
597 "type": "array" | |
598 }, | |
599 "excludePrefixes": { | |
600 "description": "`excludePrefixes` must follow the requiremen
ts described for `includePrefixes`. The max size of `excludePrefixes` is 20.", | |
601 "items": { | |
602 "type": "string" | |
603 }, | |
604 "type": "array" | |
605 } | |
606 }, | |
607 "type": "object" | |
608 }, | |
609 "TransferOptions": { | |
610 "description": "TransferOptions uses three boolean parameters to def
ine the actions to be performed on objects in a transfer.", | |
611 "id": "TransferOptions", | |
612 "properties": { | |
613 "overwriteObjectsAlreadyExistingInSink": { | |
614 "description": "Whether overwriting objects that already exi
st in the sink is allowed.", | |
615 "type": "boolean" | |
616 }, | |
617 "deleteObjectsUniqueInSink": { | |
618 "description": "Whether objects that exist only in the sink
should be deleted.", | |
619 "type": "boolean" | |
620 }, | |
621 "deleteObjectsFromSourceAfterTransfer": { | |
622 "description": "Whether objects should be deleted from the s
ource after they are transferred to the sink.", | |
623 "type": "boolean" | |
624 } | 586 } |
625 }, | 587 }, |
626 "type": "object" | 588 "type": "object" |
627 }, | 589 }, |
628 "Schedule": { | 590 "Schedule": { |
629 "description": "Transfers can be scheduled to recur or to run just o
nce.", | 591 "description": "Transfers can be scheduled to recur or to run just o
nce.", |
630 "id": "Schedule", | 592 "id": "Schedule", |
631 "properties": { | 593 "properties": { |
| 594 "scheduleEndDate": { |
| 595 "$ref": "Date", |
| 596 "description": "The last day the recurring transfer will be
run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will
be executed only\nonce." |
| 597 }, |
| 598 "startTimeOfDay": { |
| 599 "$ref": "TimeOfDay", |
| 600 "description": "The time in UTC at which the transfer will b
e scheduled to start in a day.\nTransfers may start later than this time. If not
specified, recurring and\none-time transfers that are scheduled to run today wi
ll run immediately;\nrecurring transfers that are scheduled to run on a future d
ate will start\nat approximately midnight UTC on that date. Note that when confi
guring a\ntransfer with the Cloud Platform Console, the transfer's start time in
a\nday is specified in your local timezone." |
| 601 }, |
632 "scheduleStartDate": { | 602 "scheduleStartDate": { |
633 "$ref": "Date", | 603 "$ref": "Date", |
634 "description": "The first day the recurring transfer is sche
duled to run. Required." | 604 "description": "The first day the recurring transfer is sche
duled to run. If\n`scheduleStartDate` is in the past, the transfer will run for
the first\ntime on the following day.\nRequired." |
635 }, | |
636 "scheduleEndDate": { | |
637 "$ref": "Date", | |
638 "description": "The last day the recurring transfer will be
run. If `scheduleEndDate` is the same as `scheduleStartDate`, the transfer will
be executed only once." | |
639 }, | |
640 "startTimeOfDay": { | |
641 "$ref": "TimeOfDay", | |
642 "description": "The time in UTC at which the transfer will b
e scheduled to start in a day. Transfers may start later than this time. If not
specified, transfers are scheduled to start at midnight UTC." | |
643 } | 605 } |
644 }, | 606 }, |
645 "type": "object" | 607 "type": "object" |
646 }, | 608 }, |
647 "Date": { | 609 "Date": { |
648 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and time zone are either specified elsewhere or are not signif
icant. The date is relative to the Proleptic Gregorian Calendar. The day may be
0 to represent a year and month where the day is not significant, e.g. credit ca
rd expiration date. The year may be 0 to represent a month and day independent o
f year, e.g. anniversary date. Related types are [google.type.TimeOfDay][google.
type.TimeOfDay] and `google.protobuf.Timestamp`.", | 610 "description": "Represents a whole calendar date, e.g. date of birth
. The time of day and\ntime zone are either specified elsewhere or are not signi
ficant. The date\nis relative to the Proleptic Gregorian Calendar. The day may b
e 0 to\nrepresent a year and month where the day is not significant, e.g. credit
card\nexpiration date. The year may be 0 to represent a month and day independe
nt\nof year, e.g. anniversary date. Related types are google.type.TimeOfDay\nand
`google.protobuf.Timestamp`.", |
649 "id": "Date", | 611 "id": "Date", |
650 "properties": { | 612 "properties": { |
651 "year": { | 613 "year": { |
652 "description": "Year of date. Must be from 1 to 9,999, or 0
if specifying a date without a year.", | 614 "description": "Year of date. Must be from 1 to 9999, or 0 i
f specifying a date without\na year.", |
| 615 "format": "int32", |
| 616 "type": "integer" |
| 617 }, |
| 618 "day": { |
| 619 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0\nif specifying a year/month where the day is not s
ignificant.", |
653 "format": "int32", | 620 "format": "int32", |
654 "type": "integer" | 621 "type": "integer" |
655 }, | 622 }, |
656 "month": { | 623 "month": { |
657 "description": "Month of year of date. Must be from 1 to 12.
", | 624 "description": "Month of year. Must be from 1 to 12.", |
658 "format": "int32", | 625 "format": "int32", |
659 "type": "integer" | 626 "type": "integer" |
660 }, | |
661 "day": { | |
662 "description": "Day of month. Must be from 1 to 31 and valid
for the year and month, or 0 if specifying a year/month where the day is not si
gificant.", | |
663 "format": "int32", | |
664 "type": "integer" | |
665 } | |
666 }, | |
667 "type": "object" | |
668 }, | |
669 "TimeOfDay": { | |
670 "description": "Represents a time of day. The date and time zone are
either not significant or are specified elsewhere. An API may chose to allow le
ap seconds. Related types are [google.type.Date][google.type.Date] and `google.p
rotobuf.Timestamp`.", | |
671 "id": "TimeOfDay", | |
672 "properties": { | |
673 "hours": { | |
674 "description": "Hours of day in 24 hour format. Should be fr
om 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like
business closing time.", | |
675 "format": "int32", | |
676 "type": "integer" | |
677 }, | |
678 "minutes": { | |
679 "description": "Minutes of hour of day. Must be from 0 to 59
.", | |
680 "format": "int32", | |
681 "type": "integer" | |
682 }, | |
683 "seconds": { | |
684 "description": "Seconds of minutes of the time. Must normall
y be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", | |
685 "format": "int32", | |
686 "type": "integer" | |
687 }, | |
688 "nanos": { | |
689 "description": "Fractions of seconds in nanoseconds. Must be
from 0 to 999,999,999.", | |
690 "format": "int32", | |
691 "type": "integer" | |
692 } | |
693 }, | |
694 "type": "object" | |
695 }, | |
696 "UpdateTransferJobRequest": { | |
697 "description": "Request passed to UpdateTransferJob.", | |
698 "id": "UpdateTransferJobRequest", | |
699 "properties": { | |
700 "projectId": { | |
701 "description": "The ID of the Google Developers Console proj
ect that owns the job. Required.", | |
702 "type": "string" | |
703 }, | |
704 "transferJob": { | |
705 "$ref": "TransferJob", | |
706 "description": "The job to update. Required." | |
707 }, | |
708 "updateTransferJobFieldMask": { | |
709 "description": "The field mask of the fields in `transferJob
` that are to be updated in this request. Fields in `transferJob` that can be up
dated are: `description`, `transferSpec`, and `status`. To update the `transferS
pec` of the job, a complete transfer specification has to be provided. An incomp
lete specification which misses any required fields will be rejected with the er
ror `INVALID_ARGUMENT`.", | |
710 "type": "string" | |
711 } | |
712 }, | |
713 "type": "object" | |
714 }, | |
715 "ListTransferJobsResponse": { | |
716 "description": "Response from ListTransferJobs.", | |
717 "id": "ListTransferJobsResponse", | |
718 "properties": { | |
719 "transferJobs": { | |
720 "description": "A list of transfer jobs.", | |
721 "items": { | |
722 "$ref": "TransferJob" | |
723 }, | |
724 "type": "array" | |
725 }, | |
726 "nextPageToken": { | |
727 "description": "The list next page token.", | |
728 "type": "string" | |
729 } | |
730 }, | |
731 "type": "object" | |
732 }, | |
733 "PauseTransferOperationRequest": { | |
734 "description": "Request passed to PauseTransferOperation.", | |
735 "id": "PauseTransferOperationRequest", | |
736 "type": "object" | |
737 }, | |
738 "Empty": { | |
739 "description": "A generic empty message that you can re-use to avoid
defining duplicated empty messages in your APIs. A typical example is to use it
as the request or the response type of an API method. For instance: service Foo
{ rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON re
presentation for `Empty` is empty JSON object `{}`.", | |
740 "id": "Empty", | |
741 "type": "object" | |
742 }, | |
743 "ResumeTransferOperationRequest": { | |
744 "description": "Request passed to ResumeTransferOperation.", | |
745 "id": "ResumeTransferOperationRequest", | |
746 "type": "object" | |
747 }, | |
748 "Operation": { | |
749 "description": "This resource represents a long-running operation th
at is the result of a network API call.", | |
750 "id": "Operation", | |
751 "properties": { | |
752 "name": { | |
753 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping above, the `name` should have the format of `operations/some/unique/n
ame`.", | |
754 "type": "string" | |
755 }, | |
756 "metadata": { | |
757 "additionalProperties": { | |
758 "description": "Properties of the object. Contains field
@ype with type URL.", | |
759 "type": "any" | |
760 }, | |
761 "description": "Represents the transfer operation object.", | |
762 "type": "object" | |
763 }, | |
764 "done": { | |
765 "description": "If the value is `false`, it means the operat
ion is still in progress. If true, the operation is completed and the `result` i
s available.", | |
766 "type": "boolean" | |
767 }, | |
768 "error": { | |
769 "$ref": "Status", | |
770 "description": "The error result of the operation in case of
failure." | |
771 }, | |
772 "response": { | |
773 "additionalProperties": { | |
774 "description": "Properties of the object. Contains field
@ype with type URL.", | |
775 "type": "any" | |
776 }, | |
777 "description": "The normal response of the operation in case
of success. If the original method returns no data on success, such as `Delete`
, the response is `google.protobuf.Empty`. If the original method is standard `G
et`/`Create`/`Update`, the response should be the resource. For other methods, t
he response should have the type `XxxResponse`, where `Xxx` is the original meth
od name. For example, if the original method name is `TakeSnapshot()`, the infer
red response type is `TakeSnapshotResponse`.", | |
778 "type": "object" | |
779 } | |
780 }, | |
781 "type": "object" | |
782 }, | |
783 "Status": { | |
784 "description": "The `Status` type defines a logical error model that
is suitable for different programming environments, including REST APIs and RPC
APIs. It is used by [gRPC](https://github.com/grpc). The error model is designe
d to be: - Simple to use and understand for most users - Flexible enough to meet
unexpected needs # Overview The `Status` message contains three pieces of data:
error code, error message, and error details. The error code should be an enum
value of [google.rpc.Code][google.rpc.Code], but it may accept additional error
codes if needed. The error message should be a developer-facing English message
that helps developers *understand* and *resolve* the error. If a localized user-
facing error message is needed, put the localized message in the error details o
r localize it in the client. The optional error details may contain arbitrary in
formation about the error. There is a predefined set of error detail types in th
e package `google.rpc` which can be used for common error conditions. # Language
mapping The `Status` message is the logical representation of the error model,
but it is not necessarily the actual wire format. When the `Status` message is e
xposed in different client libraries and different wire protocols, it can be map
ped differently. For example, it will likely be mapped to some exceptions in Jav
a, but more likely mapped to some error codes in C. # Other uses The error model
and the `Status` message can be used in a variety of environments, either with
or without APIs, to provide a consistent developer experience across different e
nvironments. Example uses of this error model include: - Partial errors. If a se
rvice needs to return partial errors to the client, it may embed the `Status` in
the normal response to indicate the partial errors. - Workflow errors. A typica
l workflow has multiple steps. Each step may have a `Status` message for error r
eporting purpose. - Batch operations. If a client uses batch request and batch r
esponse, the `Status` message should be used directly inside batch response, one
for each error sub-response. - Asynchronous operations. If an API call embeds a
synchronous operation results in its response, the status of those operations sh
ould be represented directly using the `Status` message. - Logging. If some API
errors are stored in logs, the message `Status` could be used directly after any
stripping needed for security/privacy reasons.", | |
785 "id": "Status", | |
786 "properties": { | |
787 "code": { | |
788 "description": "The status code, which should be an enum val
ue of [google.rpc.Code][google.rpc.Code].", | |
789 "format": "int32", | |
790 "type": "integer" | |
791 }, | |
792 "message": { | |
793 "description": "A developer-facing error message, which shou
ld be in English. Any user-facing error message should be localized and sent in
the [google.rpc.Status.details][google.rpc.Status.details] field, or localized b
y the client.", | |
794 "type": "string" | |
795 }, | |
796 "details": { | |
797 "description": "A list of messages that carry the error deta
ils. There will be a common set of message types for APIs to use.", | |
798 "items": { | |
799 "additionalProperties": { | |
800 "description": "Properties of the object. Contains f
ield @ype with type URL.", | |
801 "type": "any" | |
802 }, | |
803 "type": "object" | |
804 }, | |
805 "type": "array" | |
806 } | |
807 }, | |
808 "type": "object" | |
809 }, | |
810 "ListOperationsResponse": { | |
811 "description": "The response message for [Operations.ListOperations]
[google.longrunning.Operations.ListOperations].", | |
812 "id": "ListOperationsResponse", | |
813 "properties": { | |
814 "operations": { | |
815 "description": "A list of operations that matches the specif
ied filter in the request.", | |
816 "items": { | |
817 "$ref": "Operation" | |
818 }, | |
819 "type": "array" | |
820 }, | |
821 "nextPageToken": { | |
822 "description": "The standard List next-page token.", | |
823 "type": "string" | |
824 } | 627 } |
825 }, | 628 }, |
826 "type": "object" | 629 "type": "object" |
827 }, | 630 }, |
828 "TransferOperation": { | 631 "TransferOperation": { |
829 "description": "A description of the execution of a transfer.", | 632 "description": "A description of the execution of a transfer.", |
830 "id": "TransferOperation", | 633 "id": "TransferOperation", |
831 "properties": { | 634 "properties": { |
832 "name": { | 635 "endTime": { |
833 "description": "A globally unique ID assigned by the system.
", | 636 "description": "End time of this transfer execution.", |
834 "type": "string" | 637 "format": "google-datetime", |
835 }, | 638 "type": "string" |
836 "projectId": { | 639 }, |
837 "description": "The ID of the Google Developers Console proj
ect that owns the operation. Required.", | 640 "startTime": { |
| 641 "description": "Start time of this transfer execution.", |
| 642 "format": "google-datetime", |
| 643 "type": "string" |
| 644 }, |
| 645 "transferJobName": { |
| 646 "description": "The name of the transfer job that triggers t
his transfer operation.", |
838 "type": "string" | 647 "type": "string" |
839 }, | 648 }, |
840 "transferSpec": { | 649 "transferSpec": { |
841 "$ref": "TransferSpec", | 650 "$ref": "TransferSpec", |
842 "description": "Transfer specification. Required." | 651 "description": "Transfer specification.\nRequired." |
843 }, | |
844 "startTime": { | |
845 "description": "Start time of this transfer execution.", | |
846 "type": "string" | |
847 }, | |
848 "endTime": { | |
849 "description": "End time of this transfer execution.", | |
850 "type": "string" | |
851 }, | 652 }, |
852 "status": { | 653 "status": { |
853 "description": "Status of the transfer operation.", | 654 "description": "Status of the transfer operation.", |
854 "enum": [ | 655 "enum": [ |
855 "STATUS_UNSPECIFIED", | 656 "STATUS_UNSPECIFIED", |
856 "IN_PROGRESS", | 657 "IN_PROGRESS", |
857 "PAUSED", | 658 "PAUSED", |
858 "SUCCESS", | 659 "SUCCESS", |
859 "FAILED", | 660 "FAILED", |
860 "ABORTED" | 661 "ABORTED" |
861 ], | 662 ], |
| 663 "enumDescriptions": [ |
| 664 "Zero is an illegal value.", |
| 665 "In progress.", |
| 666 "Paused.", |
| 667 "Completed successfully.", |
| 668 "Terminated due to an unrecoverable failure.", |
| 669 "Aborted by the user." |
| 670 ], |
862 "type": "string" | 671 "type": "string" |
863 }, | 672 }, |
864 "counters": { | 673 "counters": { |
865 "$ref": "TransferCounters", | 674 "$ref": "TransferCounters", |
866 "description": "Information about the progress of the transf
er operation." | 675 "description": "Information about the progress of the transf
er operation." |
867 }, | 676 }, |
868 "errorBreakdowns": { | 677 "errorBreakdowns": { |
869 "description": "Summarizes errors encountered with sample er
ror log entries.", | 678 "description": "Summarizes errors encountered with sample er
ror log entries.", |
870 "items": { | 679 "items": { |
871 "$ref": "ErrorSummary" | 680 "$ref": "ErrorSummary" |
872 }, | 681 }, |
873 "type": "array" | 682 "type": "array" |
874 }, | 683 }, |
875 "transferJobName": { | 684 "name": { |
876 "description": "The name of the transfer job that triggers t
his transfer operation.", | 685 "description": "A globally unique ID assigned by the system.
", |
| 686 "type": "string" |
| 687 }, |
| 688 "projectId": { |
| 689 "description": "The ID of the Google Cloud Platform Console
project that owns the operation.\nRequired.", |
877 "type": "string" | 690 "type": "string" |
878 } | 691 } |
879 }, | 692 }, |
880 "type": "object" | 693 "type": "object" |
881 }, | 694 }, |
| 695 "AwsS3Data": { |
| 696 "description": "An AwsS3Data can be a data source, but not a data si
nk.\nIn an AwsS3Data, an object's name is the S3 object's key name.", |
| 697 "id": "AwsS3Data", |
| 698 "properties": { |
| 699 "bucketName": { |
| 700 "description": "S3 Bucket name (see\n[Creating a bucket](htt
p://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.h
tml)).\nRequired.", |
| 701 "type": "string" |
| 702 }, |
| 703 "awsAccessKey": { |
| 704 "$ref": "AwsAccessKey", |
| 705 "description": "AWS access key used to sign the API requests
to the AWS S3 bucket.\nPermissions on the bucket must be granted to the access
ID of the\nAWS access key.\nRequired." |
| 706 } |
| 707 }, |
| 708 "type": "object" |
| 709 }, |
| 710 "AwsAccessKey": { |
| 711 "description": "AWS access key (see\n[AWS Security Credentials](http
://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).", |
| 712 "id": "AwsAccessKey", |
| 713 "properties": { |
| 714 "accessKeyId": { |
| 715 "description": "AWS access key ID.\nRequired.", |
| 716 "type": "string" |
| 717 }, |
| 718 "secretAccessKey": { |
| 719 "description": "AWS secret access key. This field is not ret
urned in RPC responses.\nRequired.", |
| 720 "type": "string" |
| 721 } |
| 722 }, |
| 723 "type": "object" |
| 724 }, |
| 725 "Empty": { |
| 726 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
| 727 "id": "Empty", |
| 728 "properties": {}, |
| 729 "type": "object" |
| 730 }, |
| 731 "PauseTransferOperationRequest": { |
| 732 "description": "Request passed to PauseTransferOperation.", |
| 733 "id": "PauseTransferOperationRequest", |
| 734 "properties": {}, |
| 735 "type": "object" |
| 736 }, |
882 "TransferCounters": { | 737 "TransferCounters": { |
883 "description": "A collection of counters that report the progress of
a transfer operation.", | 738 "description": "A collection of counters that report the progress of
a transfer operation.", |
884 "id": "TransferCounters", | 739 "id": "TransferCounters", |
885 "properties": { | 740 "properties": { |
886 "objectsFoundFromSource": { | 741 "bytesFoundFromSource": { |
887 "description": "Objects found in the data source that are sc
heduled to be transferred, which will be copied, excluded based on conditions, o
r skipped due to failures.", | 742 "description": "Bytes found in the data source that are sche
duled to be transferred,\nwhich will be copied, excluded based on conditions, or
skipped due to\nfailures.", |
888 "format": "int64", | 743 "format": "int64", |
889 "type": "string" | 744 "type": "string" |
890 }, | 745 }, |
891 "bytesFoundFromSource": { | 746 "objectsFromSourceSkippedBySync": { |
892 "description": "Bytes found in the data source that are sche
duled to be transferred, which will be copied, excluded based on conditions, or
skipped due to failures.", | 747 "description": "Objects in the data source that are not tran
sferred because they already\nexist in the data sink.", |
| 748 "format": "int64", |
| 749 "type": "string" |
| 750 }, |
| 751 "bytesDeletedFromSource": { |
| 752 "description": "Bytes that are deleted from the data source.
", |
| 753 "format": "int64", |
| 754 "type": "string" |
| 755 }, |
| 756 "objectsFoundFromSource": { |
| 757 "description": "Objects found in the data source that are sc
heduled to be transferred,\nwhich will be copied, excluded based on conditions,
or skipped due to\nfailures.", |
| 758 "format": "int64", |
| 759 "type": "string" |
| 760 }, |
| 761 "objectsFailedToDeleteFromSink": { |
| 762 "description": "Objects that failed to be deleted from the d
ata sink.", |
893 "format": "int64", | 763 "format": "int64", |
894 "type": "string" | 764 "type": "string" |
895 }, | 765 }, |
896 "objectsFoundOnlyFromSink": { | 766 "objectsFoundOnlyFromSink": { |
897 "description": "Objects found only in the data sink that are
scheduled to be deleted.", | 767 "description": "Objects found only in the data sink that are
scheduled to be deleted.", |
898 "format": "int64", | 768 "format": "int64", |
899 "type": "string" | 769 "type": "string" |
900 }, | 770 }, |
901 "bytesFoundOnlyFromSink": { | 771 "objectsDeletedFromSink": { |
902 "description": "Bytes found only in the data sink that are s
cheduled to be deleted.", | 772 "description": "Objects that are deleted from the data sink.
", |
903 "format": "int64", | |
904 "type": "string" | |
905 }, | |
906 "objectsFromSourceSkippedBySync": { | |
907 "description": "Objects in the data source that are not tran
sferred because they already exist in the data sink.", | |
908 "format": "int64", | 773 "format": "int64", |
909 "type": "string" | 774 "type": "string" |
910 }, | 775 }, |
911 "bytesFromSourceSkippedBySync": { | 776 "bytesFromSourceSkippedBySync": { |
912 "description": "Bytes in the data source that are not transf
erred because they already exist in the data sink.", | 777 "description": "Bytes in the data source that are not transf
erred because they already\nexist in the data sink.", |
| 778 "format": "int64", |
| 779 "type": "string" |
| 780 }, |
| 781 "bytesDeletedFromSink": { |
| 782 "description": "Bytes that are deleted from the data sink.", |
| 783 "format": "int64", |
| 784 "type": "string" |
| 785 }, |
| 786 "bytesFailedToDeleteFromSink": { |
| 787 "description": "Bytes that failed to be deleted from the dat
a sink.", |
| 788 "format": "int64", |
| 789 "type": "string" |
| 790 }, |
| 791 "bytesFromSourceFailed": { |
| 792 "description": "Bytes in the data source that failed during
the transfer.", |
913 "format": "int64", | 793 "format": "int64", |
914 "type": "string" | 794 "type": "string" |
915 }, | 795 }, |
916 "objectsCopiedToSink": { | 796 "objectsCopiedToSink": { |
917 "description": "Objects that are copied to the data sink.", | 797 "description": "Objects that are copied to the data sink.", |
918 "format": "int64", | 798 "format": "int64", |
919 "type": "string" | 799 "type": "string" |
920 }, | 800 }, |
921 "bytesCopiedToSink": { | |
922 "description": "Bytes that are copied to the data sink.", | |
923 "format": "int64", | |
924 "type": "string" | |
925 }, | |
926 "objectsDeletedFromSource": { | |
927 "description": "Objects that are deleted from the data sourc
e.", | |
928 "format": "int64", | |
929 "type": "string" | |
930 }, | |
931 "bytesDeletedFromSource": { | |
932 "description": "Bytes that are deleted from the data source.
", | |
933 "format": "int64", | |
934 "type": "string" | |
935 }, | |
936 "objectsDeletedFromSink": { | |
937 "description": "Objects that are deleted from the data sink.
", | |
938 "format": "int64", | |
939 "type": "string" | |
940 }, | |
941 "bytesDeletedFromSink": { | |
942 "description": "Bytes that are deleted from the data sink.", | |
943 "format": "int64", | |
944 "type": "string" | |
945 }, | |
946 "objectsFromSourceFailed": { | 801 "objectsFromSourceFailed": { |
947 "description": "Objects in the data source that failed durin
g the transfer.", | 802 "description": "Objects in the data source that failed durin
g the transfer.", |
948 "format": "int64", | 803 "format": "int64", |
949 "type": "string" | 804 "type": "string" |
950 }, | 805 }, |
951 "bytesFromSourceFailed": { | 806 "bytesFoundOnlyFromSink": { |
952 "description": "Bytes in the data source that failed during
the transfer.", | 807 "description": "Bytes found only in the data sink that are s
cheduled to be deleted.", |
953 "format": "int64", | 808 "format": "int64", |
954 "type": "string" | 809 "type": "string" |
955 }, | 810 }, |
956 "objectsFailedToDeleteFromSink": { | 811 "objectsDeletedFromSource": { |
957 "description": "Objects that failed to be deleted from the d
ata sink.", | 812 "description": "Objects that are deleted from the data sourc
e.", |
958 "format": "int64", | 813 "format": "int64", |
959 "type": "string" | 814 "type": "string" |
960 }, | 815 }, |
961 "bytesFailedToDeleteFromSink": { | 816 "bytesCopiedToSink": { |
962 "description": "Bytes that failed to be deleted from the dat
a sink.", | 817 "description": "Bytes that are copied to the data sink.", |
963 "format": "int64", | 818 "format": "int64", |
964 "type": "string" | 819 "type": "string" |
965 } | 820 } |
966 }, | 821 }, |
967 "type": "object" | 822 "type": "object" |
968 }, | 823 }, |
969 "ErrorSummary": { | 824 "ErrorSummary": { |
970 "description": "A summary of errors by error code, plus a count and
sample error log entries.", | 825 "description": "A summary of errors by error code, plus a count and
sample error log\nentries.", |
971 "id": "ErrorSummary", | 826 "id": "ErrorSummary", |
972 "properties": { | 827 "properties": { |
973 "errorCode": { | 828 "errorCode": { |
974 "description": "Required.", | 829 "description": "Required.", |
975 "enum": [ | 830 "enum": [ |
976 "OK", | 831 "OK", |
977 "CANCELLED", | 832 "CANCELLED", |
978 "UNKNOWN", | 833 "UNKNOWN", |
979 "INVALID_ARGUMENT", | 834 "INVALID_ARGUMENT", |
980 "DEADLINE_EXCEEDED", | 835 "DEADLINE_EXCEEDED", |
981 "NOT_FOUND", | 836 "NOT_FOUND", |
982 "ALREADY_EXISTS", | 837 "ALREADY_EXISTS", |
983 "PERMISSION_DENIED", | 838 "PERMISSION_DENIED", |
984 "UNAUTHENTICATED", | 839 "UNAUTHENTICATED", |
985 "RESOURCE_EXHAUSTED", | 840 "RESOURCE_EXHAUSTED", |
986 "FAILED_PRECONDITION", | 841 "FAILED_PRECONDITION", |
987 "ABORTED", | 842 "ABORTED", |
988 "OUT_OF_RANGE", | 843 "OUT_OF_RANGE", |
989 "UNIMPLEMENTED", | 844 "UNIMPLEMENTED", |
990 "INTERNAL", | 845 "INTERNAL", |
991 "UNAVAILABLE", | 846 "UNAVAILABLE", |
992 "DATA_LOSS" | 847 "DATA_LOSS" |
993 ], | 848 ], |
| 849 "enumDescriptions": [ |
| 850 "Not an error; returned on success\n\nHTTP Mapping: 200
OK", |
| 851 "The operation was cancelled, typically by the caller.\n
\nHTTP Mapping: 499 Client Closed Request", |
| 852 "Unknown error. For example, this error may be returned
when\na `Status` value received from another address space belongs to\nan error
space that is not known in this address space. Also\nerrors raised by APIs tha
t do not return enough error information\nmay be converted to this error.\n\nHTT
P Mapping: 500 Internal Server Error", |
| 853 "The client specified an invalid argument. Note that th
is differs\nfrom `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates arguments\
nthat are problematic regardless of the state of the system\n(e.g., a malformed
file name).\n\nHTTP Mapping: 400 Bad Request", |
| 854 "The deadline expired before the operation could complet
e. For operations\nthat change the state of the system, this error may be return
ed\neven if the operation has completed successfully. For example, a\nsuccessfu
l response from a server could have been delayed long\nenough for the deadline t
o expire.\n\nHTTP Mapping: 504 Gateway Timeout", |
| 855 "Some requested entity (e.g., file or directory) was not
found.\n\nNote to server developers: if a request is denied for an entire class
\nof users, such as gradual feature rollout or undocumented whitelist,\n`NOT_FOU
ND` may be used. If a request is denied for some users within\na class of users,
such as user-based access control, `PERMISSION_DENIED`\nmust be used.\n\nHTTP M
apping: 404 Not Found", |
| 856 "The entity that a client attempted to create (e.g., fil
e or directory)\nalready exists.\n\nHTTP Mapping: 409 Conflict", |
| 857 "The caller does not have permission to execute the spec
ified\noperation. `PERMISSION_DENIED` must not be used for rejections\ncaused by
exhausting some resource (use `RESOURCE_EXHAUSTED`\ninstead for those errors).
`PERMISSION_DENIED` must not be\nused if the caller can not be identified (use `
UNAUTHENTICATED`\ninstead for those errors). This error code does not imply the\
nrequest is valid or the requested entity exists or satisfies\nother pre-conditi
ons.\n\nHTTP Mapping: 403 Forbidden", |
| 858 "The request does not have valid authentication credenti
als for the\noperation.\n\nHTTP Mapping: 401 Unauthorized", |
| 859 "Some resource has been exhausted, perhaps a per-user qu
ota, or\nperhaps the entire file system is out of space.\n\nHTTP Mapping: 429 To
o Many Requests", |
| 860 "The operation was rejected because the system is not in
a state\nrequired for the operation's execution. For example, the directory\nt
o be deleted is non-empty, an rmdir operation is applied to\na non-directory, et
c.\n\nService implementors can use the following guidelines to decide\nbetween `
FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`:\n (a) Use `UNAVAILABLE` if t
he client can retry just the failing call.\n (b) Use `ABORTED` if the client sho
uld retry at a higher level\n (e.g., when a client-specified test-and-set fa
ils, indicating the\n client should restart a read-modify-write sequence).\n
(c) Use `FAILED_PRECONDITION` if the client should not retry until\n the sy
stem state has been explicitly fixed. E.g., if an \"rmdir\"\n fails because
the directory is non-empty, `FAILED_PRECONDITION`\n should be returned sinc
e the client should not retry unless\n the files are deleted from the direct
ory.\n\nHTTP Mapping: 400 Bad Request", |
| 861 "The operation was aborted, typically due to a concurren
cy issue such as\na sequencer check failure or transaction abort.\n\nSee the gui
delines above for deciding between `FAILED_PRECONDITION`,\n`ABORTED`, and `UNAVA
ILABLE`.\n\nHTTP Mapping: 409 Conflict", |
| 862 "The operation was attempted past the valid range. E.g.
, seeking or\nreading past end-of-file.\n\nUnlike `INVALID_ARGUMENT`, this error
indicates a problem that may\nbe fixed if the system state changes. For example
, a 32-bit file\nsystem will generate `INVALID_ARGUMENT` if asked to read at an\
noffset that is not in the range [0,2^32-1], but it will generate\n`OUT_OF_RANGE
` if asked to read from an offset past the current\nfile size.\n\nThere is a fai
r bit of overlap between `FAILED_PRECONDITION` and\n`OUT_OF_RANGE`. We recommen
d using `OUT_OF_RANGE` (the more specific\nerror) when it applies so that caller
s who are iterating through\na space can easily look for an `OUT_OF_RANGE` error
to detect when\nthey are done.\n\nHTTP Mapping: 400 Bad Request", |
| 863 "The operation is not implemented or is not supported/en
abled in this\nservice.\n\nHTTP Mapping: 501 Not Implemented", |
| 864 "Internal errors. This means that some invariants expec
ted by the\nunderlying system have been broken. This error code is reserved\nfo
r serious errors.\n\nHTTP Mapping: 500 Internal Server Error", |
| 865 "The service is currently unavailable. This is most lik
ely a\ntransient condition, which can be corrected by retrying with\na backoff.\
n\nSee the guidelines above for deciding between `FAILED_PRECONDITION`,\n`ABORTE
D`, and `UNAVAILABLE`.\n\nHTTP Mapping: 503 Service Unavailable", |
| 866 "Unrecoverable data loss or corruption.\n\nHTTP Mapping:
500 Internal Server Error" |
| 867 ], |
994 "type": "string" | 868 "type": "string" |
995 }, | 869 }, |
996 "errorCount": { | 870 "errorCount": { |
997 "description": "Count of this type of error. Required.", | 871 "description": "Count of this type of error.\nRequired.", |
998 "format": "int64", | 872 "format": "int64", |
999 "type": "string" | 873 "type": "string" |
1000 }, | 874 }, |
1001 "errorLogEntries": { | 875 "errorLogEntries": { |
1002 "description": "Error samples.", | 876 "description": "Error samples.", |
1003 "items": { | 877 "items": { |
1004 "$ref": "ErrorLogEntry" | 878 "$ref": "ErrorLogEntry" |
1005 }, | 879 }, |
1006 "type": "array" | 880 "type": "array" |
1007 } | 881 } |
1008 }, | 882 }, |
1009 "type": "object" | 883 "type": "object" |
1010 }, | 884 }, |
1011 "ErrorLogEntry": { | 885 "HttpData": { |
1012 "description": "An entry describing an error that has occurred.", | 886 "description": "An HttpData specifies a list of objects on the web t
o be transferred over\nHTTP. The information of the objects to be transferred i
s contained in a\nfile referenced by a URL. The first line in the file must be\n
\"TsvHttpData-1.0\", which specifies the format of the file. Subsequent lines\n
specify the information of the list of objects, one object per list entry.\nEach
entry has the following tab-delimited fields:\n\n* HTTP URL - The location of t
he object.\n\n* Length - The size of the object in bytes.\n\n* MD5 - The base64-
encoded MD5 hash of the object.\n\nFor an example of a valid TSV file, see\n[Tra
nsferring data from URLs](https://cloud.google.com/storage/transfer/#urls)\n\nWh
en transferring data based on a URL list, keep the following in mind:\n\n* When
an object located at `http(s)://hostname:port/<URL-path>` is transferred\nto a d
ata sink, the name of the object at the data sink is\n`<hostname>/<URL-path>`.\n
\n* If the specified size of an object does not match the actual size of the\nob
ject fetched, the object will not be transferred.\n\n* If the specified MD5 does
not match the MD5 computed from the transferred\nbytes, the object transfer wil
l fail. For more information, see\n[Generating MD5 hashes](https://cloud.google.
com/storage/transfer/#md5)\n\n* Ensure that each URL you specify is publicly acc
essible. For\nexample, in Google Cloud Storage you can\n[share an object publicl
y]\n(https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get\n
a link to it.\n\n* Storage Transfer Service obeys `robots.txt` rules and require
s the source\nHTTP server to support `Range` requests and to return a `Content-L
ength`\nheader in each response.\n\n* [ObjectConditions](#ObjectConditions) have
no effect when filtering objects\nto transfer.", |
1013 "id": "ErrorLogEntry", | 887 "id": "HttpData", |
1014 "properties": { | 888 "properties": { |
1015 "url": { | 889 "listUrl": { |
1016 "description": "A URL that refers to the target (a data sour
ce, a data sink, or an object) with which the error is associated. Required.", | 890 "description": "The URL that points to the file that stores
the object list entries.\nThis file must allow public access. Currently, only U
RLs with HTTP and\nHTTPS schemes are supported.\nRequired.", |
| 891 "type": "string" |
| 892 } |
| 893 }, |
| 894 "type": "object" |
| 895 }, |
| 896 "GcsData": { |
| 897 "description": "In a GcsData, an object's name is the Google Cloud S
torage object's name and\nits `lastModificationTime` refers to the object's upda
ted time, which changes\nwhen the content or the metadata of the object is updat
ed.", |
| 898 "id": "GcsData", |
| 899 "properties": { |
| 900 "bucketName": { |
| 901 "description": "Google Cloud Storage bucket name (see\n[Buck
et Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requir
ements)).\nRequired.", |
| 902 "type": "string" |
| 903 } |
| 904 }, |
| 905 "type": "object" |
| 906 }, |
| 907 "ListTransferJobsResponse": { |
| 908 "description": "Response from ListTransferJobs.", |
| 909 "id": "ListTransferJobsResponse", |
| 910 "properties": { |
| 911 "nextPageToken": { |
| 912 "description": "The list next page token.", |
1017 "type": "string" | 913 "type": "string" |
1018 }, | 914 }, |
1019 "errorDetails": { | 915 "transferJobs": { |
1020 "description": "A list of messages that carry the error deta
ils.", | 916 "description": "A list of transfer jobs.", |
| 917 "items": { |
| 918 "$ref": "TransferJob" |
| 919 }, |
| 920 "type": "array" |
| 921 } |
| 922 }, |
| 923 "type": "object" |
| 924 }, |
| 925 "UpdateTransferJobRequest": { |
| 926 "description": "Request passed to UpdateTransferJob.", |
| 927 "id": "UpdateTransferJobRequest", |
| 928 "properties": { |
| 929 "updateTransferJobFieldMask": { |
| 930 "description": "The field mask of the fields in `transferJob
` that are to be updated in\nthis request. Fields in `transferJob` that can be
updated are:\n`description`, `transferSpec`, and `status`. To update the `trans
ferSpec`\nof the job, a complete transfer specification has to be provided. An\n
incomplete specification which misses any required fields will be rejected\nwith
the error `INVALID_ARGUMENT`.", |
| 931 "format": "google-fieldmask", |
| 932 "type": "string" |
| 933 }, |
| 934 "transferJob": { |
| 935 "$ref": "TransferJob", |
| 936 "description": "The job to update.\nRequired." |
| 937 }, |
| 938 "projectId": { |
| 939 "description": "The ID of the Google Cloud Platform Console
project that owns the job.\nRequired.", |
| 940 "type": "string" |
| 941 } |
| 942 }, |
| 943 "type": "object" |
| 944 }, |
| 945 "ObjectConditions": { |
| 946 "description": "Conditions that determine which objects will be tran
sferred.", |
| 947 "id": "ObjectConditions", |
| 948 "properties": { |
| 949 "minTimeElapsedSinceLastModification": { |
| 950 "description": "If unspecified, `minTimeElapsedSinceLastModi
fication` takes a zero value\nand `maxTimeElapsedSinceLastModification` takes th
e maximum possible\nvalue of Duration. Objects that satisfy the object condition
s\nmust either have a `lastModificationTime` greater or equal to\n`NOW` - `maxTi
meElapsedSinceLastModification` and less than\n`NOW` - `minTimeElapsedSinceLastM
odification`, or not have a\n`lastModificationTime`.", |
| 951 "format": "google-duration", |
| 952 "type": "string" |
| 953 }, |
| 954 "excludePrefixes": { |
| 955 "description": "`excludePrefixes` must follow the requiremen
ts described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 100
0.", |
1021 "items": { | 956 "items": { |
1022 "type": "string" | 957 "type": "string" |
1023 }, | 958 }, |
| 959 "type": "array" |
| 960 }, |
| 961 "maxTimeElapsedSinceLastModification": { |
| 962 "description": "`maxTimeElapsedSinceLastModification` is the
complement to\n`minTimeElapsedSinceLastModification`.", |
| 963 "format": "google-duration", |
| 964 "type": "string" |
| 965 }, |
| 966 "includePrefixes": { |
| 967 "description": "If `includePrefixes` is specified, objects t
hat satisfy the object\nconditions must have names that start with one of the `i
ncludePrefixes`\nand that do not start with any of the `excludePrefixes`. If `in
cludePrefixes`\nis not specified, all objects except those that have names start
ing with\none of the `excludePrefixes` must satisfy the object conditions.\n\nRe
quirements:\n\n * Each include-prefix and exclude-prefix can contain any sequen
ce of\n Unicode characters, of max length 1024 bytes when UTF8-encoded, and\n
must not contain Carriage Return or Line Feed characters. Wildcard\n mat
ching and regular expression matching are not supported.\n\n * Each include-pre
fix and exclude-prefix must omit the leading slash.\n For example, to include
the `requests.gz` object in a transfer from\n `s3://my-aws-bucket/logs/y=201
5/requests.gz`, specify the include\n prefix as `logs/y=2015/requests.gz`.\n\
n * None of the include-prefix or the exclude-prefix values can be empty,\n
if specified.\n\n * Each include-prefix must include a distinct portion of the
object\n namespace, i.e., no include-prefix may be a prefix of another\n i
nclude-prefix.\n\n * Each exclude-prefix must exclude a distinct portion of the
object\n namespace, i.e., no exclude-prefix may be a prefix of another\n
exclude-prefix.\n\n * If `includePrefixes` is specified, then each exclude-pref
ix must start\n with the value of a path explicitly included by `includePrefi
xes`.\n\nThe max size of `includePrefixes` is 1000.", |
| 968 "items": { |
| 969 "type": "string" |
| 970 }, |
1024 "type": "array" | 971 "type": "array" |
1025 } | 972 } |
1026 }, | 973 }, |
1027 "type": "object" | 974 "type": "object" |
| 975 }, |
| 976 "Operation": { |
| 977 "description": "This resource represents a long-running operation th
at is the result of a\nnetwork API call.", |
| 978 "id": "Operation", |
| 979 "properties": { |
| 980 "metadata": { |
| 981 "additionalProperties": { |
| 982 "description": "Properties of the object. Contains field
@type with type URL.", |
| 983 "type": "any" |
| 984 }, |
| 985 "description": "Represents the transfer operation object.", |
| 986 "type": "object" |
| 987 }, |
| 988 "done": { |
| 989 "description": "If the value is `false`, it means the operat
ion is still in progress.\nIf true, the operation is completed, and either `erro
r` or `response` is\navailable.", |
| 990 "type": "boolean" |
| 991 }, |
| 992 "response": { |
| 993 "additionalProperties": { |
| 994 "description": "Properties of the object. Contains field
@type with type URL.", |
| 995 "type": "any" |
| 996 }, |
| 997 "description": "The normal response of the operation in case
of success. If the original\nmethod returns no data on success, such as `Delet
e`, the response is\n`google.protobuf.Empty`. If the original method is standar
d\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmet
hods, the response should have the type `XxxResponse`, where `Xxx`\nis the origi
nal method name. For example, if the original method name\nis `TakeSnapshot()`,
the inferred response type is\n`TakeSnapshotResponse`.", |
| 998 "type": "object" |
| 999 }, |
| 1000 "name": { |
| 1001 "description": "The server-assigned name, which is only uniq
ue within the same service that originally returns it. If you use the default HT
TP mapping, the `name` should have the format of `transferOperations/some/unique
/name`.", |
| 1002 "type": "string" |
| 1003 }, |
| 1004 "error": { |
| 1005 "$ref": "Status", |
| 1006 "description": "The error result of the operation in case of
failure or cancellation." |
| 1007 } |
| 1008 }, |
| 1009 "type": "object" |
| 1010 }, |
| 1011 "TransferSpec": { |
| 1012 "description": "Configuration for running a transfer.", |
| 1013 "id": "TransferSpec", |
| 1014 "properties": { |
| 1015 "gcsDataSource": { |
| 1016 "$ref": "GcsData", |
| 1017 "description": "A Google Cloud Storage data source." |
| 1018 }, |
| 1019 "transferOptions": { |
| 1020 "$ref": "TransferOptions", |
| 1021 "description": "If the option `deleteObjectsUniqueInSink` is
`true`, object conditions\nbased on objects' `lastModificationTime` are ignored
and do not exclude\nobjects in a data source or a data sink." |
| 1022 }, |
| 1023 "awsS3DataSource": { |
| 1024 "$ref": "AwsS3Data", |
| 1025 "description": "An AWS S3 data source." |
| 1026 }, |
| 1027 "httpDataSource": { |
| 1028 "$ref": "HttpData", |
| 1029 "description": "An HTTP URL data source." |
| 1030 }, |
| 1031 "objectConditions": { |
| 1032 "$ref": "ObjectConditions", |
| 1033 "description": "Only objects that satisfy these object condi
tions are included in the set\nof data source and data sink objects. Object con
ditions based on\nobjects' `lastModificationTime` do not exclude objects in a da
ta sink." |
| 1034 }, |
| 1035 "gcsDataSink": { |
| 1036 "$ref": "GcsData", |
| 1037 "description": "A Google Cloud Storage data sink." |
| 1038 } |
| 1039 }, |
| 1040 "type": "object" |
| 1041 }, |
| 1042 "TransferOptions": { |
| 1043 "description": "TransferOptions uses three boolean parameters to def
ine the actions\nto be performed on objects in a transfer.", |
| 1044 "id": "TransferOptions", |
| 1045 "properties": { |
| 1046 "overwriteObjectsAlreadyExistingInSink": { |
| 1047 "description": "Whether overwriting objects that already exi
st in the sink is allowed.", |
| 1048 "type": "boolean" |
| 1049 }, |
| 1050 "deleteObjectsFromSourceAfterTransfer": { |
| 1051 "description": "Whether objects should be deleted from the s
ource after they are\ntransferred to the sink.", |
| 1052 "type": "boolean" |
| 1053 }, |
| 1054 "deleteObjectsUniqueInSink": { |
| 1055 "description": "Whether objects that exist only in the sink
should be deleted.", |
| 1056 "type": "boolean" |
| 1057 } |
| 1058 }, |
| 1059 "type": "object" |
1028 } | 1060 } |
1029 }, | 1061 }, |
1030 "servicePath": "", | 1062 "servicePath": "", |
1031 "title": "Google Storage Transfer API", | 1063 "title": "Google Storage Transfer API", |
1032 "version": "v1" | 1064 "version": "v1" |
1033 } | 1065 } |
OLD | NEW |