v1.d.ts
75.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
/**
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { GaxiosPromise } from 'gaxios';
import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library';
import { APIRequestContext, BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common';
export declare namespace storagetransfer_v1 {
interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API
* access, quota, and reports. Required unless you provide an OAuth 2.0
* token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be
* any arbitrary string assigned to a user, but should not exceed 40
* characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Storage Transfer API
*
* Transfers data from external data sources to a Google Cloud Storage bucket
* or between Google Cloud Storage buckets.
*
* @example
* const {google} = require('googleapis');
* const storagetransfer = google.storagetransfer('v1');
*
* @namespace storagetransfer
* @type {Function}
* @version v1
* @variation v1
* @param {object=} options Options for Storagetransfer
*/
class Storagetransfer {
context: APIRequestContext;
googleServiceAccounts: Resource$Googleserviceaccounts;
transferJobs: Resource$Transferjobs;
transferOperations: Resource$Transferoperations;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* AWS access key (see [AWS Security
* Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).
*/
interface Schema$AwsAccessKey {
/**
* AWS access key ID. Required.
*/
accessKeyId?: string;
/**
* AWS secret access key. This field is not returned in RPC responses.
* Required.
*/
secretAccessKey?: string;
}
/**
* An AwsS3Data resource can be a data source, but not a data sink. In an
* AwsS3Data resource, an object's name is the S3 object's key name.
*/
interface Schema$AwsS3Data {
/**
* AWS access key used to sign the API requests to the AWS S3 bucket.
* Permissions on the bucket must be granted to the access ID of the AWS
* access key. Required.
*/
awsAccessKey?: Schema$AwsAccessKey;
/**
* S3 Bucket name (see [Creating a
* bucket](http://docs.aws.amazon.com/AmazonS3/latest/dev/create-bucket-get-location-example.html)).
* Required.
*/
bucketName?: string;
}
/**
* Represents a whole or partial calendar date, e.g. a birthday. The time of
* day and time zone are either specified elsewhere or are not significant.
* The date is relative to the Proleptic Gregorian Calendar. This can
* represent: * A full date, with non-zero year, month and day values * A
* month and day value, with a zero year, e.g. an anniversary * A year on its
* own, with zero month and day values * A year and month value, with a zero
* day, e.g. a credit card expiration date Related types are
* google.type.TimeOfDay and `google.protobuf.Timestamp`.
*/
interface Schema$Date {
/**
* Day of month. Must be from 1 to 31 and valid for the year and month, or 0
* if specifying a year by itself or a year and month where the day is not
* significant.
*/
day?: number;
/**
* Month of year. Must be from 1 to 12, or 0 if specifying a year without a
* month and day.
*/
month?: number;
/**
* Year of date. Must be from 1 to 9999, or 0 if specifying a date without a
* year.
*/
year?: number;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated
* empty messages in your APIs. A typical example is to use it as the request
* or the response type of an API method. For instance: service Foo { rpc
* Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON
* representation for `Empty` is empty JSON object `{}`.
*/
interface Schema$Empty {
}
/**
* An entry describing an error that has occurred.
*/
interface Schema$ErrorLogEntry {
/**
* A list of messages that carry the error details.
*/
errorDetails?: string[];
/**
* A URL that refers to the target (a data source, a data sink, or an
* object) with which the error is associated. Required.
*/
url?: string;
}
/**
* A summary of errors by error code, plus a count and sample error log
* entries.
*/
interface Schema$ErrorSummary {
/**
* Required.
*/
errorCode?: string;
/**
* Count of this type of error. Required.
*/
errorCount?: string;
/**
* Error samples. No more than 100 error log entries may be recorded for a
* given error code for a single task.
*/
errorLogEntries?: Schema$ErrorLogEntry[];
}
/**
* In a GcsData resource, an object's name is the Google Cloud Storage
* object's name and its `lastModificationTime` refers to the object's
* updated time, which changes when the content or the metadata of the object
* is updated.
*/
interface Schema$GcsData {
/**
* Google Cloud Storage bucket name (see [Bucket Name
* Requirements](https://cloud.google.com/storage/docs/naming#requirements)).
* Required.
*/
bucketName?: string;
}
/**
* Google service account
*/
interface Schema$GoogleServiceAccount {
/**
* Required.
*/
accountEmail?: string;
}
/**
* An HttpData resource specifies a list of objects on the web to 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
* "TsvHttpData-1.0", which specifies the format of the file.
* Subsequent lines specify the information of the list of objects, one object
* per list entry. Each entry has the following tab-delimited fields: * HTTP
* URL - The location of the object. * Length - The size of the object in
* bytes. * MD5 - The base64-encoded MD5 hash of the object. For an example
* of a valid TSV file, see [Transferring data from
* URLs](https://cloud.google.com/storage/transfer/create-url-list). When
* transferring data based on a URL list, keep the following in mind: * When
* an object located at `http(s)://hostname:port/<URL-path>` is
* transferred to a data sink, the name of the object at the data sink is
* `<hostname>/<URL-path>`. * If the specified size of an object
* does not match the actual size of the object fetched, the object will not
* be transferred. * If the specified MD5 does not match the MD5 computed
* from the transferred bytes, the object transfer will fail. For more
* information, see [Generating MD5
* hashes](https://cloud.google.com/storage/transfer/#md5) * Ensure that each
* URL you specify is publicly accessible. For example, in Google Cloud
* Storage you can [share an object publicly]
* (https://cloud.google.com/storage/docs/cloud-console#_sharingdata) and get
* a link to it. * Storage Transfer Service obeys `robots.txt` rules and
* requires the source HTTP server to support `Range` requests and to return a
* `Content-Length` header in each response. *
* [ObjectConditions](#ObjectConditions) have no effect when filtering objects
* to transfer.
*/
interface Schema$HttpData {
/**
* The URL that points to the file that stores the object list entries. This
* file must allow public access. Currently, only URLs with HTTP and HTTPS
* schemes are supported. Required.
*/
listUrl?: string;
}
/**
* The response message for Operations.ListOperations.
*/
interface Schema$ListOperationsResponse {
/**
* The standard List next-page token.
*/
nextPageToken?: string;
/**
* A list of operations that matches the specified filter in the request.
*/
operations?: Schema$Operation[];
}
/**
* Response from ListTransferJobs.
*/
interface Schema$ListTransferJobsResponse {
/**
* The list next page token.
*/
nextPageToken?: string;
/**
* A list of transfer jobs.
*/
transferJobs?: Schema$TransferJob[];
}
/**
* Conditions that determine which objects will be transferred. Applies only
* to S3 and GCS objects.
*/
interface Schema$ObjectConditions {
/**
* `excludePrefixes` must follow the requirements described for
* `includePrefixes`. The max size of `excludePrefixes` is 1000.
*/
excludePrefixes?: string[];
/**
* If `includePrefixes` is specified, objects that satisfy the object
* conditions must have names that start with one of the `includePrefixes`
* and that do not start with any of the `excludePrefixes`. If
* `includePrefixes` is not specified, all objects except those that have
* names starting with one of the `excludePrefixes` must satisfy the object
* conditions. Requirements: * Each include-prefix and exclude-prefix
* can contain any sequence of Unicode characters, of max length 1024
* bytes when UTF8-encoded, and must not contain Carriage Return or Line
* Feed characters. Wildcard matching and regular expression matching
* are not supported. * Each include-prefix and exclude-prefix must omit
* the leading slash. For example, to include the `requests.gz` object
* in a transfer from `s3://my-aws-bucket/logs/y=2015/requests.gz`,
* specify the include prefix as `logs/y=2015/requests.gz`. * 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
* another include-prefix. * Each exclude-prefix must exclude a
* distinct portion of the object namespace, i.e., no exclude-prefix may
* be a prefix of another exclude-prefix. * 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 1000.
*/
includePrefixes?: string[];
/**
* If specified, only objects with a `lastModificationTime` on or after
* `NOW` - `maxTimeElapsedSinceLastModification` and objects that don't
* have a `lastModificationTime` are transferred. Note that `NOW` refers to
* the creation time of the transfer job, and `lastModificationTime` refers
* to the time of the last change to the object's content or metadata.
* Specifically, this would be the `updated` property of GCS objects and the
* `LastModified` field of S3 objects.
*/
maxTimeElapsedSinceLastModification?: string;
/**
* If specified, only objects with a `lastModificationTime` before `NOW` -
* `minTimeElapsedSinceLastModification` and objects that don't have a
* `lastModificationTime` are transferred. Note that `NOW` refers to the
* creation time of the transfer job, and `lastModificationTime` refers to
* the time of the last change to the object's content or metadata.
* Specifically, this would be the `updated` property of GCS objects and the
* `LastModified` field of S3 objects.
*/
minTimeElapsedSinceLastModification?: string;
}
/**
* This resource represents a long-running operation that is the result of a
* network API call.
*/
interface Schema$Operation {
/**
* If the value is `false`, it means the operation is still in progress. If
* `true`, the operation is completed, and either `error` or `response` is
* available.
*/
done?: boolean;
/**
* The error result of the operation in case of failure or cancellation.
*/
error?: Schema$Status;
/**
* Represents the transfer operation object.
*/
metadata?: {
[key: string]: any;
};
/**
* The server-assigned name, which is only unique within the same service
* that originally returns it. If you use the default HTTP mapping, the
* `name` should have the format of `transferOperations/some/unique/name`.
*/
name?: string;
/**
* The normal response of the operation in case of success. If the original
* method returns no data on success, such as `Delete`, the response is
* `google.protobuf.Empty`. If the original method is standard
* `Get`/`Create`/`Update`, the response should be the resource. For other
* methods, the response should have the type `XxxResponse`, where `Xxx` is
* the original method name. For example, if the original method name is
* `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
*/
response?: {
[key: string]: any;
};
}
/**
* Request passed to PauseTransferOperation.
*/
interface Schema$PauseTransferOperationRequest {
}
/**
* Request passed to ResumeTransferOperation.
*/
interface Schema$ResumeTransferOperationRequest {
}
/**
* Transfers can be scheduled to recur or to run just once.
*/
interface Schema$Schedule {
/**
* The last day the recurring transfer will be run. If `scheduleEndDate` is
* the same as `scheduleStartDate`, the transfer will be executed only once.
*/
scheduleEndDate?: Schema$Date;
/**
* The first day the recurring transfer is scheduled to run. If
* `scheduleStartDate` is in the past, the transfer will run for the first
* time on the following day. Required.
*/
scheduleStartDate?: Schema$Date;
/**
* The time in UTC at which the transfer will be scheduled to start in a
* day. Transfers may start later than this time. If not specified,
* recurring and one-time transfers that are scheduled to run today will run
* immediately; recurring transfers that are scheduled to run on a future
* date will start at approximately midnight UTC on that date. Note that
* when configuring a transfer with the Cloud Platform Console, the
* transfer's start time in a day is specified in your local timezone.
*/
startTimeOfDay?: Schema$TimeOfDay;
}
/**
* 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 designed 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, 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 or localize it in the client. The optional error details
* may contain arbitrary information about the error. There is a predefined
* set of error detail types in the package `google.rpc` that 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 exposed in different
* client libraries and different wire protocols, it can be mapped
* differently. For example, it will likely be mapped to some exceptions in
* Java, 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 environments. Example uses of this
* error model include: - Partial errors. If a service 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 typical
* workflow has multiple steps. Each step may have a `Status` message for
* error reporting. - Batch operations. If a client uses batch request and
* batch response, the `Status` message should be used directly inside
* batch response, one for each error sub-response. - Asynchronous
* operations. If an API call embeds asynchronous operation results in its
* response, the status of those operations should 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.
*/
interface Schema$Status {
/**
* The status code, which should be an enum value of google.rpc.Code.
*/
code?: number;
/**
* A list of messages that carry the error details. There is a common set
* of message types for APIs to use.
*/
details?: Array<{
[key: string]: any;
}>;
/**
* A developer-facing error message, which should be in English. Any
* user-facing error message should be localized and sent in the
* google.rpc.Status.details field, or localized by the client.
*/
message?: string;
}
/**
* Represents a time of day. The date and time zone are either not significant
* or are specified elsewhere. An API may choose to allow leap seconds.
* Related types are google.type.Date and `google.protobuf.Timestamp`.
*/
interface Schema$TimeOfDay {
/**
* Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
* to allow the value "24:00:00" for scenarios like business
* closing time.
*/
hours?: number;
/**
* Minutes of hour of day. Must be from 0 to 59.
*/
minutes?: number;
/**
* Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
*/
nanos?: number;
/**
* Seconds of minutes of the time. Must normally be from 0 to 59. An API may
* allow the value 60 if it allows leap-seconds.
*/
seconds?: number;
}
/**
* A collection of counters that report the progress of a transfer operation.
*/
interface Schema$TransferCounters {
/**
* Bytes that are copied to the data sink.
*/
bytesCopiedToSink?: string;
/**
* Bytes that are deleted from the data sink.
*/
bytesDeletedFromSink?: string;
/**
* Bytes that are deleted from the data source.
*/
bytesDeletedFromSource?: string;
/**
* Bytes that failed to be deleted from the data sink.
*/
bytesFailedToDeleteFromSink?: string;
/**
* Bytes found in the data source that are scheduled to be transferred,
* excluding any that are filtered based on object conditions or skipped due
* to sync.
*/
bytesFoundFromSource?: string;
/**
* Bytes found only in the data sink that are scheduled to be deleted.
*/
bytesFoundOnlyFromSink?: string;
/**
* Bytes in the data source that failed to be transferred or that failed to
* be deleted after being transferred.
*/
bytesFromSourceFailed?: string;
/**
* Bytes in the data source that are not transferred because they already
* exist in the data sink.
*/
bytesFromSourceSkippedBySync?: string;
/**
* Objects that are copied to the data sink.
*/
objectsCopiedToSink?: string;
/**
* Objects that are deleted from the data sink.
*/
objectsDeletedFromSink?: string;
/**
* Objects that are deleted from the data source.
*/
objectsDeletedFromSource?: string;
/**
* Objects that failed to be deleted from the data sink.
*/
objectsFailedToDeleteFromSink?: string;
/**
* Objects found in the data source that are scheduled to be transferred,
* excluding any that are filtered based on object conditions or skipped due
* to sync.
*/
objectsFoundFromSource?: string;
/**
* Objects found only in the data sink that are scheduled to be deleted.
*/
objectsFoundOnlyFromSink?: string;
/**
* Objects in the data source that failed to be transferred or that failed
* to be deleted after being transferred.
*/
objectsFromSourceFailed?: string;
/**
* Objects in the data source that are not transferred because they already
* exist in the data sink.
*/
objectsFromSourceSkippedBySync?: string;
}
/**
* This resource represents the configuration of a transfer job that runs
* periodically.
*/
interface Schema$TransferJob {
/**
* This field cannot be changed by user requests.
*/
creationTime?: string;
/**
* This field cannot be changed by user requests.
*/
deletionTime?: string;
/**
* A description provided by the user for the job. Its max length is 1024
* bytes when Unicode-encoded.
*/
description?: string;
/**
* This field cannot be changed by user requests.
*/
lastModificationTime?: string;
/**
* A globally unique name assigned by Storage Transfer Service when the job
* is created. This field should be left empty in requests to create a new
* transfer job; otherwise, the requests result in an `INVALID_ARGUMENT`
* error.
*/
name?: string;
/**
* The ID of the Google Cloud Platform Project that owns the job.
*/
projectId?: string;
/**
* Schedule specification.
*/
schedule?: Schema$Schedule;
/**
* Status of the job. This value MUST be specified for
* `CreateTransferJobRequests`. NOTE: The effect of the new job status
* takes place during a subsequent job run. For example, if you change the
* job status from `ENABLED` to `DISABLED`, and an operation spawned by the
* transfer is running, the status change would not affect the current
* operation.
*/
status?: string;
/**
* Transfer specification.
*/
transferSpec?: Schema$TransferSpec;
}
/**
* A description of the execution of a transfer.
*/
interface Schema$TransferOperation {
/**
* Information about the progress of the transfer operation.
*/
counters?: Schema$TransferCounters;
/**
* End time of this transfer execution.
*/
endTime?: string;
/**
* Summarizes errors encountered with sample error log entries.
*/
errorBreakdowns?: Schema$ErrorSummary[];
/**
* A globally unique ID assigned by the system.
*/
name?: string;
/**
* The ID of the Google Cloud Platform Project that owns the operation.
* Required.
*/
projectId?: string;
/**
* Start time of this transfer execution.
*/
startTime?: string;
/**
* Status of the transfer operation.
*/
status?: string;
/**
* The name of the transfer job that triggers this transfer operation.
*/
transferJobName?: string;
/**
* Transfer specification. Required.
*/
transferSpec?: Schema$TransferSpec;
}
/**
* TransferOptions uses three boolean parameters to define the actions to be
* performed on objects in a transfer.
*/
interface Schema$TransferOptions {
/**
* Whether objects should be deleted from the source after they are
* transferred to the sink. Note that this option and
* `deleteObjectsUniqueInSink` are mutually exclusive.
*/
deleteObjectsFromSourceAfterTransfer?: boolean;
/**
* Whether objects that exist only in the sink should be deleted. Note that
* this option and `deleteObjectsFromSourceAfterTransfer` are mutually
* exclusive.
*/
deleteObjectsUniqueInSink?: boolean;
/**
* Whether overwriting objects that already exist in the sink is allowed.
*/
overwriteObjectsAlreadyExistingInSink?: boolean;
}
/**
* Configuration for running a transfer.
*/
interface Schema$TransferSpec {
/**
* An AWS S3 data source.
*/
awsS3DataSource?: Schema$AwsS3Data;
/**
* A Google Cloud Storage data sink.
*/
gcsDataSink?: Schema$GcsData;
/**
* A Google Cloud Storage data source.
*/
gcsDataSource?: Schema$GcsData;
/**
* An HTTP URL data source.
*/
httpDataSource?: Schema$HttpData;
/**
* Only objects that satisfy these object conditions are included in the set
* of data source and data sink objects. Object conditions based on
* objects' `lastModificationTime` do not exclude objects in a data
* sink.
*/
objectConditions?: Schema$ObjectConditions;
/**
* 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.
*/
transferOptions?: Schema$TransferOptions;
}
/**
* Request passed to UpdateTransferJob.
*/
interface Schema$UpdateTransferJobRequest {
/**
* The ID of the Google Cloud Platform Console project that owns the job.
* Required.
*/
projectId?: string;
/**
* The job to update. `transferJob` is expected to specify only three
* fields: `description`, `transferSpec`, and `status`. An
* UpdateTransferJobRequest that specifies other fields will be rejected
* with an error `INVALID_ARGUMENT`. Required.
*/
transferJob?: Schema$TransferJob;
/**
* The field mask of the fields in `transferJob` that are to be updated in
* this request. Fields in `transferJob` that can be updated are:
* `description`, `transferSpec`, and `status`. To update the
* `transferSpec` of the job, a complete transfer specification has to be
* provided. An incomplete specification which misses any required fields
* will be rejected with the error `INVALID_ARGUMENT`.
*/
updateTransferJobFieldMask?: string;
}
class Resource$Googleserviceaccounts {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* storagetransfer.googleServiceAccounts.get
* @desc Returns the Google service account that is used 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 Google Cloud
* Platform Console project. Users should add this service account to the
* Google 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 be used by Storage Transfer Service.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The ID of the Google Cloud Platform Console project that the
* Google service
* // account is associated with.
* // Required.
* projectId: 'my-project-id', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* storagetransfer.googleServiceAccounts.get(request, function(err,
* response) { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.googleServiceAccounts.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.projectId The ID of the Google Cloud Platform Console project that the Google service account is associated with. Required.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Googleserviceaccounts$Get, options?: MethodOptions): GaxiosPromise<Schema$GoogleServiceAccount>;
get(params: Params$Resource$Googleserviceaccounts$Get, options: MethodOptions | BodyResponseCallback<Schema$GoogleServiceAccount>, callback: BodyResponseCallback<Schema$GoogleServiceAccount>): void;
get(params: Params$Resource$Googleserviceaccounts$Get, callback: BodyResponseCallback<Schema$GoogleServiceAccount>): void;
get(callback: BodyResponseCallback<Schema$GoogleServiceAccount>): void;
}
interface Params$Resource$Googleserviceaccounts$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The ID of the Google Cloud Platform Console project that the Google
* service account is associated with. Required.
*/
projectId?: string;
}
class Resource$Transferjobs {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* storagetransfer.transferJobs.create
* @desc Creates a transfer job that runs periodically.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* storagetransfer.transferJobs.create(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferJobs.create
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {().TransferJob} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
create(params?: Params$Resource$Transferjobs$Create, options?: MethodOptions): GaxiosPromise<Schema$TransferJob>;
create(params: Params$Resource$Transferjobs$Create, options: MethodOptions | BodyResponseCallback<Schema$TransferJob>, callback: BodyResponseCallback<Schema$TransferJob>): void;
create(params: Params$Resource$Transferjobs$Create, callback: BodyResponseCallback<Schema$TransferJob>): void;
create(callback: BodyResponseCallback<Schema$TransferJob>): void;
/**
* storagetransfer.transferJobs.get
* @desc Gets a transfer job.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The job to get.
* // Required.
* jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder
* value.
*
* auth: authClient,
* };
*
* storagetransfer.transferJobs.get(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferJobs.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobName The job to get. Required.
* @param {string=} params.projectId The ID of the Google Cloud Platform Console project that owns the job. Required.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Transferjobs$Get, options?: MethodOptions): GaxiosPromise<Schema$TransferJob>;
get(params: Params$Resource$Transferjobs$Get, options: MethodOptions | BodyResponseCallback<Schema$TransferJob>, callback: BodyResponseCallback<Schema$TransferJob>): void;
get(params: Params$Resource$Transferjobs$Get, callback: BodyResponseCallback<Schema$TransferJob>): void;
get(callback: BodyResponseCallback<Schema$TransferJob>): void;
/**
* storagetransfer.transferJobs.list
* @desc Lists transfer jobs.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var transferJobsPage = response['transferJobs'];
* if (!transferJobsPage) {
* return;
* }
* for (var i = 0; i < transferJobsPage.length; i++) {
* // TODO: Change code below to process each resource in
* `transferJobsPage`: console.log(JSON.stringify(transferJobsPage[i], null,
* 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* storagetransfer.transferJobs.list(request, handlePage);
* }
* };
*
* storagetransfer.transferJobs.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferJobs.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter 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 must be specified with array notation. `project_id` is required. `job_names` and `job_statuses` are optional. The valid values for `job_statuses` are case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.
* @param {integer=} params.pageSize The list page size. The max allowed value is 256.
* @param {string=} params.pageToken The list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Transferjobs$List, options?: MethodOptions): GaxiosPromise<Schema$ListTransferJobsResponse>;
list(params: Params$Resource$Transferjobs$List, options: MethodOptions | BodyResponseCallback<Schema$ListTransferJobsResponse>, callback: BodyResponseCallback<Schema$ListTransferJobsResponse>): void;
list(params: Params$Resource$Transferjobs$List, callback: BodyResponseCallback<Schema$ListTransferJobsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListTransferJobsResponse>): void;
/**
* storagetransfer.transferJobs.patch
* @desc Updates a transfer job. Updating a job's transfer spec does not
* affect transfer operations that are running already. Updating the
* scheduling of a job is not allowed.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of job to update.
* // Required.
* jobName: 'transferJobs/my-transfer-job', // TODO: Update placeholder
* value.
*
* resource: {
* // TODO: Add desired properties to the request body. Only these
* properties
* // will be changed.
* },
*
* auth: authClient,
* };
*
* storagetransfer.transferJobs.patch(request, function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferJobs.patch
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.jobName The name of job to update. Required.
* @param {().UpdateTransferJobRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
patch(params?: Params$Resource$Transferjobs$Patch, options?: MethodOptions): GaxiosPromise<Schema$TransferJob>;
patch(params: Params$Resource$Transferjobs$Patch, options: MethodOptions | BodyResponseCallback<Schema$TransferJob>, callback: BodyResponseCallback<Schema$TransferJob>): void;
patch(params: Params$Resource$Transferjobs$Patch, callback: BodyResponseCallback<Schema$TransferJob>): void;
patch(callback: BodyResponseCallback<Schema$TransferJob>): void;
}
interface Params$Resource$Transferjobs$Create extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* Request body metadata
*/
requestBody?: Schema$TransferJob;
}
interface Params$Resource$Transferjobs$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The job to get. Required.
*/
jobName?: string;
/**
* The ID of the Google Cloud Platform Console project that owns the job.
* Required.
*/
projectId?: string;
}
interface Params$Resource$Transferjobs$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* 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 must be specified
* with array notation. `project_id` is required. `job_names` and
* `job_statuses` are optional. The valid values for `job_statuses` are
* case-insensitive: `ENABLED`, `DISABLED`, and `DELETED`.
*/
filter?: string;
/**
* The list page size. The max allowed value is 256.
*/
pageSize?: number;
/**
* The list page token.
*/
pageToken?: string;
}
interface Params$Resource$Transferjobs$Patch extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of job to update. Required.
*/
jobName?: string;
/**
* Request body metadata
*/
requestBody?: Schema$UpdateTransferJobRequest;
}
class Resource$Transferoperations {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* storagetransfer.transferOperations.cancel
* @desc Cancels a transfer. Use the get method to check whether the
* cancellation succeeded or whether the operation completed despite
* cancellation.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of the operation resource to be cancelled.
* name: 'transferOperations/my-transfer-operation', // TODO: Update
* placeholder value.
*
* auth: authClient,
* };
*
* storagetransfer.transferOperations.cancel(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferOperations.cancel
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be cancelled.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
cancel(params?: Params$Resource$Transferoperations$Cancel, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
cancel(params: Params$Resource$Transferoperations$Cancel, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(params: Params$Resource$Transferoperations$Cancel, callback: BodyResponseCallback<Schema$Empty>): void;
cancel(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* storagetransfer.transferOperations.delete
* @desc This method is not supported and the server returns
* `UNIMPLEMENTED`.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of the operation resource to be deleted.
* name: 'transferOperations/my-transfer-operation', // TODO: Update
* placeholder value.
*
* auth: authClient,
* };
*
* storagetransfer.transferOperations.delete(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferOperations.delete
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource to be deleted.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
delete(params?: Params$Resource$Transferoperations$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Transferoperations$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Transferoperations$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* storagetransfer.transferOperations.get
* @desc Gets the latest state of a long-running operation. Clients can use
* this method to poll the operation result at intervals as recommended by
* the API service.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of the operation resource.
* name: 'transferOperations/my-transfer-operation', // TODO: Update
* placeholder value.
*
* auth: authClient,
* };
*
* storagetransfer.transferOperations.get(request, function(err, response)
* { if (err) { console.error(err); return;
* }
*
* // TODO: Change code below to process the `response` object:
* console.log(JSON.stringify(response, null, 2));
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferOperations.get
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the operation resource.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
get(params?: Params$Resource$Transferoperations$Get, options?: MethodOptions): GaxiosPromise<Schema$Operation>;
get(params: Params$Resource$Transferoperations$Get, options: MethodOptions | BodyResponseCallback<Schema$Operation>, callback: BodyResponseCallback<Schema$Operation>): void;
get(params: Params$Resource$Transferoperations$Get, callback: BodyResponseCallback<Schema$Operation>): void;
get(callback: BodyResponseCallback<Schema$Operation>): void;
/**
* storagetransfer.transferOperations.list
* @desc Lists operations that match the specified filter in the request. If
* the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE:
* the `name` binding allows API services to override the binding to use
* different resource name schemes, such as `users/x/operations`. To
* override the binding, API services can add a binding such as
* `"/v1/{name=users/x}/operations"` to their service configuration. For
* backwards compatibility, the default name includes the operations
* collection id, however overriding users must ensure the name binding is
* the parent resource, without the operations collection id.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The value `transferOperations`.
* name: 'transferOperations', // TODO: Update placeholder value.
*
* auth: authClient,
* };
*
* var handlePage = function(err, response) {
* if (err) {
* console.error(err);
* return;
* }
*
* var operationsPage = response['operations'];
* if (!operationsPage) {
* return;
* }
* for (var i = 0; i < operationsPage.length; i++) {
* // TODO: Change code below to process each resource in
* `operationsPage`: console.log(JSON.stringify(operationsPage[i], null,
* 2));
* }
*
* if (response.nextPageToken) {
* request.pageToken = response.nextPageToken;
* storagetransfer.transferOperations.list(request, handlePage);
* }
* };
*
* storagetransfer.transferOperations.list(request, handlePage);
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferOperations.list
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string=} params.filter A list of query parameters specified as JSON text in the form of {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\", \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...], \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`, `operation_names`, and `transfer_statuses` support multiple values, they must be specified with array notation. `job_names`, `operation_names`, and `transfer_statuses` are optional.
* @param {string} params.name The value `transferOperations`.
* @param {integer=} params.pageSize The list page size. The max allowed value is 256.
* @param {string=} params.pageToken The list page token.
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
list(params?: Params$Resource$Transferoperations$List, options?: MethodOptions): GaxiosPromise<Schema$ListOperationsResponse>;
list(params: Params$Resource$Transferoperations$List, options: MethodOptions | BodyResponseCallback<Schema$ListOperationsResponse>, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(params: Params$Resource$Transferoperations$List, callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListOperationsResponse>): void;
/**
* storagetransfer.transferOperations.pause
* @desc Pauses a transfer operation.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of the transfer operation.
* // Required.
* name: 'transferOperations/my-transfer-operation', // TODO: Update
* placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* storagetransfer.transferOperations.pause(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferOperations.pause
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the transfer operation. Required.
* @param {().PauseTransferOperationRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
pause(params?: Params$Resource$Transferoperations$Pause, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
pause(params: Params$Resource$Transferoperations$Pause, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
pause(params: Params$Resource$Transferoperations$Pause, callback: BodyResponseCallback<Schema$Empty>): void;
pause(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* storagetransfer.transferOperations.resume
* @desc Resumes a transfer operation that is paused.
* @example
* * // BEFORE RUNNING:
* // ---------------
* // 1. If not already done, enable the Google Storage Transfer API
* // and check the quota for your project at
* // https://console.developers.google.com/apis/api/storagetransfer
* // 2. This sample uses Application Default Credentials for
* authentication.
* // If not already done, install the gcloud CLI from
* // https://cloud.google.com/sdk and run
* // `gcloud beta auth application-default login`.
* // For more information, see
* //
* https://developers.google.com/identity/protocols/application-default-credentials
* // 3. Install the Node.js client library by running
* // `npm install googleapis --save`
*
* var google = require('googleapis');
* var storagetransfer = google.storagetransfer('v1');
*
* authorize(function(authClient) {
* var request = {
* // The name of the transfer operation.
* // Required.
* name: 'transferOperations/my-transfer-operation', // TODO: Update
* placeholder value.
*
* resource: {
* // TODO: Add desired properties to the request body.
* },
*
* auth: authClient,
* };
*
* storagetransfer.transferOperations.resume(request, function(err) {
* if (err) {
* console.error(err);
* return;
* }
* });
* });
*
* function authorize(callback) {
* google.auth.getApplicationDefault(function(err, authClient) {
* if (err) {
* console.error('authentication failed: ', err);
* return;
* }
* if (authClient.createScopedRequired &&
* authClient.createScopedRequired()) { var scopes =
* ['https://www.googleapis.com/auth/cloud-platform']; authClient =
* authClient.createScoped(scopes);
* }
* callback(authClient);
* });
* }
* @alias storagetransfer.transferOperations.resume
* @memberOf! ()
*
* @param {object} params Parameters for request
* @param {string} params.name The name of the transfer operation. Required.
* @param {().ResumeTransferOperationRequest} params.resource Request body data
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
* @param {callback} callback The callback that handles the response.
* @return {object} Request object
*/
resume(params?: Params$Resource$Transferoperations$Resume, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
resume(params: Params$Resource$Transferoperations$Resume, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
resume(params: Params$Resource$Transferoperations$Resume, callback: BodyResponseCallback<Schema$Empty>): void;
resume(callback: BodyResponseCallback<Schema$Empty>): void;
}
interface Params$Resource$Transferoperations$Cancel extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be cancelled.
*/
name?: string;
}
interface Params$Resource$Transferoperations$Delete extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource to be deleted.
*/
name?: string;
}
interface Params$Resource$Transferoperations$Get extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the operation resource.
*/
name?: string;
}
interface Params$Resource$Transferoperations$List extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* A list of query parameters specified as JSON text in the form of
* {\"project_id\" : \"my_project_id\", \"job_names\" : [\"jobid1\",
* \"jobid2\",...], \"operation_names\" : [\"opid1\", \"opid2\",...],
* \"transfer_statuses\":[\"status1\", \"status2\",...]}. Since `job_names`,
* `operation_names`, and `transfer_statuses` support multiple values, they
* must be specified with array notation. `job_names`, `operation_names`,
* and `transfer_statuses` are optional.
*/
filter?: string;
/**
* The value `transferOperations`.
*/
name?: string;
/**
* The list page size. The max allowed value is 256.
*/
pageSize?: number;
/**
* The list page token.
*/
pageToken?: string;
}
interface Params$Resource$Transferoperations$Pause extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the transfer operation. Required.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$PauseTransferOperationRequest;
}
interface Params$Resource$Transferoperations$Resume extends StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient;
/**
* The name of the transfer operation. Required.
*/
name?: string;
/**
* Request body metadata
*/
requestBody?: Schema$ResumeTransferOperationRequest;
}
}