Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(217)

Side by Side Diff: discovery/googleapis/storagetransfer__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)
Patch Set: Created 3 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « discovery/googleapis/speech__v1.json ('k') | discovery/googleapis/streetviewpublish__v1.json » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 "icons": { 17 "icons": {
18 "x16": "http://www.google.com/images/icons/product/search-16.gif", 18 "x16": "http://www.google.com/images/icons/product/search-16.gif",
19 "x32": "http://www.google.com/images/icons/product/search-32.gif" 19 "x32": "http://www.google.com/images/icons/product/search-32.gif"
20 }, 20 },
21 "id": "storagetransfer:v1", 21 "id": "storagetransfer:v1",
22 "kind": "discovery#restDescription", 22 "kind": "discovery#restDescription",
23 "name": "storagetransfer", 23 "name": "storagetransfer",
24 "ownerDomain": "google.com", 24 "ownerDomain": "google.com",
25 "ownerName": "Google", 25 "ownerName": "Google",
26 "parameters": { 26 "parameters": {
27 "$.xgafv": {
28 "description": "V1 error format.",
29 "enum": [
30 "1",
31 "2"
32 ],
33 "enumDescriptions": [
34 "v1 error format",
35 "v2 error format"
36 ],
37 "location": "query",
38 "type": "string"
39 },
40 "callback": {
41 "description": "JSONP",
42 "location": "query",
43 "type": "string"
44 },
45 "alt": {
46 "default": "json",
47 "description": "Data format for response.",
48 "enum": [
49 "json",
50 "media",
51 "proto"
52 ],
53 "enumDescriptions": [
54 "Responses with Content-Type of application/json",
55 "Media download with context-dependent Content-Type",
56 "Responses with Content-Type of application/x-protobuf"
57 ],
58 "location": "query",
59 "type": "string"
60 },
61 "access_token": { 27 "access_token": {
62 "description": "OAuth access token.", 28 "description": "OAuth access token.",
63 "location": "query", 29 "location": "query",
64 "type": "string" 30 "type": "string"
65 }, 31 },
66 "key": { 32 "key": {
67 "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.", 33 "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.",
68 "location": "query", 34 "location": "query",
69 "type": "string" 35 "type": "string"
70 }, 36 },
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after
102 }, 68 },
103 "uploadType": { 69 "uploadType": {
104 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").", 70 "description": "Legacy upload protocol for media (e.g. \"media\", \" multipart\").",
105 "location": "query", 71 "location": "query",
106 "type": "string" 72 "type": "string"
107 }, 73 },
108 "fields": { 74 "fields": {
109 "description": "Selector specifying which fields to include in a par tial response.", 75 "description": "Selector specifying which fields to include in a par tial response.",
110 "location": "query", 76 "location": "query",
111 "type": "string" 77 "type": "string"
78 },
79 "$.xgafv": {
80 "description": "V1 error format.",
81 "enum": [
82 "1",
83 "2"
84 ],
85 "enumDescriptions": [
86 "v1 error format",
87 "v2 error format"
88 ],
89 "location": "query",
90 "type": "string"
91 },
92 "callback": {
93 "description": "JSONP",
94 "location": "query",
95 "type": "string"
96 },
97 "alt": {
98 "default": "json",
99 "description": "Data format for response.",
100 "enum": [
101 "json",
102 "media",
103 "proto"
104 ],
105 "enumDescriptions": [
106 "Responses with Content-Type of application/json",
107 "Media download with context-dependent Content-Type",
108 "Responses with Content-Type of application/x-protobuf"
109 ],
110 "location": "query",
111 "type": "string"
112 } 112 }
113 }, 113 },
114 "protocol": "rest", 114 "protocol": "rest",
115 "resources": { 115 "resources": {
116 "transferOperations": { 116 "googleServiceAccounts": {
117 "methods": { 117 "methods": {
118 "get": { 118 "get": {
119 "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.", 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.",
120 "httpMethod": "GET", 120 "httpMethod": "GET",
121 "id": "storagetransfer.transferOperations.get", 121 "id": "storagetransfer.googleServiceAccounts.get",
122 "parameterOrder": [ 122 "parameterOrder": [
123 "name" 123 "projectId"
124 ], 124 ],
125 "parameters": { 125 "parameters": {
126 "name": { 126 "projectId": {
127 "description": "The name of the operation resource." , 127 "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired." ,
128 "location": "path", 128 "location": "path",
129 "pattern": "^transferOperations/.+$",
130 "required": true, 129 "required": true,
131 "type": "string" 130 "type": "string"
132 } 131 }
133 }, 132 },
134 "path": "v1/{+name}", 133 "path": "v1/googleServiceAccounts/{projectId}",
135 "response": { 134 "response": {
136 "$ref": "Operation" 135 "$ref": "GoogleServiceAccount"
137 }, 136 },
138 "scopes": [ 137 "scopes": [
139 "https://www.googleapis.com/auth/cloud-platform" 138 "https://www.googleapis.com/auth/cloud-platform"
140 ] 139 ]
141 }, 140 }
142 "pause": { 141 }
143 "description": "Pauses a transfer operation.", 142 },
144 "httpMethod": "POST", 143 "transferOperations": {
145 "id": "storagetransfer.transferOperations.pause", 144 "methods": {
146 "parameterOrder": [
147 "name"
148 ],
149 "parameters": {
150 "name": {
151 "description": "The name of the transfer operation.\ nRequired.",
152 "location": "path",
153 "pattern": "^transferOperations/.+$",
154 "required": true,
155 "type": "string"
156 }
157 },
158 "path": "v1/{+name}:pause",
159 "request": {
160 "$ref": "PauseTransferOperationRequest"
161 },
162 "response": {
163 "$ref": "Empty"
164 },
165 "scopes": [
166 "https://www.googleapis.com/auth/cloud-platform"
167 ]
168 },
169 "delete": { 145 "delete": {
170 "description": "This method is not supported and the server returns `UNIMPLEMENTED`.", 146 "description": "This method is not supported and the server returns `UNIMPLEMENTED`.",
171 "httpMethod": "DELETE", 147 "httpMethod": "DELETE",
172 "id": "storagetransfer.transferOperations.delete", 148 "id": "storagetransfer.transferOperations.delete",
173 "parameterOrder": [ 149 "parameterOrder": [
174 "name" 150 "name"
175 ], 151 ],
176 "parameters": { 152 "parameters": {
177 "name": { 153 "name": {
178 "description": "The name of the operation resource t o be deleted.", 154 "description": "The name of the operation resource t o be deleted.",
(...skipping 94 matching lines...) Expand 10 before | Expand all | Expand 10 after
273 "type": "string" 249 "type": "string"
274 } 250 }
275 }, 251 },
276 "path": "v1/{+name}:cancel", 252 "path": "v1/{+name}:cancel",
277 "response": { 253 "response": {
278 "$ref": "Empty" 254 "$ref": "Empty"
279 }, 255 },
280 "scopes": [ 256 "scopes": [
281 "https://www.googleapis.com/auth/cloud-platform" 257 "https://www.googleapis.com/auth/cloud-platform"
282 ] 258 ]
259 },
260 "get": {
261 "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.",
262 "httpMethod": "GET",
263 "id": "storagetransfer.transferOperations.get",
264 "parameterOrder": [
265 "name"
266 ],
267 "parameters": {
268 "name": {
269 "description": "The name of the operation resource." ,
270 "location": "path",
271 "pattern": "^transferOperations/.+$",
272 "required": true,
273 "type": "string"
274 }
275 },
276 "path": "v1/{+name}",
277 "response": {
278 "$ref": "Operation"
279 },
280 "scopes": [
281 "https://www.googleapis.com/auth/cloud-platform"
282 ]
283 },
284 "pause": {
285 "description": "Pauses a transfer operation.",
286 "httpMethod": "POST",
287 "id": "storagetransfer.transferOperations.pause",
288 "parameterOrder": [
289 "name"
290 ],
291 "parameters": {
292 "name": {
293 "description": "The name of the transfer operation.\ nRequired.",
294 "location": "path",
295 "pattern": "^transferOperations/.+$",
296 "required": true,
297 "type": "string"
298 }
299 },
300 "path": "v1/{+name}:pause",
301 "request": {
302 "$ref": "PauseTransferOperationRequest"
303 },
304 "response": {
305 "$ref": "Empty"
306 },
307 "scopes": [
308 "https://www.googleapis.com/auth/cloud-platform"
309 ]
283 } 310 }
284 } 311 }
285 }, 312 },
286 "transferJobs": { 313 "transferJobs": {
287 "methods": { 314 "methods": {
315 "create": {
316 "description": "Creates a transfer job that runs periodicall y.",
317 "httpMethod": "POST",
318 "id": "storagetransfer.transferJobs.create",
319 "parameterOrder": [],
320 "parameters": {},
321 "path": "v1/transferJobs",
322 "request": {
323 "$ref": "TransferJob"
324 },
325 "response": {
326 "$ref": "TransferJob"
327 },
328 "scopes": [
329 "https://www.googleapis.com/auth/cloud-platform"
330 ]
331 },
288 "list": { 332 "list": {
289 "description": "Lists transfer jobs.", 333 "description": "Lists transfer jobs.",
290 "httpMethod": "GET", 334 "httpMethod": "GET",
291 "id": "storagetransfer.transferJobs.list", 335 "id": "storagetransfer.transferJobs.list",
292 "parameterOrder": [], 336 "parameterOrder": [],
293 "parameters": { 337 "parameters": {
338 "pageToken": {
339 "description": "The list page token.",
340 "location": "query",
341 "type": "string"
342 },
294 "pageSize": { 343 "pageSize": {
295 "description": "The list page size. The max allowed value is 256.", 344 "description": "The list page size. The max allowed value is 256.",
296 "format": "int32", 345 "format": "int32",
297 "location": "query", 346 "location": "query",
298 "type": "integer" 347 "type": "integer"
299 }, 348 },
300 "filter": { 349 "filter": {
301 "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`.", 350 "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`.",
302 "location": "query", 351 "location": "query",
303 "type": "string" 352 "type": "string"
304 },
305 "pageToken": {
306 "description": "The list page token.",
307 "location": "query",
308 "type": "string"
309 } 353 }
310 }, 354 },
311 "path": "v1/transferJobs", 355 "path": "v1/transferJobs",
312 "response": { 356 "response": {
313 "$ref": "ListTransferJobsResponse" 357 "$ref": "ListTransferJobsResponse"
314 }, 358 },
315 "scopes": [ 359 "scopes": [
316 "https://www.googleapis.com/auth/cloud-platform" 360 "https://www.googleapis.com/auth/cloud-platform"
317 ] 361 ]
318 }, 362 },
(...skipping 45 matching lines...) Expand 10 before | Expand all | Expand 10 after
364 "path": "v1/{+jobName}", 408 "path": "v1/{+jobName}",
365 "request": { 409 "request": {
366 "$ref": "UpdateTransferJobRequest" 410 "$ref": "UpdateTransferJobRequest"
367 }, 411 },
368 "response": { 412 "response": {
369 "$ref": "TransferJob" 413 "$ref": "TransferJob"
370 }, 414 },
371 "scopes": [ 415 "scopes": [
372 "https://www.googleapis.com/auth/cloud-platform" 416 "https://www.googleapis.com/auth/cloud-platform"
373 ] 417 ]
374 },
375 "create": {
376 "description": "Creates a transfer job that runs periodicall y.",
377 "httpMethod": "POST",
378 "id": "storagetransfer.transferJobs.create",
379 "parameterOrder": [],
380 "parameters": {},
381 "path": "v1/transferJobs",
382 "request": {
383 "$ref": "TransferJob"
384 },
385 "response": {
386 "$ref": "TransferJob"
387 },
388 "scopes": [
389 "https://www.googleapis.com/auth/cloud-platform"
390 ]
391 }
392 }
393 },
394 "googleServiceAccounts": {
395 "methods": {
396 "get": {
397 "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.",
398 "httpMethod": "GET",
399 "id": "storagetransfer.googleServiceAccounts.get",
400 "parameterOrder": [
401 "projectId"
402 ],
403 "parameters": {
404 "projectId": {
405 "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired." ,
406 "location": "path",
407 "required": true,
408 "type": "string"
409 }
410 },
411 "path": "v1/googleServiceAccounts/{projectId}",
412 "response": {
413 "$ref": "GoogleServiceAccount"
414 },
415 "scopes": [
416 "https://www.googleapis.com/auth/cloud-platform"
417 ]
418 } 418 }
419 } 419 }
420 } 420 }
421 }, 421 },
422 "revision": "20170705", 422 "revision": "20170720",
423 "rootUrl": "https://storagetransfer.googleapis.com/", 423 "rootUrl": "https://storagetransfer.googleapis.com/",
424 "schemas": { 424 "schemas": {
425 "ErrorLogEntry": {
426 "description": "An entry describing an error that has occurred.",
427 "id": "ErrorLogEntry",
428 "properties": {
429 "errorDetails": {
430 "description": "A list of messages that carry the error deta ils.",
431 "items": {
432 "type": "string"
433 },
434 "type": "array"
435 },
436 "url": {
437 "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.",
438 "type": "string"
439 }
440 },
441 "type": "object"
442 },
443 "TransferJob": {
444 "description": "This resource represents the configuration of a tran sfer job that runs\nperiodically.",
445 "id": "TransferJob",
446 "properties": {
447 "description": {
448 "description": "A description provided by the user for the j ob. Its max length is 1024\nbytes when Unicode-encoded.",
449 "type": "string"
450 },
451 "creationTime": {
452 "description": "This field cannot be changed by user request s.",
453 "format": "google-datetime",
454 "type": "string"
455 },
456 "transferSpec": {
457 "$ref": "TransferSpec",
458 "description": "Transfer specification.\nRequired."
459 },
460 "status": {
461 "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.",
462 "enum": [
463 "STATUS_UNSPECIFIED",
464 "ENABLED",
465 "DISABLED",
466 "DELETED"
467 ],
468 "enumDescriptions": [
469 "Zero is an illegal value.",
470 "New transfers will be performed based on the schedule." ,
471 "New transfers will not be scheduled.",
472 "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."
473 ],
474 "type": "string"
475 },
476 "schedule": {
477 "$ref": "Schedule",
478 "description": "Schedule specification.\nRequired."
479 },
480 "deletionTime": {
481 "description": "This field cannot be changed by user request s.",
482 "format": "google-datetime",
483 "type": "string"
484 },
485 "name": {
486 "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.",
487 "type": "string"
488 },
489 "projectId": {
490 "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
491 "type": "string"
492 },
493 "lastModificationTime": {
494 "description": "This field cannot be changed by user request s.",
495 "format": "google-datetime",
496 "type": "string"
497 }
498 },
499 "type": "object"
500 },
501 "Schedule": {
502 "description": "Transfers can be scheduled to recur or to run just o nce.",
503 "id": "Schedule",
504 "properties": {
505 "startTimeOfDay": {
506 "$ref": "TimeOfDay",
507 "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."
508 },
509 "scheduleStartDate": {
510 "$ref": "Date",
511 "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."
512 },
513 "scheduleEndDate": {
514 "$ref": "Date",
515 "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
516 }
517 },
518 "type": "object"
519 },
520 "Date": {
521 "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`.",
522 "id": "Date",
523 "properties": {
524 "day": {
525 "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.",
526 "format": "int32",
527 "type": "integer"
528 },
529 "year": {
530 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
531 "format": "int32",
532 "type": "integer"
533 },
534 "month": {
535 "description": "Month of year. Must be from 1 to 12.",
536 "format": "int32",
537 "type": "integer"
538 }
539 },
540 "type": "object"
541 },
542 "TransferOperation": {
543 "description": "A description of the execution of a transfer.",
544 "id": "TransferOperation",
545 "properties": {
546 "status": {
547 "description": "Status of the transfer operation.",
548 "enum": [
549 "STATUS_UNSPECIFIED",
550 "IN_PROGRESS",
551 "PAUSED",
552 "SUCCESS",
553 "FAILED",
554 "ABORTED"
555 ],
556 "enumDescriptions": [
557 "Zero is an illegal value.",
558 "In progress.",
559 "Paused.",
560 "Completed successfully.",
561 "Terminated due to an unrecoverable failure.",
562 "Aborted by the user."
563 ],
564 "type": "string"
565 },
566 "counters": {
567 "$ref": "TransferCounters",
568 "description": "Information about the progress of the transf er operation."
569 },
570 "errorBreakdowns": {
571 "description": "Summarizes errors encountered with sample er ror log entries.",
572 "items": {
573 "$ref": "ErrorSummary"
574 },
575 "type": "array"
576 },
577 "name": {
578 "description": "A globally unique ID assigned by the system. ",
579 "type": "string"
580 },
581 "projectId": {
582 "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
583 "type": "string"
584 },
585 "endTime": {
586 "description": "End time of this transfer execution.",
587 "format": "google-datetime",
588 "type": "string"
589 },
590 "startTime": {
591 "description": "Start time of this transfer execution.",
592 "format": "google-datetime",
593 "type": "string"
594 },
595 "transferJobName": {
596 "description": "The name of the transfer job that triggers t his transfer operation.",
597 "type": "string"
598 },
599 "transferSpec": {
600 "$ref": "TransferSpec",
601 "description": "Transfer specification.\nRequired."
602 }
603 },
604 "type": "object"
605 },
606 "AwsS3Data": {
607 "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.",
608 "id": "AwsS3Data",
609 "properties": {
610 "bucketName": {
611 "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.",
612 "type": "string"
613 },
614 "awsAccessKey": {
615 "$ref": "AwsAccessKey",
616 "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."
617 }
618 },
619 "type": "object"
620 },
621 "AwsAccessKey": {
622 "description": "AWS access key (see\n[AWS Security Credentials](http ://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
623 "id": "AwsAccessKey",
624 "properties": {
625 "accessKeyId": {
626 "description": "AWS access key ID.\nRequired.",
627 "type": "string"
628 },
629 "secretAccessKey": {
630 "description": "AWS secret access key. This field is not ret urned in RPC responses.\nRequired.",
631 "type": "string"
632 }
633 },
634 "type": "object"
635 },
636 "Empty": {
637 "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 `{}`.",
638 "id": "Empty",
639 "properties": {},
640 "type": "object"
641 },
642 "PauseTransferOperationRequest": {
643 "description": "Request passed to PauseTransferOperation.",
644 "id": "PauseTransferOperationRequest",
645 "properties": {},
646 "type": "object"
647 },
648 "TransferCounters": { 425 "TransferCounters": {
649 "description": "A collection of counters that report the progress of a transfer operation.", 426 "description": "A collection of counters that report the progress of a transfer operation.",
650 "id": "TransferCounters", 427 "id": "TransferCounters",
651 "properties": { 428 "properties": {
429 "objectsFoundFromSource": {
430 "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.",
431 "format": "int64",
432 "type": "string"
433 },
434 "bytesDeletedFromSource": {
435 "description": "Bytes that are deleted from the data source. ",
436 "format": "int64",
437 "type": "string"
438 },
439 "objectsFailedToDeleteFromSink": {
440 "description": "Objects that failed to be deleted from the d ata sink.",
441 "format": "int64",
442 "type": "string"
443 },
444 "objectsFoundOnlyFromSink": {
445 "description": "Objects found only in the data sink that are scheduled to be deleted.",
446 "format": "int64",
447 "type": "string"
448 },
449 "objectsDeletedFromSink": {
450 "description": "Objects that are deleted from the data sink. ",
451 "format": "int64",
452 "type": "string"
453 },
454 "bytesFromSourceSkippedBySync": {
455 "description": "Bytes in the data source that are not transf erred because they already\nexist in the data sink.",
456 "format": "int64",
457 "type": "string"
458 },
652 "bytesFailedToDeleteFromSink": { 459 "bytesFailedToDeleteFromSink": {
653 "description": "Bytes that failed to be deleted from the dat a sink.", 460 "description": "Bytes that failed to be deleted from the dat a sink.",
654 "format": "int64", 461 "format": "int64",
655 "type": "string" 462 "type": "string"
656 }, 463 },
657 "bytesDeletedFromSink": { 464 "bytesDeletedFromSink": {
658 "description": "Bytes that are deleted from the data sink.", 465 "description": "Bytes that are deleted from the data sink.",
659 "format": "int64", 466 "format": "int64",
660 "type": "string" 467 "type": "string"
661 }, 468 },
662 "bytesFromSourceFailed": { 469 "bytesFromSourceFailed": {
663 "description": "Bytes in the data source that failed during the transfer.", 470 "description": "Bytes in the data source that failed during the transfer.",
664 "format": "int64", 471 "format": "int64",
665 "type": "string" 472 "type": "string"
666 }, 473 },
474 "objectsFromSourceFailed": {
475 "description": "Objects in the data source that failed durin g the transfer.",
476 "format": "int64",
477 "type": "string"
478 },
667 "objectsCopiedToSink": { 479 "objectsCopiedToSink": {
668 "description": "Objects that are copied to the data sink.", 480 "description": "Objects that are copied to the data sink.",
669 "format": "int64", 481 "format": "int64",
670 "type": "string" 482 "type": "string"
671 }, 483 },
672 "objectsFromSourceFailed": {
673 "description": "Objects in the data source that failed durin g the transfer.",
674 "format": "int64",
675 "type": "string"
676 },
677 "bytesFoundOnlyFromSink": { 484 "bytesFoundOnlyFromSink": {
678 "description": "Bytes found only in the data sink that are s cheduled to be deleted.", 485 "description": "Bytes found only in the data sink that are s cheduled to be deleted.",
679 "format": "int64", 486 "format": "int64",
680 "type": "string" 487 "type": "string"
681 }, 488 },
682 "objectsDeletedFromSource": { 489 "objectsDeletedFromSource": {
683 "description": "Objects that are deleted from the data sourc e.", 490 "description": "Objects that are deleted from the data sourc e.",
684 "format": "int64", 491 "format": "int64",
685 "type": "string" 492 "type": "string"
686 }, 493 },
687 "bytesCopiedToSink": { 494 "bytesCopiedToSink": {
688 "description": "Bytes that are copied to the data sink.", 495 "description": "Bytes that are copied to the data sink.",
689 "format": "int64", 496 "format": "int64",
690 "type": "string" 497 "type": "string"
691 }, 498 },
692 "objectsFromSourceSkippedBySync": { 499 "objectsFromSourceSkippedBySync": {
693 "description": "Objects in the data source that are not tran sferred because they already\nexist in the data sink.", 500 "description": "Objects in the data source that are not tran sferred because they already\nexist in the data sink.",
694 "format": "int64", 501 "format": "int64",
695 "type": "string" 502 "type": "string"
696 }, 503 },
697 "bytesFoundFromSource": { 504 "bytesFoundFromSource": {
698 "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.", 505 "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.",
699 "format": "int64", 506 "format": "int64",
700 "type": "string" 507 "type": "string"
701 },
702 "objectsFoundFromSource": {
703 "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.",
704 "format": "int64",
705 "type": "string"
706 },
707 "bytesDeletedFromSource": {
708 "description": "Bytes that are deleted from the data source. ",
709 "format": "int64",
710 "type": "string"
711 },
712 "objectsFailedToDeleteFromSink": {
713 "description": "Objects that failed to be deleted from the d ata sink.",
714 "format": "int64",
715 "type": "string"
716 },
717 "objectsDeletedFromSink": {
718 "description": "Objects that are deleted from the data sink. ",
719 "format": "int64",
720 "type": "string"
721 },
722 "objectsFoundOnlyFromSink": {
723 "description": "Objects found only in the data sink that are scheduled to be deleted.",
724 "format": "int64",
725 "type": "string"
726 },
727 "bytesFromSourceSkippedBySync": {
728 "description": "Bytes in the data source that are not transf erred because they already\nexist in the data sink.",
729 "format": "int64",
730 "type": "string"
731 } 508 }
732 }, 509 },
733 "type": "object" 510 "type": "object"
734 }, 511 },
735 "ErrorSummary": { 512 "ErrorSummary": {
736 "description": "A summary of errors by error code, plus a count and sample error log\nentries.", 513 "description": "A summary of errors by error code, plus a count and sample error log\nentries.",
737 "id": "ErrorSummary", 514 "id": "ErrorSummary",
738 "properties": { 515 "properties": {
739 "errorCode": { 516 "errorCode": {
740 "description": "Required.", 517 "description": "Required.",
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after
812 "description": "Google Cloud Storage bucket name (see\n[Buck et Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requir ements)).\nRequired.", 589 "description": "Google Cloud Storage bucket name (see\n[Buck et Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requir ements)).\nRequired.",
813 "type": "string" 590 "type": "string"
814 } 591 }
815 }, 592 },
816 "type": "object" 593 "type": "object"
817 }, 594 },
818 "ListTransferJobsResponse": { 595 "ListTransferJobsResponse": {
819 "description": "Response from ListTransferJobs.", 596 "description": "Response from ListTransferJobs.",
820 "id": "ListTransferJobsResponse", 597 "id": "ListTransferJobsResponse",
821 "properties": { 598 "properties": {
599 "nextPageToken": {
600 "description": "The list next page token.",
601 "type": "string"
602 },
822 "transferJobs": { 603 "transferJobs": {
823 "description": "A list of transfer jobs.", 604 "description": "A list of transfer jobs.",
824 "items": { 605 "items": {
825 "$ref": "TransferJob" 606 "$ref": "TransferJob"
826 }, 607 },
827 "type": "array" 608 "type": "array"
828 },
829 "nextPageToken": {
830 "description": "The list next page token.",
831 "type": "string"
832 } 609 }
833 }, 610 },
834 "type": "object" 611 "type": "object"
835 }, 612 },
836 "UpdateTransferJobRequest": { 613 "UpdateTransferJobRequest": {
837 "description": "Request passed to UpdateTransferJob.", 614 "description": "Request passed to UpdateTransferJob.",
838 "id": "UpdateTransferJobRequest", 615 "id": "UpdateTransferJobRequest",
839 "properties": { 616 "properties": {
617 "transferJob": {
618 "$ref": "TransferJob",
619 "description": "The job to update.\nRequired."
620 },
840 "projectId": { 621 "projectId": {
841 "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.", 622 "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
842 "type": "string" 623 "type": "string"
843 }, 624 },
844 "updateTransferJobFieldMask": { 625 "updateTransferJobFieldMask": {
845 "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`.", 626 "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`.",
846 "format": "google-fieldmask", 627 "format": "google-fieldmask",
847 "type": "string" 628 "type": "string"
848 },
849 "transferJob": {
850 "$ref": "TransferJob",
851 "description": "The job to update.\nRequired."
852 } 629 }
853 }, 630 },
854 "type": "object" 631 "type": "object"
855 }, 632 },
856 "ObjectConditions": { 633 "ObjectConditions": {
857 "description": "Conditions that determine which objects will be tran sferred.", 634 "description": "Conditions that determine which objects will be tran sferred.",
858 "id": "ObjectConditions", 635 "id": "ObjectConditions",
859 "properties": { 636 "properties": {
637 "includePrefixes": {
638 "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.",
639 "items": {
640 "type": "string"
641 },
642 "type": "array"
643 },
860 "excludePrefixes": { 644 "excludePrefixes": {
861 "description": "`excludePrefixes` must follow the requiremen ts described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 100 0.", 645 "description": "`excludePrefixes` must follow the requiremen ts described for\n`includePrefixes`.\n\nThe max size of `excludePrefixes` is 100 0.",
862 "items": { 646 "items": {
863 "type": "string" 647 "type": "string"
864 }, 648 },
865 "type": "array" 649 "type": "array"
866 }, 650 },
867 "minTimeElapsedSinceLastModification": { 651 "minTimeElapsedSinceLastModification": {
868 "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`.", 652 "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`.",
869 "format": "google-duration", 653 "format": "google-duration",
870 "type": "string" 654 "type": "string"
871 }, 655 },
872 "maxTimeElapsedSinceLastModification": { 656 "maxTimeElapsedSinceLastModification": {
873 "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.", 657 "description": "`maxTimeElapsedSinceLastModification` is the complement to\n`minTimeElapsedSinceLastModification`.",
874 "format": "google-duration", 658 "format": "google-duration",
875 "type": "string" 659 "type": "string"
876 },
877 "includePrefixes": {
878 "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.",
879 "items": {
880 "type": "string"
881 },
882 "type": "array"
883 } 660 }
884 }, 661 },
885 "type": "object" 662 "type": "object"
886 }, 663 },
887 "Operation": { 664 "Operation": {
888 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.", 665 "description": "This resource represents a long-running operation th at is the result of a\nnetwork API call.",
889 "id": "Operation", 666 "id": "Operation",
890 "properties": { 667 "properties": {
891 "done": {
892 "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.",
893 "type": "boolean"
894 },
895 "response": { 668 "response": {
896 "additionalProperties": { 669 "additionalProperties": {
897 "description": "Properties of the object. Contains field @type with type URL.", 670 "description": "Properties of the object. Contains field @type with type URL.",
898 "type": "any" 671 "type": "any"
899 }, 672 },
900 "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`.", 673 "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`.",
901 "type": "object" 674 "type": "object"
902 }, 675 },
903 "name": { 676 "name": {
904 "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`.", 677 "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`.",
905 "type": "string" 678 "type": "string"
906 }, 679 },
907 "error": { 680 "error": {
908 "$ref": "Status", 681 "$ref": "Status",
909 "description": "The error result of the operation in case of failure or cancellation." 682 "description": "The error result of the operation in case of failure or cancellation."
910 }, 683 },
911 "metadata": { 684 "metadata": {
912 "additionalProperties": { 685 "additionalProperties": {
913 "description": "Properties of the object. Contains field @type with type URL.", 686 "description": "Properties of the object. Contains field @type with type URL.",
914 "type": "any" 687 "type": "any"
915 }, 688 },
916 "description": "Represents the transfer operation object.", 689 "description": "Represents the transfer operation object.",
917 "type": "object" 690 "type": "object"
691 },
692 "done": {
693 "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.",
694 "type": "boolean"
918 } 695 }
919 }, 696 },
920 "type": "object" 697 "type": "object"
921 }, 698 },
922 "TransferOptions": { 699 "TransferOptions": {
923 "description": "TransferOptions uses three boolean parameters to def ine the actions\nto be performed on objects in a transfer.", 700 "description": "TransferOptions uses three boolean parameters to def ine the actions\nto be performed on objects in a transfer.",
924 "id": "TransferOptions", 701 "id": "TransferOptions",
925 "properties": { 702 "properties": {
926 "deleteObjectsFromSourceAfterTransfer": {
927 "description": "Whether objects should be deleted from the s ource after they are\ntransferred to the sink. Note that this option and\n`dele teObjectsUniqueInSink` are mutually exclusive.",
928 "type": "boolean"
929 },
930 "deleteObjectsUniqueInSink": { 703 "deleteObjectsUniqueInSink": {
931 "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTran sfer` are mutually\nexclusive.", 704 "description": "Whether objects that exist only in the sink should be deleted. Note that\nthis option and `deleteObjectsFromSourceAfterTran sfer` are mutually\nexclusive.",
932 "type": "boolean" 705 "type": "boolean"
933 }, 706 },
934 "overwriteObjectsAlreadyExistingInSink": { 707 "overwriteObjectsAlreadyExistingInSink": {
935 "description": "Whether overwriting objects that already exi st in the sink is allowed.", 708 "description": "Whether overwriting objects that already exi st in the sink is allowed.",
936 "type": "boolean" 709 "type": "boolean"
710 },
711 "deleteObjectsFromSourceAfterTransfer": {
712 "description": "Whether objects should be deleted from the s ource after they are\ntransferred to the sink. Note that this option and\n`dele teObjectsUniqueInSink` are mutually exclusive.",
713 "type": "boolean"
937 } 714 }
938 }, 715 },
939 "type": "object" 716 "type": "object"
940 }, 717 },
941 "TransferSpec": { 718 "TransferSpec": {
942 "description": "Configuration for running a transfer.", 719 "description": "Configuration for running a transfer.",
943 "id": "TransferSpec", 720 "id": "TransferSpec",
944 "properties": { 721 "properties": {
945 "awsS3DataSource": { 722 "awsS3DataSource": {
946 "$ref": "AwsS3Data", 723 "$ref": "AwsS3Data",
(...skipping 15 matching lines...) Expand all
962 "$ref": "GcsData", 739 "$ref": "GcsData",
963 "description": "A Google Cloud Storage data source." 740 "description": "A Google Cloud Storage data source."
964 }, 741 },
965 "transferOptions": { 742 "transferOptions": {
966 "$ref": "TransferOptions", 743 "$ref": "TransferOptions",
967 "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." 744 "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."
968 } 745 }
969 }, 746 },
970 "type": "object" 747 "type": "object"
971 }, 748 },
749 "ResumeTransferOperationRequest": {
750 "description": "Request passed to ResumeTransferOperation.",
751 "id": "ResumeTransferOperationRequest",
752 "properties": {},
753 "type": "object"
754 },
972 "Status": { 755 "Status": {
973 "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` that can be used for common error conditions.\n\n# Lang uage 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` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\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\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience 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 m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", 756 "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` that can be used for common error conditions.\n\n# Lang uage 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` mess age is\nexposed in different client libraries and different wire protocols, it c an be\nmapped differently. For example, it will likely be mapped to some excepti ons\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\nenvironm ents, either with or without APIs, to provide a\nconsistent developer experience 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 m ay\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\ n- Asynchronous operations. If an API call embeds asynchronous operation\n re sults in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are store d in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.",
974 "id": "Status", 757 "id": "Status",
975 "properties": { 758 "properties": {
976 "code": {
977 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
978 "format": "int32",
979 "type": "integer"
980 },
981 "message": {
982 "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.",
983 "type": "string"
984 },
985 "details": { 759 "details": {
986 "description": "A list of messages that carry the error deta ils. There will be a\ncommon set of message types for APIs to use.", 760 "description": "A list of messages that carry the error deta ils. There is a common set of\nmessage types for APIs to use.",
987 "items": { 761 "items": {
988 "additionalProperties": { 762 "additionalProperties": {
989 "description": "Properties of the object. Contains f ield @type with type URL.", 763 "description": "Properties of the object. Contains f ield @type with type URL.",
990 "type": "any" 764 "type": "any"
991 }, 765 },
992 "type": "object" 766 "type": "object"
993 }, 767 },
994 "type": "array" 768 "type": "array"
769 },
770 "code": {
771 "description": "The status code, which should be an enum val ue of google.rpc.Code.",
772 "format": "int32",
773 "type": "integer"
774 },
775 "message": {
776 "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.",
777 "type": "string"
995 } 778 }
996 }, 779 },
997 "type": "object" 780 "type": "object"
998 }, 781 },
999 "ResumeTransferOperationRequest": {
1000 "description": "Request passed to ResumeTransferOperation.",
1001 "id": "ResumeTransferOperationRequest",
1002 "properties": {},
1003 "type": "object"
1004 },
1005 "ListOperationsResponse": { 782 "ListOperationsResponse": {
1006 "description": "The response message for Operations.ListOperations." , 783 "description": "The response message for Operations.ListOperations." ,
1007 "id": "ListOperationsResponse", 784 "id": "ListOperationsResponse",
1008 "properties": { 785 "properties": {
786 "nextPageToken": {
787 "description": "The standard List next-page token.",
788 "type": "string"
789 },
1009 "operations": { 790 "operations": {
1010 "description": "A list of operations that matches the specif ied filter in the request.", 791 "description": "A list of operations that matches the specif ied filter in the request.",
1011 "items": { 792 "items": {
1012 "$ref": "Operation" 793 "$ref": "Operation"
1013 }, 794 },
1014 "type": "array" 795 "type": "array"
1015 },
1016 "nextPageToken": {
1017 "description": "The standard List next-page token.",
1018 "type": "string"
1019 } 796 }
1020 }, 797 },
1021 "type": "object" 798 "type": "object"
1022 }, 799 },
1023 "GoogleServiceAccount": { 800 "GoogleServiceAccount": {
1024 "description": "Google service account", 801 "description": "Google service account",
1025 "id": "GoogleServiceAccount", 802 "id": "GoogleServiceAccount",
1026 "properties": { 803 "properties": {
1027 "accountEmail": { 804 "accountEmail": {
1028 "description": "Required.", 805 "description": "Required.",
1029 "type": "string" 806 "type": "string"
1030 } 807 }
1031 }, 808 },
1032 "type": "object" 809 "type": "object"
1033 }, 810 },
1034 "TimeOfDay": { 811 "TimeOfDay": {
1035 "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 `.", 812 "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 `.",
1036 "id": "TimeOfDay", 813 "id": "TimeOfDay",
1037 "properties": { 814 "properties": {
815 "minutes": {
816 "description": "Minutes of hour of day. Must be from 0 to 59 .",
817 "format": "int32",
818 "type": "integer"
819 },
1038 "hours": { 820 "hours": {
1039 "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.", 821 "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.",
1040 "format": "int32", 822 "format": "int32",
1041 "type": "integer" 823 "type": "integer"
1042 }, 824 },
1043 "nanos": { 825 "nanos": {
1044 "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", 826 "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.",
1045 "format": "int32", 827 "format": "int32",
1046 "type": "integer" 828 "type": "integer"
1047 }, 829 },
1048 "seconds": { 830 "seconds": {
1049 "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.", 831 "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.",
1050 "format": "int32", 832 "format": "int32",
1051 "type": "integer" 833 "type": "integer"
1052 }, 834 }
1053 "minutes": { 835 },
1054 "description": "Minutes of hour of day. Must be from 0 to 59 .", 836 "type": "object"
1055 "format": "int32", 837 },
1056 "type": "integer" 838 "ErrorLogEntry": {
1057 } 839 "description": "An entry describing an error that has occurred.",
1058 }, 840 "id": "ErrorLogEntry",
841 "properties": {
842 "errorDetails": {
843 "description": "A list of messages that carry the error deta ils.",
844 "items": {
845 "type": "string"
846 },
847 "type": "array"
848 },
849 "url": {
850 "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.",
851 "type": "string"
852 }
853 },
854 "type": "object"
855 },
856 "TransferJob": {
857 "description": "This resource represents the configuration of a tran sfer job that runs\nperiodically.",
858 "id": "TransferJob",
859 "properties": {
860 "creationTime": {
861 "description": "This field cannot be changed by user request s.",
862 "format": "google-datetime",
863 "type": "string"
864 },
865 "transferSpec": {
866 "$ref": "TransferSpec",
867 "description": "Transfer specification.\nRequired."
868 },
869 "status": {
870 "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.",
871 "enum": [
872 "STATUS_UNSPECIFIED",
873 "ENABLED",
874 "DISABLED",
875 "DELETED"
876 ],
877 "enumDescriptions": [
878 "Zero is an illegal value.",
879 "New transfers will be performed based on the schedule." ,
880 "New transfers will not be scheduled.",
881 "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."
882 ],
883 "type": "string"
884 },
885 "schedule": {
886 "$ref": "Schedule",
887 "description": "Schedule specification.\nRequired."
888 },
889 "deletionTime": {
890 "description": "This field cannot be changed by user request s.",
891 "format": "google-datetime",
892 "type": "string"
893 },
894 "name": {
895 "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.",
896 "type": "string"
897 },
898 "projectId": {
899 "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.",
900 "type": "string"
901 },
902 "lastModificationTime": {
903 "description": "This field cannot be changed by user request s.",
904 "format": "google-datetime",
905 "type": "string"
906 },
907 "description": {
908 "description": "A description provided by the user for the j ob. Its max length is 1024\nbytes when Unicode-encoded.",
909 "type": "string"
910 }
911 },
912 "type": "object"
913 },
914 "Schedule": {
915 "description": "Transfers can be scheduled to recur or to run just o nce.",
916 "id": "Schedule",
917 "properties": {
918 "scheduleEndDate": {
919 "$ref": "Date",
920 "description": "The last day the recurring transfer will be run. If `scheduleEndDate`\nis the same as `scheduleStartDate`, the transfer will be executed only\nonce."
921 },
922 "startTimeOfDay": {
923 "$ref": "TimeOfDay",
924 "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."
925 },
926 "scheduleStartDate": {
927 "$ref": "Date",
928 "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."
929 }
930 },
931 "type": "object"
932 },
933 "Date": {
934 "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`.",
935 "id": "Date",
936 "properties": {
937 "day": {
938 "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.",
939 "format": "int32",
940 "type": "integer"
941 },
942 "year": {
943 "description": "Year of date. Must be from 1 to 9999, or 0 i f specifying a date without\na year.",
944 "format": "int32",
945 "type": "integer"
946 },
947 "month": {
948 "description": "Month of year. Must be from 1 to 12.",
949 "format": "int32",
950 "type": "integer"
951 }
952 },
953 "type": "object"
954 },
955 "TransferOperation": {
956 "description": "A description of the execution of a transfer.",
957 "id": "TransferOperation",
958 "properties": {
959 "errorBreakdowns": {
960 "description": "Summarizes errors encountered with sample er ror log entries.",
961 "items": {
962 "$ref": "ErrorSummary"
963 },
964 "type": "array"
965 },
966 "name": {
967 "description": "A globally unique ID assigned by the system. ",
968 "type": "string"
969 },
970 "projectId": {
971 "description": "The ID of the Google Cloud Platform Console project that owns the operation.\nRequired.",
972 "type": "string"
973 },
974 "endTime": {
975 "description": "End time of this transfer execution.",
976 "format": "google-datetime",
977 "type": "string"
978 },
979 "startTime": {
980 "description": "Start time of this transfer execution.",
981 "format": "google-datetime",
982 "type": "string"
983 },
984 "transferJobName": {
985 "description": "The name of the transfer job that triggers t his transfer operation.",
986 "type": "string"
987 },
988 "transferSpec": {
989 "$ref": "TransferSpec",
990 "description": "Transfer specification.\nRequired."
991 },
992 "status": {
993 "description": "Status of the transfer operation.",
994 "enum": [
995 "STATUS_UNSPECIFIED",
996 "IN_PROGRESS",
997 "PAUSED",
998 "SUCCESS",
999 "FAILED",
1000 "ABORTED"
1001 ],
1002 "enumDescriptions": [
1003 "Zero is an illegal value.",
1004 "In progress.",
1005 "Paused.",
1006 "Completed successfully.",
1007 "Terminated due to an unrecoverable failure.",
1008 "Aborted by the user."
1009 ],
1010 "type": "string"
1011 },
1012 "counters": {
1013 "$ref": "TransferCounters",
1014 "description": "Information about the progress of the transf er operation."
1015 }
1016 },
1017 "type": "object"
1018 },
1019 "AwsS3Data": {
1020 "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.",
1021 "id": "AwsS3Data",
1022 "properties": {
1023 "bucketName": {
1024 "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.",
1025 "type": "string"
1026 },
1027 "awsAccessKey": {
1028 "$ref": "AwsAccessKey",
1029 "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."
1030 }
1031 },
1032 "type": "object"
1033 },
1034 "AwsAccessKey": {
1035 "description": "AWS access key (see\n[AWS Security Credentials](http ://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).",
1036 "id": "AwsAccessKey",
1037 "properties": {
1038 "accessKeyId": {
1039 "description": "AWS access key ID.\nRequired.",
1040 "type": "string"
1041 },
1042 "secretAccessKey": {
1043 "description": "AWS secret access key. This field is not ret urned in RPC responses.\nRequired.",
1044 "type": "string"
1045 }
1046 },
1047 "type": "object"
1048 },
1049 "Empty": {
1050 "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 `{}`.",
1051 "id": "Empty",
1052 "properties": {},
1053 "type": "object"
1054 },
1055 "PauseTransferOperationRequest": {
1056 "description": "Request passed to PauseTransferOperation.",
1057 "id": "PauseTransferOperationRequest",
1058 "properties": {},
1059 "type": "object" 1059 "type": "object"
1060 } 1060 }
1061 }, 1061 },
1062 "servicePath": "", 1062 "servicePath": "",
1063 "title": "Google Storage Transfer API", 1063 "title": "Google Storage Transfer API",
1064 "version": "v1" 1064 "version": "v1"
1065 } 1065 }
OLDNEW
« no previous file with comments | « discovery/googleapis/speech__v1.json ('k') | discovery/googleapis/streetviewpublish__v1.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698