@googleapis/storage 5.1.0 → 5.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/build/v1.d.ts CHANGED
@@ -921,50 +921,6 @@ export declare namespace storage_v1 {
921
921
  constructor(context: APIRequestContext);
922
922
  /**
923
923
  * Permanently deletes the ACL entry for the specified entity on the specified bucket.
924
- * @example
925
- * ```js
926
- * // Before running the sample:
927
- * // - Enable the API at:
928
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
929
- * // - Login into gcloud by running:
930
- * // `$ gcloud auth application-default login`
931
- * // - Install the npm module by running:
932
- * // `$ npm install googleapis`
933
- *
934
- * const {google} = require('googleapis');
935
- * const storage = google.storage('v1');
936
- *
937
- * async function main() {
938
- * const auth = new google.auth.GoogleAuth({
939
- * // Scopes can be specified either as an array or as a single, space-delimited string.
940
- * scopes: [
941
- * 'https://www.googleapis.com/auth/cloud-platform',
942
- * 'https://www.googleapis.com/auth/devstorage.full_control',
943
- * ],
944
- * });
945
- *
946
- * // Acquire an auth client, and bind it to all future calls
947
- * const authClient = await auth.getClient();
948
- * google.options({auth: authClient});
949
- *
950
- * // Do the magic
951
- * const res = await storage.bucketAccessControls.delete({
952
- * // Name of a bucket.
953
- * bucket: 'placeholder-value',
954
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
955
- * entity: 'placeholder-value',
956
- * // The project to be billed for this request. Required for Requester Pays buckets.
957
- * userProject: 'placeholder-value',
958
- * });
959
- * console.log(res.data);
960
- * }
961
- *
962
- * main().catch(e => {
963
- * console.error(e);
964
- * throw e;
965
- * });
966
- *
967
- * ```
968
924
  *
969
925
  * @param params - Parameters for request
970
926
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -979,65 +935,6 @@ export declare namespace storage_v1 {
979
935
  delete(callback: BodyResponseCallback<void>): void;
980
936
  /**
981
937
  * Returns the ACL entry for the specified entity on the specified bucket.
982
- * @example
983
- * ```js
984
- * // Before running the sample:
985
- * // - Enable the API at:
986
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
987
- * // - Login into gcloud by running:
988
- * // `$ gcloud auth application-default login`
989
- * // - Install the npm module by running:
990
- * // `$ npm install googleapis`
991
- *
992
- * const {google} = require('googleapis');
993
- * const storage = google.storage('v1');
994
- *
995
- * async function main() {
996
- * const auth = new google.auth.GoogleAuth({
997
- * // Scopes can be specified either as an array or as a single, space-delimited string.
998
- * scopes: [
999
- * 'https://www.googleapis.com/auth/cloud-platform',
1000
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1001
- * ],
1002
- * });
1003
- *
1004
- * // Acquire an auth client, and bind it to all future calls
1005
- * const authClient = await auth.getClient();
1006
- * google.options({auth: authClient});
1007
- *
1008
- * // Do the magic
1009
- * const res = await storage.bucketAccessControls.get({
1010
- * // Name of a bucket.
1011
- * bucket: 'placeholder-value',
1012
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
1013
- * entity: 'placeholder-value',
1014
- * // The project to be billed for this request. Required for Requester Pays buckets.
1015
- * userProject: 'placeholder-value',
1016
- * });
1017
- * console.log(res.data);
1018
- *
1019
- * // Example response
1020
- * // {
1021
- * // "bucket": "my_bucket",
1022
- * // "domain": "my_domain",
1023
- * // "email": "my_email",
1024
- * // "entity": "my_entity",
1025
- * // "entityId": "my_entityId",
1026
- * // "etag": "my_etag",
1027
- * // "id": "my_id",
1028
- * // "kind": "my_kind",
1029
- * // "projectTeam": {},
1030
- * // "role": "my_role",
1031
- * // "selfLink": "my_selfLink"
1032
- * // }
1033
- * }
1034
- *
1035
- * main().catch(e => {
1036
- * console.error(e);
1037
- * throw e;
1038
- * });
1039
- *
1040
- * ```
1041
938
  *
1042
939
  * @param params - Parameters for request
1043
940
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1052,81 +949,6 @@ export declare namespace storage_v1 {
1052
949
  get(callback: BodyResponseCallback<Schema$BucketAccessControl>): void;
1053
950
  /**
1054
951
  * Creates a new ACL entry on the specified bucket.
1055
- * @example
1056
- * ```js
1057
- * // Before running the sample:
1058
- * // - Enable the API at:
1059
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1060
- * // - Login into gcloud by running:
1061
- * // `$ gcloud auth application-default login`
1062
- * // - Install the npm module by running:
1063
- * // `$ npm install googleapis`
1064
- *
1065
- * const {google} = require('googleapis');
1066
- * const storage = google.storage('v1');
1067
- *
1068
- * async function main() {
1069
- * const auth = new google.auth.GoogleAuth({
1070
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1071
- * scopes: [
1072
- * 'https://www.googleapis.com/auth/cloud-platform',
1073
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1074
- * ],
1075
- * });
1076
- *
1077
- * // Acquire an auth client, and bind it to all future calls
1078
- * const authClient = await auth.getClient();
1079
- * google.options({auth: authClient});
1080
- *
1081
- * // Do the magic
1082
- * const res = await storage.bucketAccessControls.insert({
1083
- * // Name of a bucket.
1084
- * bucket: 'placeholder-value',
1085
- * // The project to be billed for this request. Required for Requester Pays buckets.
1086
- * userProject: 'placeholder-value',
1087
- *
1088
- * // Request body metadata
1089
- * requestBody: {
1090
- * // request body parameters
1091
- * // {
1092
- * // "bucket": "my_bucket",
1093
- * // "domain": "my_domain",
1094
- * // "email": "my_email",
1095
- * // "entity": "my_entity",
1096
- * // "entityId": "my_entityId",
1097
- * // "etag": "my_etag",
1098
- * // "id": "my_id",
1099
- * // "kind": "my_kind",
1100
- * // "projectTeam": {},
1101
- * // "role": "my_role",
1102
- * // "selfLink": "my_selfLink"
1103
- * // }
1104
- * },
1105
- * });
1106
- * console.log(res.data);
1107
- *
1108
- * // Example response
1109
- * // {
1110
- * // "bucket": "my_bucket",
1111
- * // "domain": "my_domain",
1112
- * // "email": "my_email",
1113
- * // "entity": "my_entity",
1114
- * // "entityId": "my_entityId",
1115
- * // "etag": "my_etag",
1116
- * // "id": "my_id",
1117
- * // "kind": "my_kind",
1118
- * // "projectTeam": {},
1119
- * // "role": "my_role",
1120
- * // "selfLink": "my_selfLink"
1121
- * // }
1122
- * }
1123
- *
1124
- * main().catch(e => {
1125
- * console.error(e);
1126
- * throw e;
1127
- * });
1128
- *
1129
- * ```
1130
952
  *
1131
953
  * @param params - Parameters for request
1132
954
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1141,54 +963,6 @@ export declare namespace storage_v1 {
1141
963
  insert(callback: BodyResponseCallback<Schema$BucketAccessControl>): void;
1142
964
  /**
1143
965
  * Retrieves ACL entries on the specified bucket.
1144
- * @example
1145
- * ```js
1146
- * // Before running the sample:
1147
- * // - Enable the API at:
1148
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1149
- * // - Login into gcloud by running:
1150
- * // `$ gcloud auth application-default login`
1151
- * // - Install the npm module by running:
1152
- * // `$ npm install googleapis`
1153
- *
1154
- * const {google} = require('googleapis');
1155
- * const storage = google.storage('v1');
1156
- *
1157
- * async function main() {
1158
- * const auth = new google.auth.GoogleAuth({
1159
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1160
- * scopes: [
1161
- * 'https://www.googleapis.com/auth/cloud-platform',
1162
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1163
- * ],
1164
- * });
1165
- *
1166
- * // Acquire an auth client, and bind it to all future calls
1167
- * const authClient = await auth.getClient();
1168
- * google.options({auth: authClient});
1169
- *
1170
- * // Do the magic
1171
- * const res = await storage.bucketAccessControls.list({
1172
- * // Name of a bucket.
1173
- * bucket: 'placeholder-value',
1174
- * // The project to be billed for this request. Required for Requester Pays buckets.
1175
- * userProject: 'placeholder-value',
1176
- * });
1177
- * console.log(res.data);
1178
- *
1179
- * // Example response
1180
- * // {
1181
- * // "items": [],
1182
- * // "kind": "my_kind"
1183
- * // }
1184
- * }
1185
- *
1186
- * main().catch(e => {
1187
- * console.error(e);
1188
- * throw e;
1189
- * });
1190
- *
1191
- * ```
1192
966
  *
1193
967
  * @param params - Parameters for request
1194
968
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1203,83 +977,6 @@ export declare namespace storage_v1 {
1203
977
  list(callback: BodyResponseCallback<Schema$BucketAccessControls>): void;
1204
978
  /**
1205
979
  * Patches an ACL entry on the specified bucket.
1206
- * @example
1207
- * ```js
1208
- * // Before running the sample:
1209
- * // - Enable the API at:
1210
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1211
- * // - Login into gcloud by running:
1212
- * // `$ gcloud auth application-default login`
1213
- * // - Install the npm module by running:
1214
- * // `$ npm install googleapis`
1215
- *
1216
- * const {google} = require('googleapis');
1217
- * const storage = google.storage('v1');
1218
- *
1219
- * async function main() {
1220
- * const auth = new google.auth.GoogleAuth({
1221
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1222
- * scopes: [
1223
- * 'https://www.googleapis.com/auth/cloud-platform',
1224
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1225
- * ],
1226
- * });
1227
- *
1228
- * // Acquire an auth client, and bind it to all future calls
1229
- * const authClient = await auth.getClient();
1230
- * google.options({auth: authClient});
1231
- *
1232
- * // Do the magic
1233
- * const res = await storage.bucketAccessControls.patch({
1234
- * // Name of a bucket.
1235
- * bucket: 'placeholder-value',
1236
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
1237
- * entity: 'placeholder-value',
1238
- * // The project to be billed for this request. Required for Requester Pays buckets.
1239
- * userProject: 'placeholder-value',
1240
- *
1241
- * // Request body metadata
1242
- * requestBody: {
1243
- * // request body parameters
1244
- * // {
1245
- * // "bucket": "my_bucket",
1246
- * // "domain": "my_domain",
1247
- * // "email": "my_email",
1248
- * // "entity": "my_entity",
1249
- * // "entityId": "my_entityId",
1250
- * // "etag": "my_etag",
1251
- * // "id": "my_id",
1252
- * // "kind": "my_kind",
1253
- * // "projectTeam": {},
1254
- * // "role": "my_role",
1255
- * // "selfLink": "my_selfLink"
1256
- * // }
1257
- * },
1258
- * });
1259
- * console.log(res.data);
1260
- *
1261
- * // Example response
1262
- * // {
1263
- * // "bucket": "my_bucket",
1264
- * // "domain": "my_domain",
1265
- * // "email": "my_email",
1266
- * // "entity": "my_entity",
1267
- * // "entityId": "my_entityId",
1268
- * // "etag": "my_etag",
1269
- * // "id": "my_id",
1270
- * // "kind": "my_kind",
1271
- * // "projectTeam": {},
1272
- * // "role": "my_role",
1273
- * // "selfLink": "my_selfLink"
1274
- * // }
1275
- * }
1276
- *
1277
- * main().catch(e => {
1278
- * console.error(e);
1279
- * throw e;
1280
- * });
1281
- *
1282
- * ```
1283
980
  *
1284
981
  * @param params - Parameters for request
1285
982
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1294,83 +991,6 @@ export declare namespace storage_v1 {
1294
991
  patch(callback: BodyResponseCallback<Schema$BucketAccessControl>): void;
1295
992
  /**
1296
993
  * Updates an ACL entry on the specified bucket.
1297
- * @example
1298
- * ```js
1299
- * // Before running the sample:
1300
- * // - Enable the API at:
1301
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1302
- * // - Login into gcloud by running:
1303
- * // `$ gcloud auth application-default login`
1304
- * // - Install the npm module by running:
1305
- * // `$ npm install googleapis`
1306
- *
1307
- * const {google} = require('googleapis');
1308
- * const storage = google.storage('v1');
1309
- *
1310
- * async function main() {
1311
- * const auth = new google.auth.GoogleAuth({
1312
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1313
- * scopes: [
1314
- * 'https://www.googleapis.com/auth/cloud-platform',
1315
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1316
- * ],
1317
- * });
1318
- *
1319
- * // Acquire an auth client, and bind it to all future calls
1320
- * const authClient = await auth.getClient();
1321
- * google.options({auth: authClient});
1322
- *
1323
- * // Do the magic
1324
- * const res = await storage.bucketAccessControls.update({
1325
- * // Name of a bucket.
1326
- * bucket: 'placeholder-value',
1327
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
1328
- * entity: 'placeholder-value',
1329
- * // The project to be billed for this request. Required for Requester Pays buckets.
1330
- * userProject: 'placeholder-value',
1331
- *
1332
- * // Request body metadata
1333
- * requestBody: {
1334
- * // request body parameters
1335
- * // {
1336
- * // "bucket": "my_bucket",
1337
- * // "domain": "my_domain",
1338
- * // "email": "my_email",
1339
- * // "entity": "my_entity",
1340
- * // "entityId": "my_entityId",
1341
- * // "etag": "my_etag",
1342
- * // "id": "my_id",
1343
- * // "kind": "my_kind",
1344
- * // "projectTeam": {},
1345
- * // "role": "my_role",
1346
- * // "selfLink": "my_selfLink"
1347
- * // }
1348
- * },
1349
- * });
1350
- * console.log(res.data);
1351
- *
1352
- * // Example response
1353
- * // {
1354
- * // "bucket": "my_bucket",
1355
- * // "domain": "my_domain",
1356
- * // "email": "my_email",
1357
- * // "entity": "my_entity",
1358
- * // "entityId": "my_entityId",
1359
- * // "etag": "my_etag",
1360
- * // "id": "my_id",
1361
- * // "kind": "my_kind",
1362
- * // "projectTeam": {},
1363
- * // "role": "my_role",
1364
- * // "selfLink": "my_selfLink"
1365
- * // }
1366
- * }
1367
- *
1368
- * main().catch(e => {
1369
- * console.error(e);
1370
- * throw e;
1371
- * });
1372
- *
1373
- * ```
1374
994
  *
1375
995
  * @param params - Parameters for request
1376
996
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1477,53 +1097,6 @@ export declare namespace storage_v1 {
1477
1097
  constructor(context: APIRequestContext);
1478
1098
  /**
1479
1099
  * Permanently deletes an empty bucket.
1480
- * @example
1481
- * ```js
1482
- * // Before running the sample:
1483
- * // - Enable the API at:
1484
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1485
- * // - Login into gcloud by running:
1486
- * // `$ gcloud auth application-default login`
1487
- * // - Install the npm module by running:
1488
- * // `$ npm install googleapis`
1489
- *
1490
- * const {google} = require('googleapis');
1491
- * const storage = google.storage('v1');
1492
- *
1493
- * async function main() {
1494
- * const auth = new google.auth.GoogleAuth({
1495
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1496
- * scopes: [
1497
- * 'https://www.googleapis.com/auth/cloud-platform',
1498
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1499
- * 'https://www.googleapis.com/auth/devstorage.read_write',
1500
- * ],
1501
- * });
1502
- *
1503
- * // Acquire an auth client, and bind it to all future calls
1504
- * const authClient = await auth.getClient();
1505
- * google.options({auth: authClient});
1506
- *
1507
- * // Do the magic
1508
- * const res = await storage.buckets.delete({
1509
- * // Name of a bucket.
1510
- * bucket: 'placeholder-value',
1511
- * // If set, only deletes the bucket if its metageneration matches this value.
1512
- * ifMetagenerationMatch: 'placeholder-value',
1513
- * // If set, only deletes the bucket if its metageneration does not match this value.
1514
- * ifMetagenerationNotMatch: 'placeholder-value',
1515
- * // The project to be billed for this request. Required for Requester Pays buckets.
1516
- * userProject: 'placeholder-value',
1517
- * });
1518
- * console.log(res.data);
1519
- * }
1520
- *
1521
- * main().catch(e => {
1522
- * console.error(e);
1523
- * throw e;
1524
- * });
1525
- *
1526
- * ```
1527
1100
  *
1528
1101
  * @param params - Parameters for request
1529
1102
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1538,91 +1111,6 @@ export declare namespace storage_v1 {
1538
1111
  delete(callback: BodyResponseCallback<void>): void;
1539
1112
  /**
1540
1113
  * Returns metadata for the specified bucket.
1541
- * @example
1542
- * ```js
1543
- * // Before running the sample:
1544
- * // - Enable the API at:
1545
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1546
- * // - Login into gcloud by running:
1547
- * // `$ gcloud auth application-default login`
1548
- * // - Install the npm module by running:
1549
- * // `$ npm install googleapis`
1550
- *
1551
- * const {google} = require('googleapis');
1552
- * const storage = google.storage('v1');
1553
- *
1554
- * async function main() {
1555
- * const auth = new google.auth.GoogleAuth({
1556
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1557
- * scopes: [
1558
- * 'https://www.googleapis.com/auth/cloud-platform',
1559
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
1560
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1561
- * 'https://www.googleapis.com/auth/devstorage.read_only',
1562
- * 'https://www.googleapis.com/auth/devstorage.read_write',
1563
- * ],
1564
- * });
1565
- *
1566
- * // Acquire an auth client, and bind it to all future calls
1567
- * const authClient = await auth.getClient();
1568
- * google.options({auth: authClient});
1569
- *
1570
- * // Do the magic
1571
- * const res = await storage.buckets.get({
1572
- * // Name of a bucket.
1573
- * bucket: 'placeholder-value',
1574
- * // Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
1575
- * ifMetagenerationMatch: 'placeholder-value',
1576
- * // Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
1577
- * ifMetagenerationNotMatch: 'placeholder-value',
1578
- * // Set of properties to return. Defaults to noAcl.
1579
- * projection: 'placeholder-value',
1580
- * // The project to be billed for this request. Required for Requester Pays buckets.
1581
- * userProject: 'placeholder-value',
1582
- * });
1583
- * console.log(res.data);
1584
- *
1585
- * // Example response
1586
- * // {
1587
- * // "acl": [],
1588
- * // "autoclass": {},
1589
- * // "billing": {},
1590
- * // "cors": [],
1591
- * // "customPlacementConfig": {},
1592
- * // "defaultEventBasedHold": false,
1593
- * // "defaultObjectAcl": [],
1594
- * // "encryption": {},
1595
- * // "etag": "my_etag",
1596
- * // "iamConfiguration": {},
1597
- * // "id": "my_id",
1598
- * // "kind": "my_kind",
1599
- * // "labels": {},
1600
- * // "lifecycle": {},
1601
- * // "location": "my_location",
1602
- * // "locationType": "my_locationType",
1603
- * // "logging": {},
1604
- * // "metageneration": "my_metageneration",
1605
- * // "name": "my_name",
1606
- * // "owner": {},
1607
- * // "projectNumber": "my_projectNumber",
1608
- * // "retentionPolicy": {},
1609
- * // "rpo": "my_rpo",
1610
- * // "satisfiesPZS": false,
1611
- * // "selfLink": "my_selfLink",
1612
- * // "storageClass": "my_storageClass",
1613
- * // "timeCreated": "my_timeCreated",
1614
- * // "updated": "my_updated",
1615
- * // "versioning": {},
1616
- * // "website": {}
1617
- * // }
1618
- * }
1619
- *
1620
- * main().catch(e => {
1621
- * console.error(e);
1622
- * throw e;
1623
- * });
1624
- *
1625
- * ```
1626
1114
  *
1627
1115
  * @param params - Parameters for request
1628
1116
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1637,59 +1125,6 @@ export declare namespace storage_v1 {
1637
1125
  get(callback: BodyResponseCallback<Schema$Bucket>): void;
1638
1126
  /**
1639
1127
  * Returns an IAM policy for the specified bucket.
1640
- * @example
1641
- * ```js
1642
- * // Before running the sample:
1643
- * // - Enable the API at:
1644
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1645
- * // - Login into gcloud by running:
1646
- * // `$ gcloud auth application-default login`
1647
- * // - Install the npm module by running:
1648
- * // `$ npm install googleapis`
1649
- *
1650
- * const {google} = require('googleapis');
1651
- * const storage = google.storage('v1');
1652
- *
1653
- * async function main() {
1654
- * const auth = new google.auth.GoogleAuth({
1655
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1656
- * scopes: [
1657
- * 'https://www.googleapis.com/auth/cloud-platform',
1658
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1659
- * ],
1660
- * });
1661
- *
1662
- * // Acquire an auth client, and bind it to all future calls
1663
- * const authClient = await auth.getClient();
1664
- * google.options({auth: authClient});
1665
- *
1666
- * // Do the magic
1667
- * const res = await storage.buckets.getIamPolicy({
1668
- * // Name of a bucket.
1669
- * bucket: 'placeholder-value',
1670
- * // The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.
1671
- * optionsRequestedPolicyVersion: 'placeholder-value',
1672
- * // The project to be billed for this request. Required for Requester Pays buckets.
1673
- * userProject: 'placeholder-value',
1674
- * });
1675
- * console.log(res.data);
1676
- *
1677
- * // Example response
1678
- * // {
1679
- * // "bindings": [],
1680
- * // "etag": "my_etag",
1681
- * // "kind": "my_kind",
1682
- * // "resourceId": "my_resourceId",
1683
- * // "version": 0
1684
- * // }
1685
- * }
1686
- *
1687
- * main().catch(e => {
1688
- * console.error(e);
1689
- * throw e;
1690
- * });
1691
- *
1692
- * ```
1693
1128
  *
1694
1129
  * @param params - Parameters for request
1695
1130
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1704,126 +1139,6 @@ export declare namespace storage_v1 {
1704
1139
  getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
1705
1140
  /**
1706
1141
  * Creates a new bucket.
1707
- * @example
1708
- * ```js
1709
- * // Before running the sample:
1710
- * // - Enable the API at:
1711
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1712
- * // - Login into gcloud by running:
1713
- * // `$ gcloud auth application-default login`
1714
- * // - Install the npm module by running:
1715
- * // `$ npm install googleapis`
1716
- *
1717
- * const {google} = require('googleapis');
1718
- * const storage = google.storage('v1');
1719
- *
1720
- * async function main() {
1721
- * const auth = new google.auth.GoogleAuth({
1722
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1723
- * scopes: [
1724
- * 'https://www.googleapis.com/auth/cloud-platform',
1725
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1726
- * 'https://www.googleapis.com/auth/devstorage.read_write',
1727
- * ],
1728
- * });
1729
- *
1730
- * // Acquire an auth client, and bind it to all future calls
1731
- * const authClient = await auth.getClient();
1732
- * google.options({auth: authClient});
1733
- *
1734
- * // Do the magic
1735
- * const res = await storage.buckets.insert({
1736
- * // Apply a predefined set of access controls to this bucket.
1737
- * predefinedAcl: 'placeholder-value',
1738
- * // Apply a predefined set of default object access controls to this bucket.
1739
- * predefinedDefaultObjectAcl: 'placeholder-value',
1740
- * // A valid API project identifier.
1741
- * project: 'placeholder-value',
1742
- * // Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
1743
- * projection: 'placeholder-value',
1744
- * // The project to be billed for this request.
1745
- * userProject: 'placeholder-value',
1746
- *
1747
- * // Request body metadata
1748
- * requestBody: {
1749
- * // request body parameters
1750
- * // {
1751
- * // "acl": [],
1752
- * // "autoclass": {},
1753
- * // "billing": {},
1754
- * // "cors": [],
1755
- * // "customPlacementConfig": {},
1756
- * // "defaultEventBasedHold": false,
1757
- * // "defaultObjectAcl": [],
1758
- * // "encryption": {},
1759
- * // "etag": "my_etag",
1760
- * // "iamConfiguration": {},
1761
- * // "id": "my_id",
1762
- * // "kind": "my_kind",
1763
- * // "labels": {},
1764
- * // "lifecycle": {},
1765
- * // "location": "my_location",
1766
- * // "locationType": "my_locationType",
1767
- * // "logging": {},
1768
- * // "metageneration": "my_metageneration",
1769
- * // "name": "my_name",
1770
- * // "owner": {},
1771
- * // "projectNumber": "my_projectNumber",
1772
- * // "retentionPolicy": {},
1773
- * // "rpo": "my_rpo",
1774
- * // "satisfiesPZS": false,
1775
- * // "selfLink": "my_selfLink",
1776
- * // "storageClass": "my_storageClass",
1777
- * // "timeCreated": "my_timeCreated",
1778
- * // "updated": "my_updated",
1779
- * // "versioning": {},
1780
- * // "website": {}
1781
- * // }
1782
- * },
1783
- * });
1784
- * console.log(res.data);
1785
- *
1786
- * // Example response
1787
- * // {
1788
- * // "acl": [],
1789
- * // "autoclass": {},
1790
- * // "billing": {},
1791
- * // "cors": [],
1792
- * // "customPlacementConfig": {},
1793
- * // "defaultEventBasedHold": false,
1794
- * // "defaultObjectAcl": [],
1795
- * // "encryption": {},
1796
- * // "etag": "my_etag",
1797
- * // "iamConfiguration": {},
1798
- * // "id": "my_id",
1799
- * // "kind": "my_kind",
1800
- * // "labels": {},
1801
- * // "lifecycle": {},
1802
- * // "location": "my_location",
1803
- * // "locationType": "my_locationType",
1804
- * // "logging": {},
1805
- * // "metageneration": "my_metageneration",
1806
- * // "name": "my_name",
1807
- * // "owner": {},
1808
- * // "projectNumber": "my_projectNumber",
1809
- * // "retentionPolicy": {},
1810
- * // "rpo": "my_rpo",
1811
- * // "satisfiesPZS": false,
1812
- * // "selfLink": "my_selfLink",
1813
- * // "storageClass": "my_storageClass",
1814
- * // "timeCreated": "my_timeCreated",
1815
- * // "updated": "my_updated",
1816
- * // "versioning": {},
1817
- * // "website": {}
1818
- * // }
1819
- * }
1820
- *
1821
- * main().catch(e => {
1822
- * console.error(e);
1823
- * throw e;
1824
- * });
1825
- *
1826
- * ```
1827
1142
  *
1828
1143
  * @param params - Parameters for request
1829
1144
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1838,66 +1153,6 @@ export declare namespace storage_v1 {
1838
1153
  insert(callback: BodyResponseCallback<Schema$Bucket>): void;
1839
1154
  /**
1840
1155
  * Retrieves a list of buckets for a given project.
1841
- * @example
1842
- * ```js
1843
- * // Before running the sample:
1844
- * // - Enable the API at:
1845
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1846
- * // - Login into gcloud by running:
1847
- * // `$ gcloud auth application-default login`
1848
- * // - Install the npm module by running:
1849
- * // `$ npm install googleapis`
1850
- *
1851
- * const {google} = require('googleapis');
1852
- * const storage = google.storage('v1');
1853
- *
1854
- * async function main() {
1855
- * const auth = new google.auth.GoogleAuth({
1856
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1857
- * scopes: [
1858
- * 'https://www.googleapis.com/auth/cloud-platform',
1859
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
1860
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1861
- * 'https://www.googleapis.com/auth/devstorage.read_only',
1862
- * 'https://www.googleapis.com/auth/devstorage.read_write',
1863
- * ],
1864
- * });
1865
- *
1866
- * // Acquire an auth client, and bind it to all future calls
1867
- * const authClient = await auth.getClient();
1868
- * google.options({auth: authClient});
1869
- *
1870
- * // Do the magic
1871
- * const res = await storage.buckets.list({
1872
- * // Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
1873
- * maxResults: 'placeholder-value',
1874
- * // A previously-returned page token representing part of the larger set of results to view.
1875
- * pageToken: 'placeholder-value',
1876
- * // Filter results to buckets whose names begin with this prefix.
1877
- * prefix: 'placeholder-value',
1878
- * // A valid API project identifier.
1879
- * project: 'placeholder-value',
1880
- * // Set of properties to return. Defaults to noAcl.
1881
- * projection: 'placeholder-value',
1882
- * // The project to be billed for this request.
1883
- * userProject: 'placeholder-value',
1884
- * });
1885
- * console.log(res.data);
1886
- *
1887
- * // Example response
1888
- * // {
1889
- * // "items": [],
1890
- * // "kind": "my_kind",
1891
- * // "nextPageToken": "my_nextPageToken"
1892
- * // }
1893
- * }
1894
- *
1895
- * main().catch(e => {
1896
- * console.error(e);
1897
- * throw e;
1898
- * });
1899
- *
1900
- * ```
1901
1156
  *
1902
1157
  * @param params - Parameters for request
1903
1158
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -1912,85 +1167,6 @@ export declare namespace storage_v1 {
1912
1167
  list(callback: BodyResponseCallback<Schema$Buckets>): void;
1913
1168
  /**
1914
1169
  * Locks retention policy on a bucket.
1915
- * @example
1916
- * ```js
1917
- * // Before running the sample:
1918
- * // - Enable the API at:
1919
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
1920
- * // - Login into gcloud by running:
1921
- * // `$ gcloud auth application-default login`
1922
- * // - Install the npm module by running:
1923
- * // `$ npm install googleapis`
1924
- *
1925
- * const {google} = require('googleapis');
1926
- * const storage = google.storage('v1');
1927
- *
1928
- * async function main() {
1929
- * const auth = new google.auth.GoogleAuth({
1930
- * // Scopes can be specified either as an array or as a single, space-delimited string.
1931
- * scopes: [
1932
- * 'https://www.googleapis.com/auth/cloud-platform',
1933
- * 'https://www.googleapis.com/auth/devstorage.full_control',
1934
- * 'https://www.googleapis.com/auth/devstorage.read_write',
1935
- * ],
1936
- * });
1937
- *
1938
- * // Acquire an auth client, and bind it to all future calls
1939
- * const authClient = await auth.getClient();
1940
- * google.options({auth: authClient});
1941
- *
1942
- * // Do the magic
1943
- * const res = await storage.buckets.lockRetentionPolicy({
1944
- * // Name of a bucket.
1945
- * bucket: 'placeholder-value',
1946
- * // Makes the operation conditional on whether bucket's current metageneration matches the given value.
1947
- * ifMetagenerationMatch: 'placeholder-value',
1948
- * // The project to be billed for this request. Required for Requester Pays buckets.
1949
- * userProject: 'placeholder-value',
1950
- * });
1951
- * console.log(res.data);
1952
- *
1953
- * // Example response
1954
- * // {
1955
- * // "acl": [],
1956
- * // "autoclass": {},
1957
- * // "billing": {},
1958
- * // "cors": [],
1959
- * // "customPlacementConfig": {},
1960
- * // "defaultEventBasedHold": false,
1961
- * // "defaultObjectAcl": [],
1962
- * // "encryption": {},
1963
- * // "etag": "my_etag",
1964
- * // "iamConfiguration": {},
1965
- * // "id": "my_id",
1966
- * // "kind": "my_kind",
1967
- * // "labels": {},
1968
- * // "lifecycle": {},
1969
- * // "location": "my_location",
1970
- * // "locationType": "my_locationType",
1971
- * // "logging": {},
1972
- * // "metageneration": "my_metageneration",
1973
- * // "name": "my_name",
1974
- * // "owner": {},
1975
- * // "projectNumber": "my_projectNumber",
1976
- * // "retentionPolicy": {},
1977
- * // "rpo": "my_rpo",
1978
- * // "satisfiesPZS": false,
1979
- * // "selfLink": "my_selfLink",
1980
- * // "storageClass": "my_storageClass",
1981
- * // "timeCreated": "my_timeCreated",
1982
- * // "updated": "my_updated",
1983
- * // "versioning": {},
1984
- * // "website": {}
1985
- * // }
1986
- * }
1987
- *
1988
- * main().catch(e => {
1989
- * console.error(e);
1990
- * throw e;
1991
- * });
1992
- *
1993
- * ```
1994
1170
  *
1995
1171
  * @param params - Parameters for request
1996
1172
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2005,129 +1181,6 @@ export declare namespace storage_v1 {
2005
1181
  lockRetentionPolicy(callback: BodyResponseCallback<Schema$Bucket>): void;
2006
1182
  /**
2007
1183
  * Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
2008
- * @example
2009
- * ```js
2010
- * // Before running the sample:
2011
- * // - Enable the API at:
2012
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2013
- * // - Login into gcloud by running:
2014
- * // `$ gcloud auth application-default login`
2015
- * // - Install the npm module by running:
2016
- * // `$ npm install googleapis`
2017
- *
2018
- * const {google} = require('googleapis');
2019
- * const storage = google.storage('v1');
2020
- *
2021
- * async function main() {
2022
- * const auth = new google.auth.GoogleAuth({
2023
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2024
- * scopes: [
2025
- * 'https://www.googleapis.com/auth/cloud-platform',
2026
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2027
- * ],
2028
- * });
2029
- *
2030
- * // Acquire an auth client, and bind it to all future calls
2031
- * const authClient = await auth.getClient();
2032
- * google.options({auth: authClient});
2033
- *
2034
- * // Do the magic
2035
- * const res = await storage.buckets.patch({
2036
- * // Name of a bucket.
2037
- * bucket: 'placeholder-value',
2038
- * // Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
2039
- * ifMetagenerationMatch: 'placeholder-value',
2040
- * // Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
2041
- * ifMetagenerationNotMatch: 'placeholder-value',
2042
- * // Apply a predefined set of access controls to this bucket.
2043
- * predefinedAcl: 'placeholder-value',
2044
- * // Apply a predefined set of default object access controls to this bucket.
2045
- * predefinedDefaultObjectAcl: 'placeholder-value',
2046
- * // Set of properties to return. Defaults to full.
2047
- * projection: 'placeholder-value',
2048
- * // The project to be billed for this request. Required for Requester Pays buckets.
2049
- * userProject: 'placeholder-value',
2050
- *
2051
- * // Request body metadata
2052
- * requestBody: {
2053
- * // request body parameters
2054
- * // {
2055
- * // "acl": [],
2056
- * // "autoclass": {},
2057
- * // "billing": {},
2058
- * // "cors": [],
2059
- * // "customPlacementConfig": {},
2060
- * // "defaultEventBasedHold": false,
2061
- * // "defaultObjectAcl": [],
2062
- * // "encryption": {},
2063
- * // "etag": "my_etag",
2064
- * // "iamConfiguration": {},
2065
- * // "id": "my_id",
2066
- * // "kind": "my_kind",
2067
- * // "labels": {},
2068
- * // "lifecycle": {},
2069
- * // "location": "my_location",
2070
- * // "locationType": "my_locationType",
2071
- * // "logging": {},
2072
- * // "metageneration": "my_metageneration",
2073
- * // "name": "my_name",
2074
- * // "owner": {},
2075
- * // "projectNumber": "my_projectNumber",
2076
- * // "retentionPolicy": {},
2077
- * // "rpo": "my_rpo",
2078
- * // "satisfiesPZS": false,
2079
- * // "selfLink": "my_selfLink",
2080
- * // "storageClass": "my_storageClass",
2081
- * // "timeCreated": "my_timeCreated",
2082
- * // "updated": "my_updated",
2083
- * // "versioning": {},
2084
- * // "website": {}
2085
- * // }
2086
- * },
2087
- * });
2088
- * console.log(res.data);
2089
- *
2090
- * // Example response
2091
- * // {
2092
- * // "acl": [],
2093
- * // "autoclass": {},
2094
- * // "billing": {},
2095
- * // "cors": [],
2096
- * // "customPlacementConfig": {},
2097
- * // "defaultEventBasedHold": false,
2098
- * // "defaultObjectAcl": [],
2099
- * // "encryption": {},
2100
- * // "etag": "my_etag",
2101
- * // "iamConfiguration": {},
2102
- * // "id": "my_id",
2103
- * // "kind": "my_kind",
2104
- * // "labels": {},
2105
- * // "lifecycle": {},
2106
- * // "location": "my_location",
2107
- * // "locationType": "my_locationType",
2108
- * // "logging": {},
2109
- * // "metageneration": "my_metageneration",
2110
- * // "name": "my_name",
2111
- * // "owner": {},
2112
- * // "projectNumber": "my_projectNumber",
2113
- * // "retentionPolicy": {},
2114
- * // "rpo": "my_rpo",
2115
- * // "satisfiesPZS": false,
2116
- * // "selfLink": "my_selfLink",
2117
- * // "storageClass": "my_storageClass",
2118
- * // "timeCreated": "my_timeCreated",
2119
- * // "updated": "my_updated",
2120
- * // "versioning": {},
2121
- * // "website": {}
2122
- * // }
2123
- * }
2124
- *
2125
- * main().catch(e => {
2126
- * console.error(e);
2127
- * throw e;
2128
- * });
2129
- *
2130
- * ```
2131
1184
  *
2132
1185
  * @param params - Parameters for request
2133
1186
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2142,69 +1195,6 @@ export declare namespace storage_v1 {
2142
1195
  patch(callback: BodyResponseCallback<Schema$Bucket>): void;
2143
1196
  /**
2144
1197
  * Updates an IAM policy for the specified bucket.
2145
- * @example
2146
- * ```js
2147
- * // Before running the sample:
2148
- * // - Enable the API at:
2149
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2150
- * // - Login into gcloud by running:
2151
- * // `$ gcloud auth application-default login`
2152
- * // - Install the npm module by running:
2153
- * // `$ npm install googleapis`
2154
- *
2155
- * const {google} = require('googleapis');
2156
- * const storage = google.storage('v1');
2157
- *
2158
- * async function main() {
2159
- * const auth = new google.auth.GoogleAuth({
2160
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2161
- * scopes: [
2162
- * 'https://www.googleapis.com/auth/cloud-platform',
2163
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2164
- * ],
2165
- * });
2166
- *
2167
- * // Acquire an auth client, and bind it to all future calls
2168
- * const authClient = await auth.getClient();
2169
- * google.options({auth: authClient});
2170
- *
2171
- * // Do the magic
2172
- * const res = await storage.buckets.setIamPolicy({
2173
- * // Name of a bucket.
2174
- * bucket: 'placeholder-value',
2175
- * // The project to be billed for this request. Required for Requester Pays buckets.
2176
- * userProject: 'placeholder-value',
2177
- *
2178
- * // Request body metadata
2179
- * requestBody: {
2180
- * // request body parameters
2181
- * // {
2182
- * // "bindings": [],
2183
- * // "etag": "my_etag",
2184
- * // "kind": "my_kind",
2185
- * // "resourceId": "my_resourceId",
2186
- * // "version": 0
2187
- * // }
2188
- * },
2189
- * });
2190
- * console.log(res.data);
2191
- *
2192
- * // Example response
2193
- * // {
2194
- * // "bindings": [],
2195
- * // "etag": "my_etag",
2196
- * // "kind": "my_kind",
2197
- * // "resourceId": "my_resourceId",
2198
- * // "version": 0
2199
- * // }
2200
- * }
2201
- *
2202
- * main().catch(e => {
2203
- * console.error(e);
2204
- * throw e;
2205
- * });
2206
- *
2207
- * ```
2208
1198
  *
2209
1199
  * @param params - Parameters for request
2210
1200
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2219,59 +1209,6 @@ export declare namespace storage_v1 {
2219
1209
  setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
2220
1210
  /**
2221
1211
  * Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
2222
- * @example
2223
- * ```js
2224
- * // Before running the sample:
2225
- * // - Enable the API at:
2226
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2227
- * // - Login into gcloud by running:
2228
- * // `$ gcloud auth application-default login`
2229
- * // - Install the npm module by running:
2230
- * // `$ npm install googleapis`
2231
- *
2232
- * const {google} = require('googleapis');
2233
- * const storage = google.storage('v1');
2234
- *
2235
- * async function main() {
2236
- * const auth = new google.auth.GoogleAuth({
2237
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2238
- * scopes: [
2239
- * 'https://www.googleapis.com/auth/cloud-platform',
2240
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
2241
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2242
- * 'https://www.googleapis.com/auth/devstorage.read_only',
2243
- * 'https://www.googleapis.com/auth/devstorage.read_write',
2244
- * ],
2245
- * });
2246
- *
2247
- * // Acquire an auth client, and bind it to all future calls
2248
- * const authClient = await auth.getClient();
2249
- * google.options({auth: authClient});
2250
- *
2251
- * // Do the magic
2252
- * const res = await storage.buckets.testIamPermissions({
2253
- * // Name of a bucket.
2254
- * bucket: 'placeholder-value',
2255
- * // Permissions to test.
2256
- * permissions: 'placeholder-value',
2257
- * // The project to be billed for this request. Required for Requester Pays buckets.
2258
- * userProject: 'placeholder-value',
2259
- * });
2260
- * console.log(res.data);
2261
- *
2262
- * // Example response
2263
- * // {
2264
- * // "kind": "my_kind",
2265
- * // "permissions": []
2266
- * // }
2267
- * }
2268
- *
2269
- * main().catch(e => {
2270
- * console.error(e);
2271
- * throw e;
2272
- * });
2273
- *
2274
- * ```
2275
1212
  *
2276
1213
  * @param params - Parameters for request
2277
1214
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2286,129 +1223,6 @@ export declare namespace storage_v1 {
2286
1223
  testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
2287
1224
  /**
2288
1225
  * Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
2289
- * @example
2290
- * ```js
2291
- * // Before running the sample:
2292
- * // - Enable the API at:
2293
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2294
- * // - Login into gcloud by running:
2295
- * // `$ gcloud auth application-default login`
2296
- * // - Install the npm module by running:
2297
- * // `$ npm install googleapis`
2298
- *
2299
- * const {google} = require('googleapis');
2300
- * const storage = google.storage('v1');
2301
- *
2302
- * async function main() {
2303
- * const auth = new google.auth.GoogleAuth({
2304
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2305
- * scopes: [
2306
- * 'https://www.googleapis.com/auth/cloud-platform',
2307
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2308
- * ],
2309
- * });
2310
- *
2311
- * // Acquire an auth client, and bind it to all future calls
2312
- * const authClient = await auth.getClient();
2313
- * google.options({auth: authClient});
2314
- *
2315
- * // Do the magic
2316
- * const res = await storage.buckets.update({
2317
- * // Name of a bucket.
2318
- * bucket: 'placeholder-value',
2319
- * // Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
2320
- * ifMetagenerationMatch: 'placeholder-value',
2321
- * // Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
2322
- * ifMetagenerationNotMatch: 'placeholder-value',
2323
- * // Apply a predefined set of access controls to this bucket.
2324
- * predefinedAcl: 'placeholder-value',
2325
- * // Apply a predefined set of default object access controls to this bucket.
2326
- * predefinedDefaultObjectAcl: 'placeholder-value',
2327
- * // Set of properties to return. Defaults to full.
2328
- * projection: 'placeholder-value',
2329
- * // The project to be billed for this request. Required for Requester Pays buckets.
2330
- * userProject: 'placeholder-value',
2331
- *
2332
- * // Request body metadata
2333
- * requestBody: {
2334
- * // request body parameters
2335
- * // {
2336
- * // "acl": [],
2337
- * // "autoclass": {},
2338
- * // "billing": {},
2339
- * // "cors": [],
2340
- * // "customPlacementConfig": {},
2341
- * // "defaultEventBasedHold": false,
2342
- * // "defaultObjectAcl": [],
2343
- * // "encryption": {},
2344
- * // "etag": "my_etag",
2345
- * // "iamConfiguration": {},
2346
- * // "id": "my_id",
2347
- * // "kind": "my_kind",
2348
- * // "labels": {},
2349
- * // "lifecycle": {},
2350
- * // "location": "my_location",
2351
- * // "locationType": "my_locationType",
2352
- * // "logging": {},
2353
- * // "metageneration": "my_metageneration",
2354
- * // "name": "my_name",
2355
- * // "owner": {},
2356
- * // "projectNumber": "my_projectNumber",
2357
- * // "retentionPolicy": {},
2358
- * // "rpo": "my_rpo",
2359
- * // "satisfiesPZS": false,
2360
- * // "selfLink": "my_selfLink",
2361
- * // "storageClass": "my_storageClass",
2362
- * // "timeCreated": "my_timeCreated",
2363
- * // "updated": "my_updated",
2364
- * // "versioning": {},
2365
- * // "website": {}
2366
- * // }
2367
- * },
2368
- * });
2369
- * console.log(res.data);
2370
- *
2371
- * // Example response
2372
- * // {
2373
- * // "acl": [],
2374
- * // "autoclass": {},
2375
- * // "billing": {},
2376
- * // "cors": [],
2377
- * // "customPlacementConfig": {},
2378
- * // "defaultEventBasedHold": false,
2379
- * // "defaultObjectAcl": [],
2380
- * // "encryption": {},
2381
- * // "etag": "my_etag",
2382
- * // "iamConfiguration": {},
2383
- * // "id": "my_id",
2384
- * // "kind": "my_kind",
2385
- * // "labels": {},
2386
- * // "lifecycle": {},
2387
- * // "location": "my_location",
2388
- * // "locationType": "my_locationType",
2389
- * // "logging": {},
2390
- * // "metageneration": "my_metageneration",
2391
- * // "name": "my_name",
2392
- * // "owner": {},
2393
- * // "projectNumber": "my_projectNumber",
2394
- * // "retentionPolicy": {},
2395
- * // "rpo": "my_rpo",
2396
- * // "satisfiesPZS": false,
2397
- * // "selfLink": "my_selfLink",
2398
- * // "storageClass": "my_storageClass",
2399
- * // "timeCreated": "my_timeCreated",
2400
- * // "updated": "my_updated",
2401
- * // "versioning": {},
2402
- * // "website": {}
2403
- * // }
2404
- * }
2405
- *
2406
- * main().catch(e => {
2407
- * console.error(e);
2408
- * throw e;
2409
- * });
2410
- *
2411
- * ```
2412
1226
  *
2413
1227
  * @param params - Parameters for request
2414
1228
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2643,63 +1457,6 @@ export declare namespace storage_v1 {
2643
1457
  constructor(context: APIRequestContext);
2644
1458
  /**
2645
1459
  * Stop watching resources through this channel
2646
- * @example
2647
- * ```js
2648
- * // Before running the sample:
2649
- * // - Enable the API at:
2650
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2651
- * // - Login into gcloud by running:
2652
- * // `$ gcloud auth application-default login`
2653
- * // - Install the npm module by running:
2654
- * // `$ npm install googleapis`
2655
- *
2656
- * const {google} = require('googleapis');
2657
- * const storage = google.storage('v1');
2658
- *
2659
- * async function main() {
2660
- * const auth = new google.auth.GoogleAuth({
2661
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2662
- * scopes: [
2663
- * 'https://www.googleapis.com/auth/cloud-platform',
2664
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
2665
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2666
- * 'https://www.googleapis.com/auth/devstorage.read_only',
2667
- * 'https://www.googleapis.com/auth/devstorage.read_write',
2668
- * ],
2669
- * });
2670
- *
2671
- * // Acquire an auth client, and bind it to all future calls
2672
- * const authClient = await auth.getClient();
2673
- * google.options({auth: authClient});
2674
- *
2675
- * // Do the magic
2676
- * const res = await storage.channels.stop({
2677
- * // Request body metadata
2678
- * requestBody: {
2679
- * // request body parameters
2680
- * // {
2681
- * // "address": "my_address",
2682
- * // "expiration": "my_expiration",
2683
- * // "id": "my_id",
2684
- * // "kind": "my_kind",
2685
- * // "params": {},
2686
- * // "payload": false,
2687
- * // "resourceId": "my_resourceId",
2688
- * // "resourceUri": "my_resourceUri",
2689
- * // "token": "my_token",
2690
- * // "type": "my_type"
2691
- * // }
2692
- * },
2693
- * });
2694
- * console.log(res.data);
2695
- * }
2696
- *
2697
- * main().catch(e => {
2698
- * console.error(e);
2699
- * throw e;
2700
- * });
2701
- *
2702
- * ```
2703
1460
  *
2704
1461
  * @param params - Parameters for request
2705
1462
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2724,50 +1481,6 @@ export declare namespace storage_v1 {
2724
1481
  constructor(context: APIRequestContext);
2725
1482
  /**
2726
1483
  * Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
2727
- * @example
2728
- * ```js
2729
- * // Before running the sample:
2730
- * // - Enable the API at:
2731
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2732
- * // - Login into gcloud by running:
2733
- * // `$ gcloud auth application-default login`
2734
- * // - Install the npm module by running:
2735
- * // `$ npm install googleapis`
2736
- *
2737
- * const {google} = require('googleapis');
2738
- * const storage = google.storage('v1');
2739
- *
2740
- * async function main() {
2741
- * const auth = new google.auth.GoogleAuth({
2742
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2743
- * scopes: [
2744
- * 'https://www.googleapis.com/auth/cloud-platform',
2745
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2746
- * ],
2747
- * });
2748
- *
2749
- * // Acquire an auth client, and bind it to all future calls
2750
- * const authClient = await auth.getClient();
2751
- * google.options({auth: authClient});
2752
- *
2753
- * // Do the magic
2754
- * const res = await storage.defaultObjectAccessControls.delete({
2755
- * // Name of a bucket.
2756
- * bucket: 'placeholder-value',
2757
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
2758
- * entity: 'placeholder-value',
2759
- * // The project to be billed for this request. Required for Requester Pays buckets.
2760
- * userProject: 'placeholder-value',
2761
- * });
2762
- * console.log(res.data);
2763
- * }
2764
- *
2765
- * main().catch(e => {
2766
- * console.error(e);
2767
- * throw e;
2768
- * });
2769
- *
2770
- * ```
2771
1484
  *
2772
1485
  * @param params - Parameters for request
2773
1486
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2782,67 +1495,6 @@ export declare namespace storage_v1 {
2782
1495
  delete(callback: BodyResponseCallback<void>): void;
2783
1496
  /**
2784
1497
  * Returns the default object ACL entry for the specified entity on the specified bucket.
2785
- * @example
2786
- * ```js
2787
- * // Before running the sample:
2788
- * // - Enable the API at:
2789
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2790
- * // - Login into gcloud by running:
2791
- * // `$ gcloud auth application-default login`
2792
- * // - Install the npm module by running:
2793
- * // `$ npm install googleapis`
2794
- *
2795
- * const {google} = require('googleapis');
2796
- * const storage = google.storage('v1');
2797
- *
2798
- * async function main() {
2799
- * const auth = new google.auth.GoogleAuth({
2800
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2801
- * scopes: [
2802
- * 'https://www.googleapis.com/auth/cloud-platform',
2803
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2804
- * ],
2805
- * });
2806
- *
2807
- * // Acquire an auth client, and bind it to all future calls
2808
- * const authClient = await auth.getClient();
2809
- * google.options({auth: authClient});
2810
- *
2811
- * // Do the magic
2812
- * const res = await storage.defaultObjectAccessControls.get({
2813
- * // Name of a bucket.
2814
- * bucket: 'placeholder-value',
2815
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
2816
- * entity: 'placeholder-value',
2817
- * // The project to be billed for this request. Required for Requester Pays buckets.
2818
- * userProject: 'placeholder-value',
2819
- * });
2820
- * console.log(res.data);
2821
- *
2822
- * // Example response
2823
- * // {
2824
- * // "bucket": "my_bucket",
2825
- * // "domain": "my_domain",
2826
- * // "email": "my_email",
2827
- * // "entity": "my_entity",
2828
- * // "entityId": "my_entityId",
2829
- * // "etag": "my_etag",
2830
- * // "generation": "my_generation",
2831
- * // "id": "my_id",
2832
- * // "kind": "my_kind",
2833
- * // "object": "my_object",
2834
- * // "projectTeam": {},
2835
- * // "role": "my_role",
2836
- * // "selfLink": "my_selfLink"
2837
- * // }
2838
- * }
2839
- *
2840
- * main().catch(e => {
2841
- * console.error(e);
2842
- * throw e;
2843
- * });
2844
- *
2845
- * ```
2846
1498
  *
2847
1499
  * @param params - Parameters for request
2848
1500
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2857,85 +1509,6 @@ export declare namespace storage_v1 {
2857
1509
  get(callback: BodyResponseCallback<Schema$ObjectAccessControl>): void;
2858
1510
  /**
2859
1511
  * Creates a new default object ACL entry on the specified bucket.
2860
- * @example
2861
- * ```js
2862
- * // Before running the sample:
2863
- * // - Enable the API at:
2864
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2865
- * // - Login into gcloud by running:
2866
- * // `$ gcloud auth application-default login`
2867
- * // - Install the npm module by running:
2868
- * // `$ npm install googleapis`
2869
- *
2870
- * const {google} = require('googleapis');
2871
- * const storage = google.storage('v1');
2872
- *
2873
- * async function main() {
2874
- * const auth = new google.auth.GoogleAuth({
2875
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2876
- * scopes: [
2877
- * 'https://www.googleapis.com/auth/cloud-platform',
2878
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2879
- * ],
2880
- * });
2881
- *
2882
- * // Acquire an auth client, and bind it to all future calls
2883
- * const authClient = await auth.getClient();
2884
- * google.options({auth: authClient});
2885
- *
2886
- * // Do the magic
2887
- * const res = await storage.defaultObjectAccessControls.insert({
2888
- * // Name of a bucket.
2889
- * bucket: 'placeholder-value',
2890
- * // The project to be billed for this request. Required for Requester Pays buckets.
2891
- * userProject: 'placeholder-value',
2892
- *
2893
- * // Request body metadata
2894
- * requestBody: {
2895
- * // request body parameters
2896
- * // {
2897
- * // "bucket": "my_bucket",
2898
- * // "domain": "my_domain",
2899
- * // "email": "my_email",
2900
- * // "entity": "my_entity",
2901
- * // "entityId": "my_entityId",
2902
- * // "etag": "my_etag",
2903
- * // "generation": "my_generation",
2904
- * // "id": "my_id",
2905
- * // "kind": "my_kind",
2906
- * // "object": "my_object",
2907
- * // "projectTeam": {},
2908
- * // "role": "my_role",
2909
- * // "selfLink": "my_selfLink"
2910
- * // }
2911
- * },
2912
- * });
2913
- * console.log(res.data);
2914
- *
2915
- * // Example response
2916
- * // {
2917
- * // "bucket": "my_bucket",
2918
- * // "domain": "my_domain",
2919
- * // "email": "my_email",
2920
- * // "entity": "my_entity",
2921
- * // "entityId": "my_entityId",
2922
- * // "etag": "my_etag",
2923
- * // "generation": "my_generation",
2924
- * // "id": "my_id",
2925
- * // "kind": "my_kind",
2926
- * // "object": "my_object",
2927
- * // "projectTeam": {},
2928
- * // "role": "my_role",
2929
- * // "selfLink": "my_selfLink"
2930
- * // }
2931
- * }
2932
- *
2933
- * main().catch(e => {
2934
- * console.error(e);
2935
- * throw e;
2936
- * });
2937
- *
2938
- * ```
2939
1512
  *
2940
1513
  * @param params - Parameters for request
2941
1514
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -2950,58 +1523,6 @@ export declare namespace storage_v1 {
2950
1523
  insert(callback: BodyResponseCallback<Schema$ObjectAccessControl>): void;
2951
1524
  /**
2952
1525
  * Retrieves default object ACL entries on the specified bucket.
2953
- * @example
2954
- * ```js
2955
- * // Before running the sample:
2956
- * // - Enable the API at:
2957
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
2958
- * // - Login into gcloud by running:
2959
- * // `$ gcloud auth application-default login`
2960
- * // - Install the npm module by running:
2961
- * // `$ npm install googleapis`
2962
- *
2963
- * const {google} = require('googleapis');
2964
- * const storage = google.storage('v1');
2965
- *
2966
- * async function main() {
2967
- * const auth = new google.auth.GoogleAuth({
2968
- * // Scopes can be specified either as an array or as a single, space-delimited string.
2969
- * scopes: [
2970
- * 'https://www.googleapis.com/auth/cloud-platform',
2971
- * 'https://www.googleapis.com/auth/devstorage.full_control',
2972
- * ],
2973
- * });
2974
- *
2975
- * // Acquire an auth client, and bind it to all future calls
2976
- * const authClient = await auth.getClient();
2977
- * google.options({auth: authClient});
2978
- *
2979
- * // Do the magic
2980
- * const res = await storage.defaultObjectAccessControls.list({
2981
- * // Name of a bucket.
2982
- * bucket: 'placeholder-value',
2983
- * // If present, only return default ACL listing if the bucket's current metageneration matches this value.
2984
- * ifMetagenerationMatch: 'placeholder-value',
2985
- * // If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
2986
- * ifMetagenerationNotMatch: 'placeholder-value',
2987
- * // The project to be billed for this request. Required for Requester Pays buckets.
2988
- * userProject: 'placeholder-value',
2989
- * });
2990
- * console.log(res.data);
2991
- *
2992
- * // Example response
2993
- * // {
2994
- * // "items": [],
2995
- * // "kind": "my_kind"
2996
- * // }
2997
- * }
2998
- *
2999
- * main().catch(e => {
3000
- * console.error(e);
3001
- * throw e;
3002
- * });
3003
- *
3004
- * ```
3005
1526
  *
3006
1527
  * @param params - Parameters for request
3007
1528
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3016,87 +1537,6 @@ export declare namespace storage_v1 {
3016
1537
  list(callback: BodyResponseCallback<Schema$ObjectAccessControls>): void;
3017
1538
  /**
3018
1539
  * Patches a default object ACL entry on the specified bucket.
3019
- * @example
3020
- * ```js
3021
- * // Before running the sample:
3022
- * // - Enable the API at:
3023
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3024
- * // - Login into gcloud by running:
3025
- * // `$ gcloud auth application-default login`
3026
- * // - Install the npm module by running:
3027
- * // `$ npm install googleapis`
3028
- *
3029
- * const {google} = require('googleapis');
3030
- * const storage = google.storage('v1');
3031
- *
3032
- * async function main() {
3033
- * const auth = new google.auth.GoogleAuth({
3034
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3035
- * scopes: [
3036
- * 'https://www.googleapis.com/auth/cloud-platform',
3037
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3038
- * ],
3039
- * });
3040
- *
3041
- * // Acquire an auth client, and bind it to all future calls
3042
- * const authClient = await auth.getClient();
3043
- * google.options({auth: authClient});
3044
- *
3045
- * // Do the magic
3046
- * const res = await storage.defaultObjectAccessControls.patch({
3047
- * // Name of a bucket.
3048
- * bucket: 'placeholder-value',
3049
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
3050
- * entity: 'placeholder-value',
3051
- * // The project to be billed for this request. Required for Requester Pays buckets.
3052
- * userProject: 'placeholder-value',
3053
- *
3054
- * // Request body metadata
3055
- * requestBody: {
3056
- * // request body parameters
3057
- * // {
3058
- * // "bucket": "my_bucket",
3059
- * // "domain": "my_domain",
3060
- * // "email": "my_email",
3061
- * // "entity": "my_entity",
3062
- * // "entityId": "my_entityId",
3063
- * // "etag": "my_etag",
3064
- * // "generation": "my_generation",
3065
- * // "id": "my_id",
3066
- * // "kind": "my_kind",
3067
- * // "object": "my_object",
3068
- * // "projectTeam": {},
3069
- * // "role": "my_role",
3070
- * // "selfLink": "my_selfLink"
3071
- * // }
3072
- * },
3073
- * });
3074
- * console.log(res.data);
3075
- *
3076
- * // Example response
3077
- * // {
3078
- * // "bucket": "my_bucket",
3079
- * // "domain": "my_domain",
3080
- * // "email": "my_email",
3081
- * // "entity": "my_entity",
3082
- * // "entityId": "my_entityId",
3083
- * // "etag": "my_etag",
3084
- * // "generation": "my_generation",
3085
- * // "id": "my_id",
3086
- * // "kind": "my_kind",
3087
- * // "object": "my_object",
3088
- * // "projectTeam": {},
3089
- * // "role": "my_role",
3090
- * // "selfLink": "my_selfLink"
3091
- * // }
3092
- * }
3093
- *
3094
- * main().catch(e => {
3095
- * console.error(e);
3096
- * throw e;
3097
- * });
3098
- *
3099
- * ```
3100
1540
  *
3101
1541
  * @param params - Parameters for request
3102
1542
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3111,87 +1551,6 @@ export declare namespace storage_v1 {
3111
1551
  patch(callback: BodyResponseCallback<Schema$ObjectAccessControl>): void;
3112
1552
  /**
3113
1553
  * Updates a default object ACL entry on the specified bucket.
3114
- * @example
3115
- * ```js
3116
- * // Before running the sample:
3117
- * // - Enable the API at:
3118
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3119
- * // - Login into gcloud by running:
3120
- * // `$ gcloud auth application-default login`
3121
- * // - Install the npm module by running:
3122
- * // `$ npm install googleapis`
3123
- *
3124
- * const {google} = require('googleapis');
3125
- * const storage = google.storage('v1');
3126
- *
3127
- * async function main() {
3128
- * const auth = new google.auth.GoogleAuth({
3129
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3130
- * scopes: [
3131
- * 'https://www.googleapis.com/auth/cloud-platform',
3132
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3133
- * ],
3134
- * });
3135
- *
3136
- * // Acquire an auth client, and bind it to all future calls
3137
- * const authClient = await auth.getClient();
3138
- * google.options({auth: authClient});
3139
- *
3140
- * // Do the magic
3141
- * const res = await storage.defaultObjectAccessControls.update({
3142
- * // Name of a bucket.
3143
- * bucket: 'placeholder-value',
3144
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
3145
- * entity: 'placeholder-value',
3146
- * // The project to be billed for this request. Required for Requester Pays buckets.
3147
- * userProject: 'placeholder-value',
3148
- *
3149
- * // Request body metadata
3150
- * requestBody: {
3151
- * // request body parameters
3152
- * // {
3153
- * // "bucket": "my_bucket",
3154
- * // "domain": "my_domain",
3155
- * // "email": "my_email",
3156
- * // "entity": "my_entity",
3157
- * // "entityId": "my_entityId",
3158
- * // "etag": "my_etag",
3159
- * // "generation": "my_generation",
3160
- * // "id": "my_id",
3161
- * // "kind": "my_kind",
3162
- * // "object": "my_object",
3163
- * // "projectTeam": {},
3164
- * // "role": "my_role",
3165
- * // "selfLink": "my_selfLink"
3166
- * // }
3167
- * },
3168
- * });
3169
- * console.log(res.data);
3170
- *
3171
- * // Example response
3172
- * // {
3173
- * // "bucket": "my_bucket",
3174
- * // "domain": "my_domain",
3175
- * // "email": "my_email",
3176
- * // "entity": "my_entity",
3177
- * // "entityId": "my_entityId",
3178
- * // "etag": "my_etag",
3179
- * // "generation": "my_generation",
3180
- * // "id": "my_id",
3181
- * // "kind": "my_kind",
3182
- * // "object": "my_object",
3183
- * // "projectTeam": {},
3184
- * // "role": "my_role",
3185
- * // "selfLink": "my_selfLink"
3186
- * // }
3187
- * }
3188
- *
3189
- * main().catch(e => {
3190
- * console.error(e);
3191
- * throw e;
3192
- * });
3193
- *
3194
- * ```
3195
1554
  *
3196
1555
  * @param params - Parameters for request
3197
1556
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3306,51 +1665,6 @@ export declare namespace storage_v1 {
3306
1665
  constructor(context: APIRequestContext);
3307
1666
  /**
3308
1667
  * Permanently deletes a notification subscription.
3309
- * @example
3310
- * ```js
3311
- * // Before running the sample:
3312
- * // - Enable the API at:
3313
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3314
- * // - Login into gcloud by running:
3315
- * // `$ gcloud auth application-default login`
3316
- * // - Install the npm module by running:
3317
- * // `$ npm install googleapis`
3318
- *
3319
- * const {google} = require('googleapis');
3320
- * const storage = google.storage('v1');
3321
- *
3322
- * async function main() {
3323
- * const auth = new google.auth.GoogleAuth({
3324
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3325
- * scopes: [
3326
- * 'https://www.googleapis.com/auth/cloud-platform',
3327
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3328
- * 'https://www.googleapis.com/auth/devstorage.read_write',
3329
- * ],
3330
- * });
3331
- *
3332
- * // Acquire an auth client, and bind it to all future calls
3333
- * const authClient = await auth.getClient();
3334
- * google.options({auth: authClient});
3335
- *
3336
- * // Do the magic
3337
- * const res = await storage.notifications.delete({
3338
- * // The parent bucket of the notification.
3339
- * bucket: 'placeholder-value',
3340
- * // ID of the notification to delete.
3341
- * notification: 'placeholder-value',
3342
- * // The project to be billed for this request. Required for Requester Pays buckets.
3343
- * userProject: 'placeholder-value',
3344
- * });
3345
- * console.log(res.data);
3346
- * }
3347
- *
3348
- * main().catch(e => {
3349
- * console.error(e);
3350
- * throw e;
3351
- * });
3352
- *
3353
- * ```
3354
1668
  *
3355
1669
  * @param params - Parameters for request
3356
1670
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3365,66 +1679,6 @@ export declare namespace storage_v1 {
3365
1679
  delete(callback: BodyResponseCallback<void>): void;
3366
1680
  /**
3367
1681
  * View a notification configuration.
3368
- * @example
3369
- * ```js
3370
- * // Before running the sample:
3371
- * // - Enable the API at:
3372
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3373
- * // - Login into gcloud by running:
3374
- * // `$ gcloud auth application-default login`
3375
- * // - Install the npm module by running:
3376
- * // `$ npm install googleapis`
3377
- *
3378
- * const {google} = require('googleapis');
3379
- * const storage = google.storage('v1');
3380
- *
3381
- * async function main() {
3382
- * const auth = new google.auth.GoogleAuth({
3383
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3384
- * scopes: [
3385
- * 'https://www.googleapis.com/auth/cloud-platform',
3386
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
3387
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3388
- * 'https://www.googleapis.com/auth/devstorage.read_only',
3389
- * 'https://www.googleapis.com/auth/devstorage.read_write',
3390
- * ],
3391
- * });
3392
- *
3393
- * // Acquire an auth client, and bind it to all future calls
3394
- * const authClient = await auth.getClient();
3395
- * google.options({auth: authClient});
3396
- *
3397
- * // Do the magic
3398
- * const res = await storage.notifications.get({
3399
- * // The parent bucket of the notification.
3400
- * bucket: 'placeholder-value',
3401
- * // Notification ID
3402
- * notification: 'placeholder-value',
3403
- * // The project to be billed for this request. Required for Requester Pays buckets.
3404
- * userProject: 'placeholder-value',
3405
- * });
3406
- * console.log(res.data);
3407
- *
3408
- * // Example response
3409
- * // {
3410
- * // "custom_attributes": {},
3411
- * // "etag": "my_etag",
3412
- * // "event_types": [],
3413
- * // "id": "my_id",
3414
- * // "kind": "my_kind",
3415
- * // "object_name_prefix": "my_object_name_prefix",
3416
- * // "payload_format": "my_payload_format",
3417
- * // "selfLink": "my_selfLink",
3418
- * // "topic": "my_topic"
3419
- * // }
3420
- * }
3421
- *
3422
- * main().catch(e => {
3423
- * console.error(e);
3424
- * throw e;
3425
- * });
3426
- *
3427
- * ```
3428
1682
  *
3429
1683
  * @param params - Parameters for request
3430
1684
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3439,78 +1693,6 @@ export declare namespace storage_v1 {
3439
1693
  get(callback: BodyResponseCallback<Schema$Notification>): void;
3440
1694
  /**
3441
1695
  * Creates a notification subscription for a given bucket.
3442
- * @example
3443
- * ```js
3444
- * // Before running the sample:
3445
- * // - Enable the API at:
3446
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3447
- * // - Login into gcloud by running:
3448
- * // `$ gcloud auth application-default login`
3449
- * // - Install the npm module by running:
3450
- * // `$ npm install googleapis`
3451
- *
3452
- * const {google} = require('googleapis');
3453
- * const storage = google.storage('v1');
3454
- *
3455
- * async function main() {
3456
- * const auth = new google.auth.GoogleAuth({
3457
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3458
- * scopes: [
3459
- * 'https://www.googleapis.com/auth/cloud-platform',
3460
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3461
- * 'https://www.googleapis.com/auth/devstorage.read_write',
3462
- * ],
3463
- * });
3464
- *
3465
- * // Acquire an auth client, and bind it to all future calls
3466
- * const authClient = await auth.getClient();
3467
- * google.options({auth: authClient});
3468
- *
3469
- * // Do the magic
3470
- * const res = await storage.notifications.insert({
3471
- * // The parent bucket of the notification.
3472
- * bucket: 'placeholder-value',
3473
- * // The project to be billed for this request. Required for Requester Pays buckets.
3474
- * userProject: 'placeholder-value',
3475
- *
3476
- * // Request body metadata
3477
- * requestBody: {
3478
- * // request body parameters
3479
- * // {
3480
- * // "custom_attributes": {},
3481
- * // "etag": "my_etag",
3482
- * // "event_types": [],
3483
- * // "id": "my_id",
3484
- * // "kind": "my_kind",
3485
- * // "object_name_prefix": "my_object_name_prefix",
3486
- * // "payload_format": "my_payload_format",
3487
- * // "selfLink": "my_selfLink",
3488
- * // "topic": "my_topic"
3489
- * // }
3490
- * },
3491
- * });
3492
- * console.log(res.data);
3493
- *
3494
- * // Example response
3495
- * // {
3496
- * // "custom_attributes": {},
3497
- * // "etag": "my_etag",
3498
- * // "event_types": [],
3499
- * // "id": "my_id",
3500
- * // "kind": "my_kind",
3501
- * // "object_name_prefix": "my_object_name_prefix",
3502
- * // "payload_format": "my_payload_format",
3503
- * // "selfLink": "my_selfLink",
3504
- * // "topic": "my_topic"
3505
- * // }
3506
- * }
3507
- *
3508
- * main().catch(e => {
3509
- * console.error(e);
3510
- * throw e;
3511
- * });
3512
- *
3513
- * ```
3514
1696
  *
3515
1697
  * @param params - Parameters for request
3516
1698
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3525,57 +1707,6 @@ export declare namespace storage_v1 {
3525
1707
  insert(callback: BodyResponseCallback<Schema$Notification>): void;
3526
1708
  /**
3527
1709
  * Retrieves a list of notification subscriptions for a given bucket.
3528
- * @example
3529
- * ```js
3530
- * // Before running the sample:
3531
- * // - Enable the API at:
3532
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3533
- * // - Login into gcloud by running:
3534
- * // `$ gcloud auth application-default login`
3535
- * // - Install the npm module by running:
3536
- * // `$ npm install googleapis`
3537
- *
3538
- * const {google} = require('googleapis');
3539
- * const storage = google.storage('v1');
3540
- *
3541
- * async function main() {
3542
- * const auth = new google.auth.GoogleAuth({
3543
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3544
- * scopes: [
3545
- * 'https://www.googleapis.com/auth/cloud-platform',
3546
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
3547
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3548
- * 'https://www.googleapis.com/auth/devstorage.read_only',
3549
- * 'https://www.googleapis.com/auth/devstorage.read_write',
3550
- * ],
3551
- * });
3552
- *
3553
- * // Acquire an auth client, and bind it to all future calls
3554
- * const authClient = await auth.getClient();
3555
- * google.options({auth: authClient});
3556
- *
3557
- * // Do the magic
3558
- * const res = await storage.notifications.list({
3559
- * // Name of a Google Cloud Storage bucket.
3560
- * bucket: 'placeholder-value',
3561
- * // The project to be billed for this request. Required for Requester Pays buckets.
3562
- * userProject: 'placeholder-value',
3563
- * });
3564
- * console.log(res.data);
3565
- *
3566
- * // Example response
3567
- * // {
3568
- * // "items": [],
3569
- * // "kind": "my_kind"
3570
- * // }
3571
- * }
3572
- *
3573
- * main().catch(e => {
3574
- * console.error(e);
3575
- * throw e;
3576
- * });
3577
- *
3578
- * ```
3579
1710
  *
3580
1711
  * @param params - Parameters for request
3581
1712
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3646,54 +1777,6 @@ export declare namespace storage_v1 {
3646
1777
  constructor(context: APIRequestContext);
3647
1778
  /**
3648
1779
  * Permanently deletes the ACL entry for the specified entity on the specified object.
3649
- * @example
3650
- * ```js
3651
- * // Before running the sample:
3652
- * // - Enable the API at:
3653
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3654
- * // - Login into gcloud by running:
3655
- * // `$ gcloud auth application-default login`
3656
- * // - Install the npm module by running:
3657
- * // `$ npm install googleapis`
3658
- *
3659
- * const {google} = require('googleapis');
3660
- * const storage = google.storage('v1');
3661
- *
3662
- * async function main() {
3663
- * const auth = new google.auth.GoogleAuth({
3664
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3665
- * scopes: [
3666
- * 'https://www.googleapis.com/auth/cloud-platform',
3667
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3668
- * ],
3669
- * });
3670
- *
3671
- * // Acquire an auth client, and bind it to all future calls
3672
- * const authClient = await auth.getClient();
3673
- * google.options({auth: authClient});
3674
- *
3675
- * // Do the magic
3676
- * const res = await storage.objectAccessControls.delete({
3677
- * // Name of a bucket.
3678
- * bucket: 'placeholder-value',
3679
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
3680
- * entity: 'placeholder-value',
3681
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
3682
- * generation: 'placeholder-value',
3683
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
3684
- * object: 'placeholder-value',
3685
- * // The project to be billed for this request. Required for Requester Pays buckets.
3686
- * userProject: 'placeholder-value',
3687
- * });
3688
- * console.log(res.data);
3689
- * }
3690
- *
3691
- * main().catch(e => {
3692
- * console.error(e);
3693
- * throw e;
3694
- * });
3695
- *
3696
- * ```
3697
1780
  *
3698
1781
  * @param params - Parameters for request
3699
1782
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3708,71 +1791,6 @@ export declare namespace storage_v1 {
3708
1791
  delete(callback: BodyResponseCallback<void>): void;
3709
1792
  /**
3710
1793
  * Returns the ACL entry for the specified entity on the specified object.
3711
- * @example
3712
- * ```js
3713
- * // Before running the sample:
3714
- * // - Enable the API at:
3715
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3716
- * // - Login into gcloud by running:
3717
- * // `$ gcloud auth application-default login`
3718
- * // - Install the npm module by running:
3719
- * // `$ npm install googleapis`
3720
- *
3721
- * const {google} = require('googleapis');
3722
- * const storage = google.storage('v1');
3723
- *
3724
- * async function main() {
3725
- * const auth = new google.auth.GoogleAuth({
3726
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3727
- * scopes: [
3728
- * 'https://www.googleapis.com/auth/cloud-platform',
3729
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3730
- * ],
3731
- * });
3732
- *
3733
- * // Acquire an auth client, and bind it to all future calls
3734
- * const authClient = await auth.getClient();
3735
- * google.options({auth: authClient});
3736
- *
3737
- * // Do the magic
3738
- * const res = await storage.objectAccessControls.get({
3739
- * // Name of a bucket.
3740
- * bucket: 'placeholder-value',
3741
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
3742
- * entity: 'placeholder-value',
3743
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
3744
- * generation: 'placeholder-value',
3745
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
3746
- * object: 'placeholder-value',
3747
- * // The project to be billed for this request. Required for Requester Pays buckets.
3748
- * userProject: 'placeholder-value',
3749
- * });
3750
- * console.log(res.data);
3751
- *
3752
- * // Example response
3753
- * // {
3754
- * // "bucket": "my_bucket",
3755
- * // "domain": "my_domain",
3756
- * // "email": "my_email",
3757
- * // "entity": "my_entity",
3758
- * // "entityId": "my_entityId",
3759
- * // "etag": "my_etag",
3760
- * // "generation": "my_generation",
3761
- * // "id": "my_id",
3762
- * // "kind": "my_kind",
3763
- * // "object": "my_object",
3764
- * // "projectTeam": {},
3765
- * // "role": "my_role",
3766
- * // "selfLink": "my_selfLink"
3767
- * // }
3768
- * }
3769
- *
3770
- * main().catch(e => {
3771
- * console.error(e);
3772
- * throw e;
3773
- * });
3774
- *
3775
- * ```
3776
1794
  *
3777
1795
  * @param params - Parameters for request
3778
1796
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3787,89 +1805,6 @@ export declare namespace storage_v1 {
3787
1805
  get(callback: BodyResponseCallback<Schema$ObjectAccessControl>): void;
3788
1806
  /**
3789
1807
  * Creates a new ACL entry on the specified object.
3790
- * @example
3791
- * ```js
3792
- * // Before running the sample:
3793
- * // - Enable the API at:
3794
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3795
- * // - Login into gcloud by running:
3796
- * // `$ gcloud auth application-default login`
3797
- * // - Install the npm module by running:
3798
- * // `$ npm install googleapis`
3799
- *
3800
- * const {google} = require('googleapis');
3801
- * const storage = google.storage('v1');
3802
- *
3803
- * async function main() {
3804
- * const auth = new google.auth.GoogleAuth({
3805
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3806
- * scopes: [
3807
- * 'https://www.googleapis.com/auth/cloud-platform',
3808
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3809
- * ],
3810
- * });
3811
- *
3812
- * // Acquire an auth client, and bind it to all future calls
3813
- * const authClient = await auth.getClient();
3814
- * google.options({auth: authClient});
3815
- *
3816
- * // Do the magic
3817
- * const res = await storage.objectAccessControls.insert({
3818
- * // Name of a bucket.
3819
- * bucket: 'placeholder-value',
3820
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
3821
- * generation: 'placeholder-value',
3822
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
3823
- * object: 'placeholder-value',
3824
- * // The project to be billed for this request. Required for Requester Pays buckets.
3825
- * userProject: 'placeholder-value',
3826
- *
3827
- * // Request body metadata
3828
- * requestBody: {
3829
- * // request body parameters
3830
- * // {
3831
- * // "bucket": "my_bucket",
3832
- * // "domain": "my_domain",
3833
- * // "email": "my_email",
3834
- * // "entity": "my_entity",
3835
- * // "entityId": "my_entityId",
3836
- * // "etag": "my_etag",
3837
- * // "generation": "my_generation",
3838
- * // "id": "my_id",
3839
- * // "kind": "my_kind",
3840
- * // "object": "my_object",
3841
- * // "projectTeam": {},
3842
- * // "role": "my_role",
3843
- * // "selfLink": "my_selfLink"
3844
- * // }
3845
- * },
3846
- * });
3847
- * console.log(res.data);
3848
- *
3849
- * // Example response
3850
- * // {
3851
- * // "bucket": "my_bucket",
3852
- * // "domain": "my_domain",
3853
- * // "email": "my_email",
3854
- * // "entity": "my_entity",
3855
- * // "entityId": "my_entityId",
3856
- * // "etag": "my_etag",
3857
- * // "generation": "my_generation",
3858
- * // "id": "my_id",
3859
- * // "kind": "my_kind",
3860
- * // "object": "my_object",
3861
- * // "projectTeam": {},
3862
- * // "role": "my_role",
3863
- * // "selfLink": "my_selfLink"
3864
- * // }
3865
- * }
3866
- *
3867
- * main().catch(e => {
3868
- * console.error(e);
3869
- * throw e;
3870
- * });
3871
- *
3872
- * ```
3873
1808
  *
3874
1809
  * @param params - Parameters for request
3875
1810
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3884,58 +1819,6 @@ export declare namespace storage_v1 {
3884
1819
  insert(callback: BodyResponseCallback<Schema$ObjectAccessControl>): void;
3885
1820
  /**
3886
1821
  * Retrieves ACL entries on the specified object.
3887
- * @example
3888
- * ```js
3889
- * // Before running the sample:
3890
- * // - Enable the API at:
3891
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3892
- * // - Login into gcloud by running:
3893
- * // `$ gcloud auth application-default login`
3894
- * // - Install the npm module by running:
3895
- * // `$ npm install googleapis`
3896
- *
3897
- * const {google} = require('googleapis');
3898
- * const storage = google.storage('v1');
3899
- *
3900
- * async function main() {
3901
- * const auth = new google.auth.GoogleAuth({
3902
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3903
- * scopes: [
3904
- * 'https://www.googleapis.com/auth/cloud-platform',
3905
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3906
- * ],
3907
- * });
3908
- *
3909
- * // Acquire an auth client, and bind it to all future calls
3910
- * const authClient = await auth.getClient();
3911
- * google.options({auth: authClient});
3912
- *
3913
- * // Do the magic
3914
- * const res = await storage.objectAccessControls.list({
3915
- * // Name of a bucket.
3916
- * bucket: 'placeholder-value',
3917
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
3918
- * generation: 'placeholder-value',
3919
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
3920
- * object: 'placeholder-value',
3921
- * // The project to be billed for this request. Required for Requester Pays buckets.
3922
- * userProject: 'placeholder-value',
3923
- * });
3924
- * console.log(res.data);
3925
- *
3926
- * // Example response
3927
- * // {
3928
- * // "items": [],
3929
- * // "kind": "my_kind"
3930
- * // }
3931
- * }
3932
- *
3933
- * main().catch(e => {
3934
- * console.error(e);
3935
- * throw e;
3936
- * });
3937
- *
3938
- * ```
3939
1822
  *
3940
1823
  * @param params - Parameters for request
3941
1824
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -3950,91 +1833,6 @@ export declare namespace storage_v1 {
3950
1833
  list(callback: BodyResponseCallback<Schema$ObjectAccessControls>): void;
3951
1834
  /**
3952
1835
  * Patches an ACL entry on the specified object.
3953
- * @example
3954
- * ```js
3955
- * // Before running the sample:
3956
- * // - Enable the API at:
3957
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
3958
- * // - Login into gcloud by running:
3959
- * // `$ gcloud auth application-default login`
3960
- * // - Install the npm module by running:
3961
- * // `$ npm install googleapis`
3962
- *
3963
- * const {google} = require('googleapis');
3964
- * const storage = google.storage('v1');
3965
- *
3966
- * async function main() {
3967
- * const auth = new google.auth.GoogleAuth({
3968
- * // Scopes can be specified either as an array or as a single, space-delimited string.
3969
- * scopes: [
3970
- * 'https://www.googleapis.com/auth/cloud-platform',
3971
- * 'https://www.googleapis.com/auth/devstorage.full_control',
3972
- * ],
3973
- * });
3974
- *
3975
- * // Acquire an auth client, and bind it to all future calls
3976
- * const authClient = await auth.getClient();
3977
- * google.options({auth: authClient});
3978
- *
3979
- * // Do the magic
3980
- * const res = await storage.objectAccessControls.patch({
3981
- * // Name of a bucket.
3982
- * bucket: 'placeholder-value',
3983
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
3984
- * entity: 'placeholder-value',
3985
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
3986
- * generation: 'placeholder-value',
3987
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
3988
- * object: 'placeholder-value',
3989
- * // The project to be billed for this request. Required for Requester Pays buckets.
3990
- * userProject: 'placeholder-value',
3991
- *
3992
- * // Request body metadata
3993
- * requestBody: {
3994
- * // request body parameters
3995
- * // {
3996
- * // "bucket": "my_bucket",
3997
- * // "domain": "my_domain",
3998
- * // "email": "my_email",
3999
- * // "entity": "my_entity",
4000
- * // "entityId": "my_entityId",
4001
- * // "etag": "my_etag",
4002
- * // "generation": "my_generation",
4003
- * // "id": "my_id",
4004
- * // "kind": "my_kind",
4005
- * // "object": "my_object",
4006
- * // "projectTeam": {},
4007
- * // "role": "my_role",
4008
- * // "selfLink": "my_selfLink"
4009
- * // }
4010
- * },
4011
- * });
4012
- * console.log(res.data);
4013
- *
4014
- * // Example response
4015
- * // {
4016
- * // "bucket": "my_bucket",
4017
- * // "domain": "my_domain",
4018
- * // "email": "my_email",
4019
- * // "entity": "my_entity",
4020
- * // "entityId": "my_entityId",
4021
- * // "etag": "my_etag",
4022
- * // "generation": "my_generation",
4023
- * // "id": "my_id",
4024
- * // "kind": "my_kind",
4025
- * // "object": "my_object",
4026
- * // "projectTeam": {},
4027
- * // "role": "my_role",
4028
- * // "selfLink": "my_selfLink"
4029
- * // }
4030
- * }
4031
- *
4032
- * main().catch(e => {
4033
- * console.error(e);
4034
- * throw e;
4035
- * });
4036
- *
4037
- * ```
4038
1836
  *
4039
1837
  * @param params - Parameters for request
4040
1838
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4049,91 +1847,6 @@ export declare namespace storage_v1 {
4049
1847
  patch(callback: BodyResponseCallback<Schema$ObjectAccessControl>): void;
4050
1848
  /**
4051
1849
  * Updates an ACL entry on the specified object.
4052
- * @example
4053
- * ```js
4054
- * // Before running the sample:
4055
- * // - Enable the API at:
4056
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4057
- * // - Login into gcloud by running:
4058
- * // `$ gcloud auth application-default login`
4059
- * // - Install the npm module by running:
4060
- * // `$ npm install googleapis`
4061
- *
4062
- * const {google} = require('googleapis');
4063
- * const storage = google.storage('v1');
4064
- *
4065
- * async function main() {
4066
- * const auth = new google.auth.GoogleAuth({
4067
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4068
- * scopes: [
4069
- * 'https://www.googleapis.com/auth/cloud-platform',
4070
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4071
- * ],
4072
- * });
4073
- *
4074
- * // Acquire an auth client, and bind it to all future calls
4075
- * const authClient = await auth.getClient();
4076
- * google.options({auth: authClient});
4077
- *
4078
- * // Do the magic
4079
- * const res = await storage.objectAccessControls.update({
4080
- * // Name of a bucket.
4081
- * bucket: 'placeholder-value',
4082
- * // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
4083
- * entity: 'placeholder-value',
4084
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
4085
- * generation: 'placeholder-value',
4086
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4087
- * object: 'placeholder-value',
4088
- * // The project to be billed for this request. Required for Requester Pays buckets.
4089
- * userProject: 'placeholder-value',
4090
- *
4091
- * // Request body metadata
4092
- * requestBody: {
4093
- * // request body parameters
4094
- * // {
4095
- * // "bucket": "my_bucket",
4096
- * // "domain": "my_domain",
4097
- * // "email": "my_email",
4098
- * // "entity": "my_entity",
4099
- * // "entityId": "my_entityId",
4100
- * // "etag": "my_etag",
4101
- * // "generation": "my_generation",
4102
- * // "id": "my_id",
4103
- * // "kind": "my_kind",
4104
- * // "object": "my_object",
4105
- * // "projectTeam": {},
4106
- * // "role": "my_role",
4107
- * // "selfLink": "my_selfLink"
4108
- * // }
4109
- * },
4110
- * });
4111
- * console.log(res.data);
4112
- *
4113
- * // Example response
4114
- * // {
4115
- * // "bucket": "my_bucket",
4116
- * // "domain": "my_domain",
4117
- * // "email": "my_email",
4118
- * // "entity": "my_entity",
4119
- * // "entityId": "my_entityId",
4120
- * // "etag": "my_etag",
4121
- * // "generation": "my_generation",
4122
- * // "id": "my_id",
4123
- * // "kind": "my_kind",
4124
- * // "object": "my_object",
4125
- * // "projectTeam": {},
4126
- * // "role": "my_role",
4127
- * // "selfLink": "my_selfLink"
4128
- * // }
4129
- * }
4130
- *
4131
- * main().catch(e => {
4132
- * console.error(e);
4133
- * throw e;
4134
- * });
4135
- *
4136
- * ```
4137
1850
  *
4138
1851
  * @param params - Parameters for request
4139
1852
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4288,105 +2001,6 @@ export declare namespace storage_v1 {
4288
2001
  constructor(context: APIRequestContext);
4289
2002
  /**
4290
2003
  * Concatenates a list of existing objects into a new object in the same bucket.
4291
- * @example
4292
- * ```js
4293
- * // Before running the sample:
4294
- * // - Enable the API at:
4295
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4296
- * // - Login into gcloud by running:
4297
- * // `$ gcloud auth application-default login`
4298
- * // - Install the npm module by running:
4299
- * // `$ npm install googleapis`
4300
- *
4301
- * const {google} = require('googleapis');
4302
- * const storage = google.storage('v1');
4303
- *
4304
- * async function main() {
4305
- * const auth = new google.auth.GoogleAuth({
4306
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4307
- * scopes: [
4308
- * 'https://www.googleapis.com/auth/cloud-platform',
4309
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4310
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4311
- * ],
4312
- * });
4313
- *
4314
- * // Acquire an auth client, and bind it to all future calls
4315
- * const authClient = await auth.getClient();
4316
- * google.options({auth: authClient});
4317
- *
4318
- * // Do the magic
4319
- * const res = await storage.objects.compose({
4320
- * // Name of the bucket containing the source objects. The destination object is stored in this bucket.
4321
- * destinationBucket: 'placeholder-value',
4322
- * // Name of the new object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4323
- * destinationObject: 'placeholder-value',
4324
- * // Apply a predefined set of access controls to the destination object.
4325
- * destinationPredefinedAcl: 'placeholder-value',
4326
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
4327
- * ifGenerationMatch: 'placeholder-value',
4328
- * // Makes the operation conditional on whether the object's current metageneration matches the given value.
4329
- * ifMetagenerationMatch: 'placeholder-value',
4330
- * // Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
4331
- * kmsKeyName: 'placeholder-value',
4332
- * // The project to be billed for this request. Required for Requester Pays buckets.
4333
- * userProject: 'placeholder-value',
4334
- *
4335
- * // Request body metadata
4336
- * requestBody: {
4337
- * // request body parameters
4338
- * // {
4339
- * // "destination": {},
4340
- * // "kind": "my_kind",
4341
- * // "sourceObjects": []
4342
- * // }
4343
- * },
4344
- * });
4345
- * console.log(res.data);
4346
- *
4347
- * // Example response
4348
- * // {
4349
- * // "acl": [],
4350
- * // "bucket": "my_bucket",
4351
- * // "cacheControl": "my_cacheControl",
4352
- * // "componentCount": 0,
4353
- * // "contentDisposition": "my_contentDisposition",
4354
- * // "contentEncoding": "my_contentEncoding",
4355
- * // "contentLanguage": "my_contentLanguage",
4356
- * // "contentType": "my_contentType",
4357
- * // "crc32c": "my_crc32c",
4358
- * // "customTime": "my_customTime",
4359
- * // "customerEncryption": {},
4360
- * // "etag": "my_etag",
4361
- * // "eventBasedHold": false,
4362
- * // "generation": "my_generation",
4363
- * // "id": "my_id",
4364
- * // "kind": "my_kind",
4365
- * // "kmsKeyName": "my_kmsKeyName",
4366
- * // "md5Hash": "my_md5Hash",
4367
- * // "mediaLink": "my_mediaLink",
4368
- * // "metadata": {},
4369
- * // "metageneration": "my_metageneration",
4370
- * // "name": "my_name",
4371
- * // "owner": {},
4372
- * // "retentionExpirationTime": "my_retentionExpirationTime",
4373
- * // "selfLink": "my_selfLink",
4374
- * // "size": "my_size",
4375
- * // "storageClass": "my_storageClass",
4376
- * // "temporaryHold": false,
4377
- * // "timeCreated": "my_timeCreated",
4378
- * // "timeDeleted": "my_timeDeleted",
4379
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
4380
- * // "updated": "my_updated"
4381
- * // }
4382
- * }
4383
- *
4384
- * main().catch(e => {
4385
- * console.error(e);
4386
- * throw e;
4387
- * });
4388
- *
4389
- * ```
4390
2004
  *
4391
2005
  * @param params - Parameters for request
4392
2006
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4401,154 +2015,6 @@ export declare namespace storage_v1 {
4401
2015
  compose(callback: BodyResponseCallback<Schema$Object>): void;
4402
2016
  /**
4403
2017
  * Copies a source object to a destination object. Optionally overrides metadata.
4404
- * @example
4405
- * ```js
4406
- * // Before running the sample:
4407
- * // - Enable the API at:
4408
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4409
- * // - Login into gcloud by running:
4410
- * // `$ gcloud auth application-default login`
4411
- * // - Install the npm module by running:
4412
- * // `$ npm install googleapis`
4413
- *
4414
- * const {google} = require('googleapis');
4415
- * const storage = google.storage('v1');
4416
- *
4417
- * async function main() {
4418
- * const auth = new google.auth.GoogleAuth({
4419
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4420
- * scopes: [
4421
- * 'https://www.googleapis.com/auth/cloud-platform',
4422
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4423
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4424
- * ],
4425
- * });
4426
- *
4427
- * // Acquire an auth client, and bind it to all future calls
4428
- * const authClient = await auth.getClient();
4429
- * google.options({auth: authClient});
4430
- *
4431
- * // Do the magic
4432
- * const res = await storage.objects.copy({
4433
- * // Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4434
- * destinationBucket: 'placeholder-value',
4435
- * // Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
4436
- * destinationKmsKeyName: 'placeholder-value',
4437
- * // Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
4438
- * destinationObject: 'placeholder-value',
4439
- * // Apply a predefined set of access controls to the destination object.
4440
- * destinationPredefinedAcl: 'placeholder-value',
4441
- * // Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
4442
- * ifGenerationMatch: 'placeholder-value',
4443
- * // Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
4444
- * ifGenerationNotMatch: 'placeholder-value',
4445
- * // Makes the operation conditional on whether the destination object's current metageneration matches the given value.
4446
- * ifMetagenerationMatch: 'placeholder-value',
4447
- * // Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
4448
- * ifMetagenerationNotMatch: 'placeholder-value',
4449
- * // Makes the operation conditional on whether the source object's current generation matches the given value.
4450
- * ifSourceGenerationMatch: 'placeholder-value',
4451
- * // Makes the operation conditional on whether the source object's current generation does not match the given value.
4452
- * ifSourceGenerationNotMatch: 'placeholder-value',
4453
- * // Makes the operation conditional on whether the source object's current metageneration matches the given value.
4454
- * ifSourceMetagenerationMatch: 'placeholder-value',
4455
- * // Makes the operation conditional on whether the source object's current metageneration does not match the given value.
4456
- * ifSourceMetagenerationNotMatch: 'placeholder-value',
4457
- * // Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
4458
- * projection: 'placeholder-value',
4459
- * // Name of the bucket in which to find the source object.
4460
- * sourceBucket: 'placeholder-value',
4461
- * // If present, selects a specific revision of the source object (as opposed to the latest version, the default).
4462
- * sourceGeneration: 'placeholder-value',
4463
- * // Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4464
- * sourceObject: 'placeholder-value',
4465
- * // The project to be billed for this request. Required for Requester Pays buckets.
4466
- * userProject: 'placeholder-value',
4467
- *
4468
- * // Request body metadata
4469
- * requestBody: {
4470
- * // request body parameters
4471
- * // {
4472
- * // "acl": [],
4473
- * // "bucket": "my_bucket",
4474
- * // "cacheControl": "my_cacheControl",
4475
- * // "componentCount": 0,
4476
- * // "contentDisposition": "my_contentDisposition",
4477
- * // "contentEncoding": "my_contentEncoding",
4478
- * // "contentLanguage": "my_contentLanguage",
4479
- * // "contentType": "my_contentType",
4480
- * // "crc32c": "my_crc32c",
4481
- * // "customTime": "my_customTime",
4482
- * // "customerEncryption": {},
4483
- * // "etag": "my_etag",
4484
- * // "eventBasedHold": false,
4485
- * // "generation": "my_generation",
4486
- * // "id": "my_id",
4487
- * // "kind": "my_kind",
4488
- * // "kmsKeyName": "my_kmsKeyName",
4489
- * // "md5Hash": "my_md5Hash",
4490
- * // "mediaLink": "my_mediaLink",
4491
- * // "metadata": {},
4492
- * // "metageneration": "my_metageneration",
4493
- * // "name": "my_name",
4494
- * // "owner": {},
4495
- * // "retentionExpirationTime": "my_retentionExpirationTime",
4496
- * // "selfLink": "my_selfLink",
4497
- * // "size": "my_size",
4498
- * // "storageClass": "my_storageClass",
4499
- * // "temporaryHold": false,
4500
- * // "timeCreated": "my_timeCreated",
4501
- * // "timeDeleted": "my_timeDeleted",
4502
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
4503
- * // "updated": "my_updated"
4504
- * // }
4505
- * },
4506
- * });
4507
- * console.log(res.data);
4508
- *
4509
- * // Example response
4510
- * // {
4511
- * // "acl": [],
4512
- * // "bucket": "my_bucket",
4513
- * // "cacheControl": "my_cacheControl",
4514
- * // "componentCount": 0,
4515
- * // "contentDisposition": "my_contentDisposition",
4516
- * // "contentEncoding": "my_contentEncoding",
4517
- * // "contentLanguage": "my_contentLanguage",
4518
- * // "contentType": "my_contentType",
4519
- * // "crc32c": "my_crc32c",
4520
- * // "customTime": "my_customTime",
4521
- * // "customerEncryption": {},
4522
- * // "etag": "my_etag",
4523
- * // "eventBasedHold": false,
4524
- * // "generation": "my_generation",
4525
- * // "id": "my_id",
4526
- * // "kind": "my_kind",
4527
- * // "kmsKeyName": "my_kmsKeyName",
4528
- * // "md5Hash": "my_md5Hash",
4529
- * // "mediaLink": "my_mediaLink",
4530
- * // "metadata": {},
4531
- * // "metageneration": "my_metageneration",
4532
- * // "name": "my_name",
4533
- * // "owner": {},
4534
- * // "retentionExpirationTime": "my_retentionExpirationTime",
4535
- * // "selfLink": "my_selfLink",
4536
- * // "size": "my_size",
4537
- * // "storageClass": "my_storageClass",
4538
- * // "temporaryHold": false,
4539
- * // "timeCreated": "my_timeCreated",
4540
- * // "timeDeleted": "my_timeDeleted",
4541
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
4542
- * // "updated": "my_updated"
4543
- * // }
4544
- * }
4545
- *
4546
- * main().catch(e => {
4547
- * console.error(e);
4548
- * throw e;
4549
- * });
4550
- *
4551
- * ```
4552
2018
  *
4553
2019
  * @param params - Parameters for request
4554
2020
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4563,61 +2029,6 @@ export declare namespace storage_v1 {
4563
2029
  copy(callback: BodyResponseCallback<Schema$Object>): void;
4564
2030
  /**
4565
2031
  * Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
4566
- * @example
4567
- * ```js
4568
- * // Before running the sample:
4569
- * // - Enable the API at:
4570
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4571
- * // - Login into gcloud by running:
4572
- * // `$ gcloud auth application-default login`
4573
- * // - Install the npm module by running:
4574
- * // `$ npm install googleapis`
4575
- *
4576
- * const {google} = require('googleapis');
4577
- * const storage = google.storage('v1');
4578
- *
4579
- * async function main() {
4580
- * const auth = new google.auth.GoogleAuth({
4581
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4582
- * scopes: [
4583
- * 'https://www.googleapis.com/auth/cloud-platform',
4584
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4585
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4586
- * ],
4587
- * });
4588
- *
4589
- * // Acquire an auth client, and bind it to all future calls
4590
- * const authClient = await auth.getClient();
4591
- * google.options({auth: authClient});
4592
- *
4593
- * // Do the magic
4594
- * const res = await storage.objects.delete({
4595
- * // Name of the bucket in which the object resides.
4596
- * bucket: 'placeholder-value',
4597
- * // If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
4598
- * generation: 'placeholder-value',
4599
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
4600
- * ifGenerationMatch: 'placeholder-value',
4601
- * // Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
4602
- * ifGenerationNotMatch: 'placeholder-value',
4603
- * // Makes the operation conditional on whether the object's current metageneration matches the given value.
4604
- * ifMetagenerationMatch: 'placeholder-value',
4605
- * // Makes the operation conditional on whether the object's current metageneration does not match the given value.
4606
- * ifMetagenerationNotMatch: 'placeholder-value',
4607
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4608
- * object: 'placeholder-value',
4609
- * // The project to be billed for this request. Required for Requester Pays buckets.
4610
- * userProject: 'placeholder-value',
4611
- * });
4612
- * console.log(res.data);
4613
- * }
4614
- *
4615
- * main().catch(e => {
4616
- * console.error(e);
4617
- * throw e;
4618
- * });
4619
- *
4620
- * ```
4621
2032
  *
4622
2033
  * @param params - Parameters for request
4623
2034
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4632,101 +2043,6 @@ export declare namespace storage_v1 {
4632
2043
  delete(callback: BodyResponseCallback<void>): void;
4633
2044
  /**
4634
2045
  * Retrieves an object or its metadata.
4635
- * @example
4636
- * ```js
4637
- * // Before running the sample:
4638
- * // - Enable the API at:
4639
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4640
- * // - Login into gcloud by running:
4641
- * // `$ gcloud auth application-default login`
4642
- * // - Install the npm module by running:
4643
- * // `$ npm install googleapis`
4644
- *
4645
- * const {google} = require('googleapis');
4646
- * const storage = google.storage('v1');
4647
- *
4648
- * async function main() {
4649
- * const auth = new google.auth.GoogleAuth({
4650
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4651
- * scopes: [
4652
- * 'https://www.googleapis.com/auth/cloud-platform',
4653
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
4654
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4655
- * 'https://www.googleapis.com/auth/devstorage.read_only',
4656
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4657
- * ],
4658
- * });
4659
- *
4660
- * // Acquire an auth client, and bind it to all future calls
4661
- * const authClient = await auth.getClient();
4662
- * google.options({auth: authClient});
4663
- *
4664
- * // Do the magic
4665
- * const res = await storage.objects.get({
4666
- * // Name of the bucket in which the object resides.
4667
- * bucket: 'placeholder-value',
4668
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
4669
- * generation: 'placeholder-value',
4670
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
4671
- * ifGenerationMatch: 'placeholder-value',
4672
- * // Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
4673
- * ifGenerationNotMatch: 'placeholder-value',
4674
- * // Makes the operation conditional on whether the object's current metageneration matches the given value.
4675
- * ifMetagenerationMatch: 'placeholder-value',
4676
- * // Makes the operation conditional on whether the object's current metageneration does not match the given value.
4677
- * ifMetagenerationNotMatch: 'placeholder-value',
4678
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4679
- * object: 'placeholder-value',
4680
- * // Set of properties to return. Defaults to noAcl.
4681
- * projection: 'placeholder-value',
4682
- * // The project to be billed for this request. Required for Requester Pays buckets.
4683
- * userProject: 'placeholder-value',
4684
- * });
4685
- * console.log(res.data);
4686
- *
4687
- * // Example response
4688
- * // {
4689
- * // "acl": [],
4690
- * // "bucket": "my_bucket",
4691
- * // "cacheControl": "my_cacheControl",
4692
- * // "componentCount": 0,
4693
- * // "contentDisposition": "my_contentDisposition",
4694
- * // "contentEncoding": "my_contentEncoding",
4695
- * // "contentLanguage": "my_contentLanguage",
4696
- * // "contentType": "my_contentType",
4697
- * // "crc32c": "my_crc32c",
4698
- * // "customTime": "my_customTime",
4699
- * // "customerEncryption": {},
4700
- * // "etag": "my_etag",
4701
- * // "eventBasedHold": false,
4702
- * // "generation": "my_generation",
4703
- * // "id": "my_id",
4704
- * // "kind": "my_kind",
4705
- * // "kmsKeyName": "my_kmsKeyName",
4706
- * // "md5Hash": "my_md5Hash",
4707
- * // "mediaLink": "my_mediaLink",
4708
- * // "metadata": {},
4709
- * // "metageneration": "my_metageneration",
4710
- * // "name": "my_name",
4711
- * // "owner": {},
4712
- * // "retentionExpirationTime": "my_retentionExpirationTime",
4713
- * // "selfLink": "my_selfLink",
4714
- * // "size": "my_size",
4715
- * // "storageClass": "my_storageClass",
4716
- * // "temporaryHold": false,
4717
- * // "timeCreated": "my_timeCreated",
4718
- * // "timeDeleted": "my_timeDeleted",
4719
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
4720
- * // "updated": "my_updated"
4721
- * // }
4722
- * }
4723
- *
4724
- * main().catch(e => {
4725
- * console.error(e);
4726
- * throw e;
4727
- * });
4728
- *
4729
- * ```
4730
2046
  *
4731
2047
  * @param params - Parameters for request
4732
2048
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4741,64 +2057,6 @@ export declare namespace storage_v1 {
4741
2057
  get(callback: BodyResponseCallback<Schema$Object>): void;
4742
2058
  /**
4743
2059
  * Returns an IAM policy for the specified object.
4744
- * @example
4745
- * ```js
4746
- * // Before running the sample:
4747
- * // - Enable the API at:
4748
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4749
- * // - Login into gcloud by running:
4750
- * // `$ gcloud auth application-default login`
4751
- * // - Install the npm module by running:
4752
- * // `$ npm install googleapis`
4753
- *
4754
- * const {google} = require('googleapis');
4755
- * const storage = google.storage('v1');
4756
- *
4757
- * async function main() {
4758
- * const auth = new google.auth.GoogleAuth({
4759
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4760
- * scopes: [
4761
- * 'https://www.googleapis.com/auth/cloud-platform',
4762
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
4763
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4764
- * 'https://www.googleapis.com/auth/devstorage.read_only',
4765
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4766
- * ],
4767
- * });
4768
- *
4769
- * // Acquire an auth client, and bind it to all future calls
4770
- * const authClient = await auth.getClient();
4771
- * google.options({auth: authClient});
4772
- *
4773
- * // Do the magic
4774
- * const res = await storage.objects.getIamPolicy({
4775
- * // Name of the bucket in which the object resides.
4776
- * bucket: 'placeholder-value',
4777
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
4778
- * generation: 'placeholder-value',
4779
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4780
- * object: 'placeholder-value',
4781
- * // The project to be billed for this request. Required for Requester Pays buckets.
4782
- * userProject: 'placeholder-value',
4783
- * });
4784
- * console.log(res.data);
4785
- *
4786
- * // Example response
4787
- * // {
4788
- * // "bindings": [],
4789
- * // "etag": "my_etag",
4790
- * // "kind": "my_kind",
4791
- * // "resourceId": "my_resourceId",
4792
- * // "version": 0
4793
- * // }
4794
- * }
4795
- *
4796
- * main().catch(e => {
4797
- * console.error(e);
4798
- * throw e;
4799
- * });
4800
- *
4801
- * ```
4802
2060
  *
4803
2061
  * @param params - Parameters for request
4804
2062
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4813,146 +2071,6 @@ export declare namespace storage_v1 {
4813
2071
  getIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
4814
2072
  /**
4815
2073
  * Stores a new object and metadata.
4816
- * @example
4817
- * ```js
4818
- * // Before running the sample:
4819
- * // - Enable the API at:
4820
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4821
- * // - Login into gcloud by running:
4822
- * // `$ gcloud auth application-default login`
4823
- * // - Install the npm module by running:
4824
- * // `$ npm install googleapis`
4825
- *
4826
- * const {google} = require('googleapis');
4827
- * const storage = google.storage('v1');
4828
- *
4829
- * async function main() {
4830
- * const auth = new google.auth.GoogleAuth({
4831
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4832
- * scopes: [
4833
- * 'https://www.googleapis.com/auth/cloud-platform',
4834
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4835
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4836
- * ],
4837
- * });
4838
- *
4839
- * // Acquire an auth client, and bind it to all future calls
4840
- * const authClient = await auth.getClient();
4841
- * google.options({auth: authClient});
4842
- *
4843
- * // Do the magic
4844
- * const res = await storage.objects.insert({
4845
- * // Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
4846
- * bucket: 'placeholder-value',
4847
- * // If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
4848
- * contentEncoding: 'placeholder-value',
4849
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
4850
- * ifGenerationMatch: 'placeholder-value',
4851
- * // Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
4852
- * ifGenerationNotMatch: 'placeholder-value',
4853
- * // Makes the operation conditional on whether the object's current metageneration matches the given value.
4854
- * ifMetagenerationMatch: 'placeholder-value',
4855
- * // Makes the operation conditional on whether the object's current metageneration does not match the given value.
4856
- * ifMetagenerationNotMatch: 'placeholder-value',
4857
- * // Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
4858
- * kmsKeyName: 'placeholder-value',
4859
- * // Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
4860
- * name: 'placeholder-value',
4861
- * // Apply a predefined set of access controls to this object.
4862
- * predefinedAcl: 'placeholder-value',
4863
- * // Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
4864
- * projection: 'placeholder-value',
4865
- * // The project to be billed for this request. Required for Requester Pays buckets.
4866
- * userProject: 'placeholder-value',
4867
- *
4868
- * // Request body metadata
4869
- * requestBody: {
4870
- * // request body parameters
4871
- * // {
4872
- * // "acl": [],
4873
- * // "bucket": "my_bucket",
4874
- * // "cacheControl": "my_cacheControl",
4875
- * // "componentCount": 0,
4876
- * // "contentDisposition": "my_contentDisposition",
4877
- * // "contentEncoding": "my_contentEncoding",
4878
- * // "contentLanguage": "my_contentLanguage",
4879
- * // "contentType": "my_contentType",
4880
- * // "crc32c": "my_crc32c",
4881
- * // "customTime": "my_customTime",
4882
- * // "customerEncryption": {},
4883
- * // "etag": "my_etag",
4884
- * // "eventBasedHold": false,
4885
- * // "generation": "my_generation",
4886
- * // "id": "my_id",
4887
- * // "kind": "my_kind",
4888
- * // "kmsKeyName": "my_kmsKeyName",
4889
- * // "md5Hash": "my_md5Hash",
4890
- * // "mediaLink": "my_mediaLink",
4891
- * // "metadata": {},
4892
- * // "metageneration": "my_metageneration",
4893
- * // "name": "my_name",
4894
- * // "owner": {},
4895
- * // "retentionExpirationTime": "my_retentionExpirationTime",
4896
- * // "selfLink": "my_selfLink",
4897
- * // "size": "my_size",
4898
- * // "storageClass": "my_storageClass",
4899
- * // "temporaryHold": false,
4900
- * // "timeCreated": "my_timeCreated",
4901
- * // "timeDeleted": "my_timeDeleted",
4902
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
4903
- * // "updated": "my_updated"
4904
- * // }
4905
- * },
4906
- * media: {
4907
- * mimeType: 'placeholder-value',
4908
- * body: 'placeholder-value',
4909
- * },
4910
- * });
4911
- * console.log(res.data);
4912
- *
4913
- * // Example response
4914
- * // {
4915
- * // "acl": [],
4916
- * // "bucket": "my_bucket",
4917
- * // "cacheControl": "my_cacheControl",
4918
- * // "componentCount": 0,
4919
- * // "contentDisposition": "my_contentDisposition",
4920
- * // "contentEncoding": "my_contentEncoding",
4921
- * // "contentLanguage": "my_contentLanguage",
4922
- * // "contentType": "my_contentType",
4923
- * // "crc32c": "my_crc32c",
4924
- * // "customTime": "my_customTime",
4925
- * // "customerEncryption": {},
4926
- * // "etag": "my_etag",
4927
- * // "eventBasedHold": false,
4928
- * // "generation": "my_generation",
4929
- * // "id": "my_id",
4930
- * // "kind": "my_kind",
4931
- * // "kmsKeyName": "my_kmsKeyName",
4932
- * // "md5Hash": "my_md5Hash",
4933
- * // "mediaLink": "my_mediaLink",
4934
- * // "metadata": {},
4935
- * // "metageneration": "my_metageneration",
4936
- * // "name": "my_name",
4937
- * // "owner": {},
4938
- * // "retentionExpirationTime": "my_retentionExpirationTime",
4939
- * // "selfLink": "my_selfLink",
4940
- * // "size": "my_size",
4941
- * // "storageClass": "my_storageClass",
4942
- * // "temporaryHold": false,
4943
- * // "timeCreated": "my_timeCreated",
4944
- * // "timeDeleted": "my_timeDeleted",
4945
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
4946
- * // "updated": "my_updated"
4947
- * // }
4948
- * }
4949
- *
4950
- * main().catch(e => {
4951
- * console.error(e);
4952
- * throw e;
4953
- * });
4954
- *
4955
- * ```
4956
2074
  *
4957
2075
  * @param params - Parameters for request
4958
2076
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -4967,79 +2085,6 @@ export declare namespace storage_v1 {
4967
2085
  insert(callback: BodyResponseCallback<Schema$Object>): void;
4968
2086
  /**
4969
2087
  * Retrieves a list of objects matching the criteria.
4970
- * @example
4971
- * ```js
4972
- * // Before running the sample:
4973
- * // - Enable the API at:
4974
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
4975
- * // - Login into gcloud by running:
4976
- * // `$ gcloud auth application-default login`
4977
- * // - Install the npm module by running:
4978
- * // `$ npm install googleapis`
4979
- *
4980
- * const {google} = require('googleapis');
4981
- * const storage = google.storage('v1');
4982
- *
4983
- * async function main() {
4984
- * const auth = new google.auth.GoogleAuth({
4985
- * // Scopes can be specified either as an array or as a single, space-delimited string.
4986
- * scopes: [
4987
- * 'https://www.googleapis.com/auth/cloud-platform',
4988
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
4989
- * 'https://www.googleapis.com/auth/devstorage.full_control',
4990
- * 'https://www.googleapis.com/auth/devstorage.read_only',
4991
- * 'https://www.googleapis.com/auth/devstorage.read_write',
4992
- * ],
4993
- * });
4994
- *
4995
- * // Acquire an auth client, and bind it to all future calls
4996
- * const authClient = await auth.getClient();
4997
- * google.options({auth: authClient});
4998
- *
4999
- * // Do the magic
5000
- * const res = await storage.objects.list({
5001
- * // Name of the bucket in which to look for objects.
5002
- * bucket: 'placeholder-value',
5003
- * // Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
5004
- * delimiter: 'placeholder-value',
5005
- * // Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
5006
- * endOffset: 'placeholder-value',
5007
- * // If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
5008
- * includeTrailingDelimiter: 'placeholder-value',
5009
- * // Filter results to objects and prefixes that match this glob pattern.
5010
- * matchGlob: 'placeholder-value',
5011
- * // Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
5012
- * maxResults: 'placeholder-value',
5013
- * // A previously-returned page token representing part of the larger set of results to view.
5014
- * pageToken: 'placeholder-value',
5015
- * // Filter results to objects whose names begin with this prefix.
5016
- * prefix: 'placeholder-value',
5017
- * // Set of properties to return. Defaults to noAcl.
5018
- * projection: 'placeholder-value',
5019
- * // Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
5020
- * startOffset: 'placeholder-value',
5021
- * // The project to be billed for this request. Required for Requester Pays buckets.
5022
- * userProject: 'placeholder-value',
5023
- * // If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
5024
- * versions: 'placeholder-value',
5025
- * });
5026
- * console.log(res.data);
5027
- *
5028
- * // Example response
5029
- * // {
5030
- * // "items": [],
5031
- * // "kind": "my_kind",
5032
- * // "nextPageToken": "my_nextPageToken",
5033
- * // "prefixes": []
5034
- * // }
5035
- * }
5036
- *
5037
- * main().catch(e => {
5038
- * console.error(e);
5039
- * throw e;
5040
- * });
5041
- *
5042
- * ```
5043
2088
  *
5044
2089
  * @param params - Parameters for request
5045
2090
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5054,139 +2099,6 @@ export declare namespace storage_v1 {
5054
2099
  list(callback: BodyResponseCallback<Schema$Objects>): void;
5055
2100
  /**
5056
2101
  * Patches an object's metadata.
5057
- * @example
5058
- * ```js
5059
- * // Before running the sample:
5060
- * // - Enable the API at:
5061
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
5062
- * // - Login into gcloud by running:
5063
- * // `$ gcloud auth application-default login`
5064
- * // - Install the npm module by running:
5065
- * // `$ npm install googleapis`
5066
- *
5067
- * const {google} = require('googleapis');
5068
- * const storage = google.storage('v1');
5069
- *
5070
- * async function main() {
5071
- * const auth = new google.auth.GoogleAuth({
5072
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5073
- * scopes: [
5074
- * 'https://www.googleapis.com/auth/cloud-platform',
5075
- * 'https://www.googleapis.com/auth/devstorage.full_control',
5076
- * ],
5077
- * });
5078
- *
5079
- * // Acquire an auth client, and bind it to all future calls
5080
- * const authClient = await auth.getClient();
5081
- * google.options({auth: authClient});
5082
- *
5083
- * // Do the magic
5084
- * const res = await storage.objects.patch({
5085
- * // Name of the bucket in which the object resides.
5086
- * bucket: 'placeholder-value',
5087
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
5088
- * generation: 'placeholder-value',
5089
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
5090
- * ifGenerationMatch: 'placeholder-value',
5091
- * // Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
5092
- * ifGenerationNotMatch: 'placeholder-value',
5093
- * // Makes the operation conditional on whether the object's current metageneration matches the given value.
5094
- * ifMetagenerationMatch: 'placeholder-value',
5095
- * // Makes the operation conditional on whether the object's current metageneration does not match the given value.
5096
- * ifMetagenerationNotMatch: 'placeholder-value',
5097
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
5098
- * object: 'placeholder-value',
5099
- * // Apply a predefined set of access controls to this object.
5100
- * predefinedAcl: 'placeholder-value',
5101
- * // Set of properties to return. Defaults to full.
5102
- * projection: 'placeholder-value',
5103
- * // The project to be billed for this request, for Requester Pays buckets.
5104
- * userProject: 'placeholder-value',
5105
- *
5106
- * // Request body metadata
5107
- * requestBody: {
5108
- * // request body parameters
5109
- * // {
5110
- * // "acl": [],
5111
- * // "bucket": "my_bucket",
5112
- * // "cacheControl": "my_cacheControl",
5113
- * // "componentCount": 0,
5114
- * // "contentDisposition": "my_contentDisposition",
5115
- * // "contentEncoding": "my_contentEncoding",
5116
- * // "contentLanguage": "my_contentLanguage",
5117
- * // "contentType": "my_contentType",
5118
- * // "crc32c": "my_crc32c",
5119
- * // "customTime": "my_customTime",
5120
- * // "customerEncryption": {},
5121
- * // "etag": "my_etag",
5122
- * // "eventBasedHold": false,
5123
- * // "generation": "my_generation",
5124
- * // "id": "my_id",
5125
- * // "kind": "my_kind",
5126
- * // "kmsKeyName": "my_kmsKeyName",
5127
- * // "md5Hash": "my_md5Hash",
5128
- * // "mediaLink": "my_mediaLink",
5129
- * // "metadata": {},
5130
- * // "metageneration": "my_metageneration",
5131
- * // "name": "my_name",
5132
- * // "owner": {},
5133
- * // "retentionExpirationTime": "my_retentionExpirationTime",
5134
- * // "selfLink": "my_selfLink",
5135
- * // "size": "my_size",
5136
- * // "storageClass": "my_storageClass",
5137
- * // "temporaryHold": false,
5138
- * // "timeCreated": "my_timeCreated",
5139
- * // "timeDeleted": "my_timeDeleted",
5140
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
5141
- * // "updated": "my_updated"
5142
- * // }
5143
- * },
5144
- * });
5145
- * console.log(res.data);
5146
- *
5147
- * // Example response
5148
- * // {
5149
- * // "acl": [],
5150
- * // "bucket": "my_bucket",
5151
- * // "cacheControl": "my_cacheControl",
5152
- * // "componentCount": 0,
5153
- * // "contentDisposition": "my_contentDisposition",
5154
- * // "contentEncoding": "my_contentEncoding",
5155
- * // "contentLanguage": "my_contentLanguage",
5156
- * // "contentType": "my_contentType",
5157
- * // "crc32c": "my_crc32c",
5158
- * // "customTime": "my_customTime",
5159
- * // "customerEncryption": {},
5160
- * // "etag": "my_etag",
5161
- * // "eventBasedHold": false,
5162
- * // "generation": "my_generation",
5163
- * // "id": "my_id",
5164
- * // "kind": "my_kind",
5165
- * // "kmsKeyName": "my_kmsKeyName",
5166
- * // "md5Hash": "my_md5Hash",
5167
- * // "mediaLink": "my_mediaLink",
5168
- * // "metadata": {},
5169
- * // "metageneration": "my_metageneration",
5170
- * // "name": "my_name",
5171
- * // "owner": {},
5172
- * // "retentionExpirationTime": "my_retentionExpirationTime",
5173
- * // "selfLink": "my_selfLink",
5174
- * // "size": "my_size",
5175
- * // "storageClass": "my_storageClass",
5176
- * // "temporaryHold": false,
5177
- * // "timeCreated": "my_timeCreated",
5178
- * // "timeDeleted": "my_timeDeleted",
5179
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
5180
- * // "updated": "my_updated"
5181
- * // }
5182
- * }
5183
- *
5184
- * main().catch(e => {
5185
- * console.error(e);
5186
- * throw e;
5187
- * });
5188
- *
5189
- * ```
5190
2102
  *
5191
2103
  * @param params - Parameters for request
5192
2104
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5201,132 +2113,6 @@ export declare namespace storage_v1 {
5201
2113
  patch(callback: BodyResponseCallback<Schema$Object>): void;
5202
2114
  /**
5203
2115
  * Rewrites a source object to a destination object. Optionally overrides metadata.
5204
- * @example
5205
- * ```js
5206
- * // Before running the sample:
5207
- * // - Enable the API at:
5208
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
5209
- * // - Login into gcloud by running:
5210
- * // `$ gcloud auth application-default login`
5211
- * // - Install the npm module by running:
5212
- * // `$ npm install googleapis`
5213
- *
5214
- * const {google} = require('googleapis');
5215
- * const storage = google.storage('v1');
5216
- *
5217
- * async function main() {
5218
- * const auth = new google.auth.GoogleAuth({
5219
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5220
- * scopes: [
5221
- * 'https://www.googleapis.com/auth/cloud-platform',
5222
- * 'https://www.googleapis.com/auth/devstorage.full_control',
5223
- * 'https://www.googleapis.com/auth/devstorage.read_write',
5224
- * ],
5225
- * });
5226
- *
5227
- * // Acquire an auth client, and bind it to all future calls
5228
- * const authClient = await auth.getClient();
5229
- * google.options({auth: authClient});
5230
- *
5231
- * // Do the magic
5232
- * const res = await storage.objects.rewrite({
5233
- * // Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
5234
- * destinationBucket: 'placeholder-value',
5235
- * // Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
5236
- * destinationKmsKeyName: 'placeholder-value',
5237
- * // Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
5238
- * destinationObject: 'placeholder-value',
5239
- * // Apply a predefined set of access controls to the destination object.
5240
- * destinationPredefinedAcl: 'placeholder-value',
5241
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
5242
- * ifGenerationMatch: 'placeholder-value',
5243
- * // Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
5244
- * ifGenerationNotMatch: 'placeholder-value',
5245
- * // Makes the operation conditional on whether the destination object's current metageneration matches the given value.
5246
- * ifMetagenerationMatch: 'placeholder-value',
5247
- * // Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
5248
- * ifMetagenerationNotMatch: 'placeholder-value',
5249
- * // Makes the operation conditional on whether the source object's current generation matches the given value.
5250
- * ifSourceGenerationMatch: 'placeholder-value',
5251
- * // Makes the operation conditional on whether the source object's current generation does not match the given value.
5252
- * ifSourceGenerationNotMatch: 'placeholder-value',
5253
- * // Makes the operation conditional on whether the source object's current metageneration matches the given value.
5254
- * ifSourceMetagenerationMatch: 'placeholder-value',
5255
- * // Makes the operation conditional on whether the source object's current metageneration does not match the given value.
5256
- * ifSourceMetagenerationNotMatch: 'placeholder-value',
5257
- * // The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.
5258
- * maxBytesRewrittenPerCall: 'placeholder-value',
5259
- * // Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
5260
- * projection: 'placeholder-value',
5261
- * // Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
5262
- * rewriteToken: 'placeholder-value',
5263
- * // Name of the bucket in which to find the source object.
5264
- * sourceBucket: 'placeholder-value',
5265
- * // If present, selects a specific revision of the source object (as opposed to the latest version, the default).
5266
- * sourceGeneration: 'placeholder-value',
5267
- * // Name of the source object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
5268
- * sourceObject: 'placeholder-value',
5269
- * // The project to be billed for this request. Required for Requester Pays buckets.
5270
- * userProject: 'placeholder-value',
5271
- *
5272
- * // Request body metadata
5273
- * requestBody: {
5274
- * // request body parameters
5275
- * // {
5276
- * // "acl": [],
5277
- * // "bucket": "my_bucket",
5278
- * // "cacheControl": "my_cacheControl",
5279
- * // "componentCount": 0,
5280
- * // "contentDisposition": "my_contentDisposition",
5281
- * // "contentEncoding": "my_contentEncoding",
5282
- * // "contentLanguage": "my_contentLanguage",
5283
- * // "contentType": "my_contentType",
5284
- * // "crc32c": "my_crc32c",
5285
- * // "customTime": "my_customTime",
5286
- * // "customerEncryption": {},
5287
- * // "etag": "my_etag",
5288
- * // "eventBasedHold": false,
5289
- * // "generation": "my_generation",
5290
- * // "id": "my_id",
5291
- * // "kind": "my_kind",
5292
- * // "kmsKeyName": "my_kmsKeyName",
5293
- * // "md5Hash": "my_md5Hash",
5294
- * // "mediaLink": "my_mediaLink",
5295
- * // "metadata": {},
5296
- * // "metageneration": "my_metageneration",
5297
- * // "name": "my_name",
5298
- * // "owner": {},
5299
- * // "retentionExpirationTime": "my_retentionExpirationTime",
5300
- * // "selfLink": "my_selfLink",
5301
- * // "size": "my_size",
5302
- * // "storageClass": "my_storageClass",
5303
- * // "temporaryHold": false,
5304
- * // "timeCreated": "my_timeCreated",
5305
- * // "timeDeleted": "my_timeDeleted",
5306
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
5307
- * // "updated": "my_updated"
5308
- * // }
5309
- * },
5310
- * });
5311
- * console.log(res.data);
5312
- *
5313
- * // Example response
5314
- * // {
5315
- * // "done": false,
5316
- * // "kind": "my_kind",
5317
- * // "objectSize": "my_objectSize",
5318
- * // "resource": {},
5319
- * // "rewriteToken": "my_rewriteToken",
5320
- * // "totalBytesRewritten": "my_totalBytesRewritten"
5321
- * // }
5322
- * }
5323
- *
5324
- * main().catch(e => {
5325
- * console.error(e);
5326
- * throw e;
5327
- * });
5328
- *
5329
- * ```
5330
2116
  *
5331
2117
  * @param params - Parameters for request
5332
2118
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5341,74 +2127,6 @@ export declare namespace storage_v1 {
5341
2127
  rewrite(callback: BodyResponseCallback<Schema$RewriteResponse>): void;
5342
2128
  /**
5343
2129
  * Updates an IAM policy for the specified object.
5344
- * @example
5345
- * ```js
5346
- * // Before running the sample:
5347
- * // - Enable the API at:
5348
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
5349
- * // - Login into gcloud by running:
5350
- * // `$ gcloud auth application-default login`
5351
- * // - Install the npm module by running:
5352
- * // `$ npm install googleapis`
5353
- *
5354
- * const {google} = require('googleapis');
5355
- * const storage = google.storage('v1');
5356
- *
5357
- * async function main() {
5358
- * const auth = new google.auth.GoogleAuth({
5359
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5360
- * scopes: [
5361
- * 'https://www.googleapis.com/auth/cloud-platform',
5362
- * 'https://www.googleapis.com/auth/devstorage.full_control',
5363
- * 'https://www.googleapis.com/auth/devstorage.read_write',
5364
- * ],
5365
- * });
5366
- *
5367
- * // Acquire an auth client, and bind it to all future calls
5368
- * const authClient = await auth.getClient();
5369
- * google.options({auth: authClient});
5370
- *
5371
- * // Do the magic
5372
- * const res = await storage.objects.setIamPolicy({
5373
- * // Name of the bucket in which the object resides.
5374
- * bucket: 'placeholder-value',
5375
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
5376
- * generation: 'placeholder-value',
5377
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
5378
- * object: 'placeholder-value',
5379
- * // The project to be billed for this request. Required for Requester Pays buckets.
5380
- * userProject: 'placeholder-value',
5381
- *
5382
- * // Request body metadata
5383
- * requestBody: {
5384
- * // request body parameters
5385
- * // {
5386
- * // "bindings": [],
5387
- * // "etag": "my_etag",
5388
- * // "kind": "my_kind",
5389
- * // "resourceId": "my_resourceId",
5390
- * // "version": 0
5391
- * // }
5392
- * },
5393
- * });
5394
- * console.log(res.data);
5395
- *
5396
- * // Example response
5397
- * // {
5398
- * // "bindings": [],
5399
- * // "etag": "my_etag",
5400
- * // "kind": "my_kind",
5401
- * // "resourceId": "my_resourceId",
5402
- * // "version": 0
5403
- * // }
5404
- * }
5405
- *
5406
- * main().catch(e => {
5407
- * console.error(e);
5408
- * throw e;
5409
- * });
5410
- *
5411
- * ```
5412
2130
  *
5413
2131
  * @param params - Parameters for request
5414
2132
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5423,63 +2141,6 @@ export declare namespace storage_v1 {
5423
2141
  setIamPolicy(callback: BodyResponseCallback<Schema$Policy>): void;
5424
2142
  /**
5425
2143
  * Tests a set of permissions on the given object to see which, if any, are held by the caller.
5426
- * @example
5427
- * ```js
5428
- * // Before running the sample:
5429
- * // - Enable the API at:
5430
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
5431
- * // - Login into gcloud by running:
5432
- * // `$ gcloud auth application-default login`
5433
- * // - Install the npm module by running:
5434
- * // `$ npm install googleapis`
5435
- *
5436
- * const {google} = require('googleapis');
5437
- * const storage = google.storage('v1');
5438
- *
5439
- * async function main() {
5440
- * const auth = new google.auth.GoogleAuth({
5441
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5442
- * scopes: [
5443
- * 'https://www.googleapis.com/auth/cloud-platform',
5444
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
5445
- * 'https://www.googleapis.com/auth/devstorage.full_control',
5446
- * 'https://www.googleapis.com/auth/devstorage.read_only',
5447
- * 'https://www.googleapis.com/auth/devstorage.read_write',
5448
- * ],
5449
- * });
5450
- *
5451
- * // Acquire an auth client, and bind it to all future calls
5452
- * const authClient = await auth.getClient();
5453
- * google.options({auth: authClient});
5454
- *
5455
- * // Do the magic
5456
- * const res = await storage.objects.testIamPermissions({
5457
- * // Name of the bucket in which the object resides.
5458
- * bucket: 'placeholder-value',
5459
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
5460
- * generation: 'placeholder-value',
5461
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
5462
- * object: 'placeholder-value',
5463
- * // Permissions to test.
5464
- * permissions: 'placeholder-value',
5465
- * // The project to be billed for this request. Required for Requester Pays buckets.
5466
- * userProject: 'placeholder-value',
5467
- * });
5468
- * console.log(res.data);
5469
- *
5470
- * // Example response
5471
- * // {
5472
- * // "kind": "my_kind",
5473
- * // "permissions": []
5474
- * // }
5475
- * }
5476
- *
5477
- * main().catch(e => {
5478
- * console.error(e);
5479
- * throw e;
5480
- * });
5481
- *
5482
- * ```
5483
2144
  *
5484
2145
  * @param params - Parameters for request
5485
2146
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5494,139 +2155,6 @@ export declare namespace storage_v1 {
5494
2155
  testIamPermissions(callback: BodyResponseCallback<Schema$TestIamPermissionsResponse>): void;
5495
2156
  /**
5496
2157
  * Updates an object's metadata.
5497
- * @example
5498
- * ```js
5499
- * // Before running the sample:
5500
- * // - Enable the API at:
5501
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
5502
- * // - Login into gcloud by running:
5503
- * // `$ gcloud auth application-default login`
5504
- * // - Install the npm module by running:
5505
- * // `$ npm install googleapis`
5506
- *
5507
- * const {google} = require('googleapis');
5508
- * const storage = google.storage('v1');
5509
- *
5510
- * async function main() {
5511
- * const auth = new google.auth.GoogleAuth({
5512
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5513
- * scopes: [
5514
- * 'https://www.googleapis.com/auth/cloud-platform',
5515
- * 'https://www.googleapis.com/auth/devstorage.full_control',
5516
- * ],
5517
- * });
5518
- *
5519
- * // Acquire an auth client, and bind it to all future calls
5520
- * const authClient = await auth.getClient();
5521
- * google.options({auth: authClient});
5522
- *
5523
- * // Do the magic
5524
- * const res = await storage.objects.update({
5525
- * // Name of the bucket in which the object resides.
5526
- * bucket: 'placeholder-value',
5527
- * // If present, selects a specific revision of this object (as opposed to the latest version, the default).
5528
- * generation: 'placeholder-value',
5529
- * // Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
5530
- * ifGenerationMatch: 'placeholder-value',
5531
- * // Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
5532
- * ifGenerationNotMatch: 'placeholder-value',
5533
- * // Makes the operation conditional on whether the object's current metageneration matches the given value.
5534
- * ifMetagenerationMatch: 'placeholder-value',
5535
- * // Makes the operation conditional on whether the object's current metageneration does not match the given value.
5536
- * ifMetagenerationNotMatch: 'placeholder-value',
5537
- * // Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).
5538
- * object: 'placeholder-value',
5539
- * // Apply a predefined set of access controls to this object.
5540
- * predefinedAcl: 'placeholder-value',
5541
- * // Set of properties to return. Defaults to full.
5542
- * projection: 'placeholder-value',
5543
- * // The project to be billed for this request. Required for Requester Pays buckets.
5544
- * userProject: 'placeholder-value',
5545
- *
5546
- * // Request body metadata
5547
- * requestBody: {
5548
- * // request body parameters
5549
- * // {
5550
- * // "acl": [],
5551
- * // "bucket": "my_bucket",
5552
- * // "cacheControl": "my_cacheControl",
5553
- * // "componentCount": 0,
5554
- * // "contentDisposition": "my_contentDisposition",
5555
- * // "contentEncoding": "my_contentEncoding",
5556
- * // "contentLanguage": "my_contentLanguage",
5557
- * // "contentType": "my_contentType",
5558
- * // "crc32c": "my_crc32c",
5559
- * // "customTime": "my_customTime",
5560
- * // "customerEncryption": {},
5561
- * // "etag": "my_etag",
5562
- * // "eventBasedHold": false,
5563
- * // "generation": "my_generation",
5564
- * // "id": "my_id",
5565
- * // "kind": "my_kind",
5566
- * // "kmsKeyName": "my_kmsKeyName",
5567
- * // "md5Hash": "my_md5Hash",
5568
- * // "mediaLink": "my_mediaLink",
5569
- * // "metadata": {},
5570
- * // "metageneration": "my_metageneration",
5571
- * // "name": "my_name",
5572
- * // "owner": {},
5573
- * // "retentionExpirationTime": "my_retentionExpirationTime",
5574
- * // "selfLink": "my_selfLink",
5575
- * // "size": "my_size",
5576
- * // "storageClass": "my_storageClass",
5577
- * // "temporaryHold": false,
5578
- * // "timeCreated": "my_timeCreated",
5579
- * // "timeDeleted": "my_timeDeleted",
5580
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
5581
- * // "updated": "my_updated"
5582
- * // }
5583
- * },
5584
- * });
5585
- * console.log(res.data);
5586
- *
5587
- * // Example response
5588
- * // {
5589
- * // "acl": [],
5590
- * // "bucket": "my_bucket",
5591
- * // "cacheControl": "my_cacheControl",
5592
- * // "componentCount": 0,
5593
- * // "contentDisposition": "my_contentDisposition",
5594
- * // "contentEncoding": "my_contentEncoding",
5595
- * // "contentLanguage": "my_contentLanguage",
5596
- * // "contentType": "my_contentType",
5597
- * // "crc32c": "my_crc32c",
5598
- * // "customTime": "my_customTime",
5599
- * // "customerEncryption": {},
5600
- * // "etag": "my_etag",
5601
- * // "eventBasedHold": false,
5602
- * // "generation": "my_generation",
5603
- * // "id": "my_id",
5604
- * // "kind": "my_kind",
5605
- * // "kmsKeyName": "my_kmsKeyName",
5606
- * // "md5Hash": "my_md5Hash",
5607
- * // "mediaLink": "my_mediaLink",
5608
- * // "metadata": {},
5609
- * // "metageneration": "my_metageneration",
5610
- * // "name": "my_name",
5611
- * // "owner": {},
5612
- * // "retentionExpirationTime": "my_retentionExpirationTime",
5613
- * // "selfLink": "my_selfLink",
5614
- * // "size": "my_size",
5615
- * // "storageClass": "my_storageClass",
5616
- * // "temporaryHold": false,
5617
- * // "timeCreated": "my_timeCreated",
5618
- * // "timeDeleted": "my_timeDeleted",
5619
- * // "timeStorageClassUpdated": "my_timeStorageClassUpdated",
5620
- * // "updated": "my_updated"
5621
- * // }
5622
- * }
5623
- *
5624
- * main().catch(e => {
5625
- * console.error(e);
5626
- * throw e;
5627
- * });
5628
- *
5629
- * ```
5630
2158
  *
5631
2159
  * @param params - Parameters for request
5632
2160
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -5641,100 +2169,6 @@ export declare namespace storage_v1 {
5641
2169
  update(callback: BodyResponseCallback<Schema$Object>): void;
5642
2170
  /**
5643
2171
  * Watch for changes on all objects in a bucket.
5644
- * @example
5645
- * ```js
5646
- * // Before running the sample:
5647
- * // - Enable the API at:
5648
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
5649
- * // - Login into gcloud by running:
5650
- * // `$ gcloud auth application-default login`
5651
- * // - Install the npm module by running:
5652
- * // `$ npm install googleapis`
5653
- *
5654
- * const {google} = require('googleapis');
5655
- * const storage = google.storage('v1');
5656
- *
5657
- * async function main() {
5658
- * const auth = new google.auth.GoogleAuth({
5659
- * // Scopes can be specified either as an array or as a single, space-delimited string.
5660
- * scopes: [
5661
- * 'https://www.googleapis.com/auth/cloud-platform',
5662
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
5663
- * 'https://www.googleapis.com/auth/devstorage.full_control',
5664
- * 'https://www.googleapis.com/auth/devstorage.read_only',
5665
- * 'https://www.googleapis.com/auth/devstorage.read_write',
5666
- * ],
5667
- * });
5668
- *
5669
- * // Acquire an auth client, and bind it to all future calls
5670
- * const authClient = await auth.getClient();
5671
- * google.options({auth: authClient});
5672
- *
5673
- * // Do the magic
5674
- * const res = await storage.objects.watchAll({
5675
- * // Name of the bucket in which to look for objects.
5676
- * bucket: 'placeholder-value',
5677
- * // Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
5678
- * delimiter: 'placeholder-value',
5679
- * // Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
5680
- * endOffset: 'placeholder-value',
5681
- * // If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
5682
- * includeTrailingDelimiter: 'placeholder-value',
5683
- * // Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
5684
- * maxResults: 'placeholder-value',
5685
- * // A previously-returned page token representing part of the larger set of results to view.
5686
- * pageToken: 'placeholder-value',
5687
- * // Filter results to objects whose names begin with this prefix.
5688
- * prefix: 'placeholder-value',
5689
- * // Set of properties to return. Defaults to noAcl.
5690
- * projection: 'placeholder-value',
5691
- * // Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).
5692
- * startOffset: 'placeholder-value',
5693
- * // The project to be billed for this request. Required for Requester Pays buckets.
5694
- * userProject: 'placeholder-value',
5695
- * // If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
5696
- * versions: 'placeholder-value',
5697
- *
5698
- * // Request body metadata
5699
- * requestBody: {
5700
- * // request body parameters
5701
- * // {
5702
- * // "address": "my_address",
5703
- * // "expiration": "my_expiration",
5704
- * // "id": "my_id",
5705
- * // "kind": "my_kind",
5706
- * // "params": {},
5707
- * // "payload": false,
5708
- * // "resourceId": "my_resourceId",
5709
- * // "resourceUri": "my_resourceUri",
5710
- * // "token": "my_token",
5711
- * // "type": "my_type"
5712
- * // }
5713
- * },
5714
- * });
5715
- * console.log(res.data);
5716
- *
5717
- * // Example response
5718
- * // {
5719
- * // "address": "my_address",
5720
- * // "expiration": "my_expiration",
5721
- * // "id": "my_id",
5722
- * // "kind": "my_kind",
5723
- * // "params": {},
5724
- * // "payload": false,
5725
- * // "resourceId": "my_resourceId",
5726
- * // "resourceUri": "my_resourceUri",
5727
- * // "token": "my_token",
5728
- * // "type": "my_type"
5729
- * // }
5730
- * }
5731
- *
5732
- * main().catch(e => {
5733
- * console.error(e);
5734
- * throw e;
5735
- * });
5736
- *
5737
- * ```
5738
2172
  *
5739
2173
  * @param params - Parameters for request
5740
2174
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6338,57 +2772,6 @@ export declare namespace storage_v1 {
6338
2772
  constructor(context: APIRequestContext);
6339
2773
  /**
6340
2774
  * Creates a new HMAC key for the specified service account.
6341
- * @example
6342
- * ```js
6343
- * // Before running the sample:
6344
- * // - Enable the API at:
6345
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
6346
- * // - Login into gcloud by running:
6347
- * // `$ gcloud auth application-default login`
6348
- * // - Install the npm module by running:
6349
- * // `$ npm install googleapis`
6350
- *
6351
- * const {google} = require('googleapis');
6352
- * const storage = google.storage('v1');
6353
- *
6354
- * async function main() {
6355
- * const auth = new google.auth.GoogleAuth({
6356
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6357
- * scopes: [
6358
- * 'https://www.googleapis.com/auth/cloud-platform',
6359
- * 'https://www.googleapis.com/auth/devstorage.full_control',
6360
- * ],
6361
- * });
6362
- *
6363
- * // Acquire an auth client, and bind it to all future calls
6364
- * const authClient = await auth.getClient();
6365
- * google.options({auth: authClient});
6366
- *
6367
- * // Do the magic
6368
- * const res = await storage.projects.hmacKeys.create({
6369
- * // Project ID owning the service account.
6370
- * projectId: 'placeholder-value',
6371
- * // Email address of the service account.
6372
- * serviceAccountEmail: 'placeholder-value',
6373
- * // The project to be billed for this request.
6374
- * userProject: 'placeholder-value',
6375
- * });
6376
- * console.log(res.data);
6377
- *
6378
- * // Example response
6379
- * // {
6380
- * // "kind": "my_kind",
6381
- * // "metadata": {},
6382
- * // "secret": "my_secret"
6383
- * // }
6384
- * }
6385
- *
6386
- * main().catch(e => {
6387
- * console.error(e);
6388
- * throw e;
6389
- * });
6390
- *
6391
- * ```
6392
2775
  *
6393
2776
  * @param params - Parameters for request
6394
2777
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6403,51 +2786,6 @@ export declare namespace storage_v1 {
6403
2786
  create(callback: BodyResponseCallback<Schema$HmacKey>): void;
6404
2787
  /**
6405
2788
  * Deletes an HMAC key.
6406
- * @example
6407
- * ```js
6408
- * // Before running the sample:
6409
- * // - Enable the API at:
6410
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
6411
- * // - Login into gcloud by running:
6412
- * // `$ gcloud auth application-default login`
6413
- * // - Install the npm module by running:
6414
- * // `$ npm install googleapis`
6415
- *
6416
- * const {google} = require('googleapis');
6417
- * const storage = google.storage('v1');
6418
- *
6419
- * async function main() {
6420
- * const auth = new google.auth.GoogleAuth({
6421
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6422
- * scopes: [
6423
- * 'https://www.googleapis.com/auth/cloud-platform',
6424
- * 'https://www.googleapis.com/auth/devstorage.full_control',
6425
- * 'https://www.googleapis.com/auth/devstorage.read_write',
6426
- * ],
6427
- * });
6428
- *
6429
- * // Acquire an auth client, and bind it to all future calls
6430
- * const authClient = await auth.getClient();
6431
- * google.options({auth: authClient});
6432
- *
6433
- * // Do the magic
6434
- * const res = await storage.projects.hmacKeys.delete({
6435
- * // Name of the HMAC key to be deleted.
6436
- * accessId: 'placeholder-value',
6437
- * // Project ID owning the requested key
6438
- * projectId: 'placeholder-value',
6439
- * // The project to be billed for this request.
6440
- * userProject: 'placeholder-value',
6441
- * });
6442
- * console.log(res.data);
6443
- * }
6444
- *
6445
- * main().catch(e => {
6446
- * console.error(e);
6447
- * throw e;
6448
- * });
6449
- *
6450
- * ```
6451
2789
  *
6452
2790
  * @param params - Parameters for request
6453
2791
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6462,66 +2800,6 @@ export declare namespace storage_v1 {
6462
2800
  delete(callback: BodyResponseCallback<void>): void;
6463
2801
  /**
6464
2802
  * Retrieves an HMAC key's metadata
6465
- * @example
6466
- * ```js
6467
- * // Before running the sample:
6468
- * // - Enable the API at:
6469
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
6470
- * // - Login into gcloud by running:
6471
- * // `$ gcloud auth application-default login`
6472
- * // - Install the npm module by running:
6473
- * // `$ npm install googleapis`
6474
- *
6475
- * const {google} = require('googleapis');
6476
- * const storage = google.storage('v1');
6477
- *
6478
- * async function main() {
6479
- * const auth = new google.auth.GoogleAuth({
6480
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6481
- * scopes: [
6482
- * 'https://www.googleapis.com/auth/cloud-platform',
6483
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
6484
- * 'https://www.googleapis.com/auth/devstorage.full_control',
6485
- * 'https://www.googleapis.com/auth/devstorage.read_only',
6486
- * ],
6487
- * });
6488
- *
6489
- * // Acquire an auth client, and bind it to all future calls
6490
- * const authClient = await auth.getClient();
6491
- * google.options({auth: authClient});
6492
- *
6493
- * // Do the magic
6494
- * const res = await storage.projects.hmacKeys.get({
6495
- * // Name of the HMAC key.
6496
- * accessId: 'placeholder-value',
6497
- * // Project ID owning the service account of the requested key.
6498
- * projectId: 'placeholder-value',
6499
- * // The project to be billed for this request.
6500
- * userProject: 'placeholder-value',
6501
- * });
6502
- * console.log(res.data);
6503
- *
6504
- * // Example response
6505
- * // {
6506
- * // "accessId": "my_accessId",
6507
- * // "etag": "my_etag",
6508
- * // "id": "my_id",
6509
- * // "kind": "my_kind",
6510
- * // "projectId": "my_projectId",
6511
- * // "selfLink": "my_selfLink",
6512
- * // "serviceAccountEmail": "my_serviceAccountEmail",
6513
- * // "state": "my_state",
6514
- * // "timeCreated": "my_timeCreated",
6515
- * // "updated": "my_updated"
6516
- * // }
6517
- * }
6518
- *
6519
- * main().catch(e => {
6520
- * console.error(e);
6521
- * throw e;
6522
- * });
6523
- *
6524
- * ```
6525
2803
  *
6526
2804
  * @param params - Parameters for request
6527
2805
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6536,65 +2814,6 @@ export declare namespace storage_v1 {
6536
2814
  get(callback: BodyResponseCallback<Schema$HmacKeyMetadata>): void;
6537
2815
  /**
6538
2816
  * Retrieves a list of HMAC keys matching the criteria.
6539
- * @example
6540
- * ```js
6541
- * // Before running the sample:
6542
- * // - Enable the API at:
6543
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
6544
- * // - Login into gcloud by running:
6545
- * // `$ gcloud auth application-default login`
6546
- * // - Install the npm module by running:
6547
- * // `$ npm install googleapis`
6548
- *
6549
- * const {google} = require('googleapis');
6550
- * const storage = google.storage('v1');
6551
- *
6552
- * async function main() {
6553
- * const auth = new google.auth.GoogleAuth({
6554
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6555
- * scopes: [
6556
- * 'https://www.googleapis.com/auth/cloud-platform',
6557
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
6558
- * 'https://www.googleapis.com/auth/devstorage.full_control',
6559
- * 'https://www.googleapis.com/auth/devstorage.read_only',
6560
- * ],
6561
- * });
6562
- *
6563
- * // Acquire an auth client, and bind it to all future calls
6564
- * const authClient = await auth.getClient();
6565
- * google.options({auth: authClient});
6566
- *
6567
- * // Do the magic
6568
- * const res = await storage.projects.hmacKeys.list({
6569
- * // Maximum number of items to return in a single page of responses. The service uses this parameter or 250 items, whichever is smaller. The max number of items per page will also be limited by the number of distinct service accounts in the response. If the number of service accounts in a single response is too high, the page will truncated and a next page token will be returned.
6570
- * maxResults: 'placeholder-value',
6571
- * // A previously-returned page token representing part of the larger set of results to view.
6572
- * pageToken: 'placeholder-value',
6573
- * // Name of the project in which to look for HMAC keys.
6574
- * projectId: 'placeholder-value',
6575
- * // If present, only keys for the given service account are returned.
6576
- * serviceAccountEmail: 'placeholder-value',
6577
- * // Whether or not to show keys in the DELETED state.
6578
- * showDeletedKeys: 'placeholder-value',
6579
- * // The project to be billed for this request.
6580
- * userProject: 'placeholder-value',
6581
- * });
6582
- * console.log(res.data);
6583
- *
6584
- * // Example response
6585
- * // {
6586
- * // "items": [],
6587
- * // "kind": "my_kind",
6588
- * // "nextPageToken": "my_nextPageToken"
6589
- * // }
6590
- * }
6591
- *
6592
- * main().catch(e => {
6593
- * console.error(e);
6594
- * throw e;
6595
- * });
6596
- *
6597
- * ```
6598
2817
  *
6599
2818
  * @param params - Parameters for request
6600
2819
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6609,81 +2828,6 @@ export declare namespace storage_v1 {
6609
2828
  list(callback: BodyResponseCallback<Schema$HmacKeysMetadata>): void;
6610
2829
  /**
6611
2830
  * Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.
6612
- * @example
6613
- * ```js
6614
- * // Before running the sample:
6615
- * // - Enable the API at:
6616
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
6617
- * // - Login into gcloud by running:
6618
- * // `$ gcloud auth application-default login`
6619
- * // - Install the npm module by running:
6620
- * // `$ npm install googleapis`
6621
- *
6622
- * const {google} = require('googleapis');
6623
- * const storage = google.storage('v1');
6624
- *
6625
- * async function main() {
6626
- * const auth = new google.auth.GoogleAuth({
6627
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6628
- * scopes: [
6629
- * 'https://www.googleapis.com/auth/cloud-platform',
6630
- * 'https://www.googleapis.com/auth/devstorage.full_control',
6631
- * ],
6632
- * });
6633
- *
6634
- * // Acquire an auth client, and bind it to all future calls
6635
- * const authClient = await auth.getClient();
6636
- * google.options({auth: authClient});
6637
- *
6638
- * // Do the magic
6639
- * const res = await storage.projects.hmacKeys.update({
6640
- * // Name of the HMAC key being updated.
6641
- * accessId: 'placeholder-value',
6642
- * // Project ID owning the service account of the updated key.
6643
- * projectId: 'placeholder-value',
6644
- * // The project to be billed for this request.
6645
- * userProject: 'placeholder-value',
6646
- *
6647
- * // Request body metadata
6648
- * requestBody: {
6649
- * // request body parameters
6650
- * // {
6651
- * // "accessId": "my_accessId",
6652
- * // "etag": "my_etag",
6653
- * // "id": "my_id",
6654
- * // "kind": "my_kind",
6655
- * // "projectId": "my_projectId",
6656
- * // "selfLink": "my_selfLink",
6657
- * // "serviceAccountEmail": "my_serviceAccountEmail",
6658
- * // "state": "my_state",
6659
- * // "timeCreated": "my_timeCreated",
6660
- * // "updated": "my_updated"
6661
- * // }
6662
- * },
6663
- * });
6664
- * console.log(res.data);
6665
- *
6666
- * // Example response
6667
- * // {
6668
- * // "accessId": "my_accessId",
6669
- * // "etag": "my_etag",
6670
- * // "id": "my_id",
6671
- * // "kind": "my_kind",
6672
- * // "projectId": "my_projectId",
6673
- * // "selfLink": "my_selfLink",
6674
- * // "serviceAccountEmail": "my_serviceAccountEmail",
6675
- * // "state": "my_state",
6676
- * // "timeCreated": "my_timeCreated",
6677
- * // "updated": "my_updated"
6678
- * // }
6679
- * }
6680
- *
6681
- * main().catch(e => {
6682
- * console.error(e);
6683
- * throw e;
6684
- * });
6685
- *
6686
- * ```
6687
2831
  *
6688
2832
  * @param params - Parameters for request
6689
2833
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
@@ -6788,57 +2932,6 @@ export declare namespace storage_v1 {
6788
2932
  constructor(context: APIRequestContext);
6789
2933
  /**
6790
2934
  * Get the email address of this project's Google Cloud Storage service account.
6791
- * @example
6792
- * ```js
6793
- * // Before running the sample:
6794
- * // - Enable the API at:
6795
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
6796
- * // - Login into gcloud by running:
6797
- * // `$ gcloud auth application-default login`
6798
- * // - Install the npm module by running:
6799
- * // `$ npm install googleapis`
6800
- *
6801
- * const {google} = require('googleapis');
6802
- * const storage = google.storage('v1');
6803
- *
6804
- * async function main() {
6805
- * const auth = new google.auth.GoogleAuth({
6806
- * // Scopes can be specified either as an array or as a single, space-delimited string.
6807
- * scopes: [
6808
- * 'https://www.googleapis.com/auth/cloud-platform',
6809
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
6810
- * 'https://www.googleapis.com/auth/devstorage.full_control',
6811
- * 'https://www.googleapis.com/auth/devstorage.read_only',
6812
- * 'https://www.googleapis.com/auth/devstorage.read_write',
6813
- * ],
6814
- * });
6815
- *
6816
- * // Acquire an auth client, and bind it to all future calls
6817
- * const authClient = await auth.getClient();
6818
- * google.options({auth: authClient});
6819
- *
6820
- * // Do the magic
6821
- * const res = await storage.projects.serviceAccount.get({
6822
- * // Project ID
6823
- * projectId: 'placeholder-value',
6824
- * // The project to be billed for this request.
6825
- * userProject: 'placeholder-value',
6826
- * });
6827
- * console.log(res.data);
6828
- *
6829
- * // Example response
6830
- * // {
6831
- * // "email_address": "my_email_address",
6832
- * // "kind": "my_kind"
6833
- * // }
6834
- * }
6835
- *
6836
- * main().catch(e => {
6837
- * console.error(e);
6838
- * throw e;
6839
- * });
6840
- *
6841
- * ```
6842
2935
  *
6843
2936
  * @param params - Parameters for request
6844
2937
  * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.