@googleapis/storage 8.0.0 → 9.0.0

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/CHANGELOG.md CHANGED
@@ -1,5 +1,16 @@
1
1
  # Changelog
2
2
 
3
+ ## [9.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/storage-v8.0.0...storage-v9.0.0) (2024-02-02)
4
+
5
+
6
+ ### ⚠ BREAKING CHANGES
7
+
8
+ * **storage:** This release has breaking changes.
9
+
10
+ ### Features
11
+
12
+ * **storage:** update the API ([5bc62e5](https://github.com/googleapis/google-api-nodejs-client/commit/5bc62e590c1b44ced15de06dc08c53445fcd00d0))
13
+
3
14
  ## [8.0.0](https://github.com/googleapis/google-api-nodejs-client/compare/storage-v7.1.0...storage-v8.0.0) (2024-01-05)
4
15
 
5
16
 
package/build/v1.d.ts CHANGED
@@ -56,11 +56,12 @@ export declare namespace storage_v1 {
56
56
  */
57
57
  export class Storage {
58
58
  context: APIRequestContext;
59
- anywhereCache: Resource$Anywherecache;
59
+ anywhereCaches: Resource$Anywherecaches;
60
60
  bucketAccessControls: Resource$Bucketaccesscontrols;
61
61
  buckets: Resource$Buckets;
62
62
  channels: Resource$Channels;
63
63
  defaultObjectAccessControls: Resource$Defaultobjectaccesscontrols;
64
+ folders: Resource$Folders;
64
65
  managedFolders: Resource$Managedfolders;
65
66
  notifications: Resource$Notifications;
66
67
  objectAccessControls: Resource$Objectaccesscontrols;
@@ -117,6 +118,10 @@ export declare namespace storage_v1 {
117
118
  * The modification time of the cache instance metadata in RFC 3339 format.
118
119
  */
119
120
  updateTime?: string | null;
121
+ /**
122
+ * The zone in which the cache instance is running. For example, us-central1-a.
123
+ */
124
+ zone?: string | null;
120
125
  }
121
126
  /**
122
127
  * A list of Anywhere Caches.
@@ -191,6 +196,12 @@ export declare namespace storage_v1 {
191
196
  * HTTP 1.1 Entity tag for the bucket.
192
197
  */
193
198
  etag?: string | null;
199
+ /**
200
+ * The bucket's hierarchical namespace configuration.
201
+ */
202
+ hierarchicalNamespace?: {
203
+ enabled?: boolean;
204
+ } | null;
194
205
  /**
195
206
  * The bucket's IAM configuration.
196
207
  */
@@ -546,6 +557,72 @@ export declare namespace storage_v1 {
546
557
  */
547
558
  title?: string | null;
548
559
  }
560
+ /**
561
+ * A folder. Only available in buckets with hierarchical namespace enabled.
562
+ */
563
+ export interface Schema$Folder {
564
+ /**
565
+ * The name of the bucket containing this folder.
566
+ */
567
+ bucket?: string | null;
568
+ /**
569
+ * The ID of the folder, including the bucket name, folder name.
570
+ */
571
+ id?: string | null;
572
+ /**
573
+ * The kind of item this is. For folders, this is always storage#folder.
574
+ */
575
+ kind?: string | null;
576
+ /**
577
+ * User-provided metadata, in key/value pairs.
578
+ */
579
+ metadata?: {
580
+ [key: string]: string;
581
+ } | null;
582
+ /**
583
+ * The version of the metadata for this folder. Used for preconditions and for detecting changes in metadata.
584
+ */
585
+ metageneration?: string | null;
586
+ /**
587
+ * The name of the folder. Required if not specified by URL parameter.
588
+ */
589
+ name?: string | null;
590
+ /**
591
+ * Only present if the folder is part of an ongoing rename folder operation. Contains information which can be used to query the operation status.
592
+ */
593
+ pendingRenameInfo?: {
594
+ operationId?: string;
595
+ } | null;
596
+ /**
597
+ * The link to this folder.
598
+ */
599
+ selfLink?: string | null;
600
+ /**
601
+ * The creation time of the folder in RFC 3339 format.
602
+ */
603
+ timeCreated?: string | null;
604
+ /**
605
+ * The modification time of the folder metadata in RFC 3339 format.
606
+ */
607
+ updated?: string | null;
608
+ }
609
+ /**
610
+ * A list of folders.
611
+ */
612
+ export interface Schema$Folders {
613
+ /**
614
+ * The list of items.
615
+ */
616
+ items?: Schema$Folder[];
617
+ /**
618
+ * The kind of item this is. For lists of folders, this is always storage#folders.
619
+ */
620
+ kind?: string | null;
621
+ /**
622
+ * The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
623
+ */
624
+ nextPageToken?: string | null;
625
+ }
549
626
  /**
550
627
  * The response message for storage.buckets.operations.list.
551
628
  */
@@ -1161,7 +1238,7 @@ export declare namespace storage_v1 {
1161
1238
  */
1162
1239
  permissions?: string[] | null;
1163
1240
  }
1164
- export class Resource$Anywherecache {
1241
+ export class Resource$Anywherecaches {
1165
1242
  context: APIRequestContext;
1166
1243
  constructor(context: APIRequestContext);
1167
1244
  /**
@@ -1172,11 +1249,11 @@ export declare namespace storage_v1 {
1172
1249
  * @param callback - Optional callback that handles the response.
1173
1250
  * @returns A promise if used with async/await, or void if used with a callback.
1174
1251
  */
1175
- disable(params: Params$Resource$Anywherecache$Disable, options: StreamMethodOptions): GaxiosPromise<Readable>;
1176
- disable(params?: Params$Resource$Anywherecache$Disable, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1177
- disable(params: Params$Resource$Anywherecache$Disable, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1178
- disable(params: Params$Resource$Anywherecache$Disable, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1179
- disable(params: Params$Resource$Anywherecache$Disable, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1252
+ disable(params: Params$Resource$Anywherecaches$Disable, options: StreamMethodOptions): GaxiosPromise<Readable>;
1253
+ disable(params?: Params$Resource$Anywherecaches$Disable, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1254
+ disable(params: Params$Resource$Anywherecaches$Disable, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1255
+ disable(params: Params$Resource$Anywherecaches$Disable, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1256
+ disable(params: Params$Resource$Anywherecaches$Disable, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1180
1257
  disable(callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1181
1258
  /**
1182
1259
  * Returns the metadata of an Anywhere Cache instance.
@@ -1186,11 +1263,11 @@ export declare namespace storage_v1 {
1186
1263
  * @param callback - Optional callback that handles the response.
1187
1264
  * @returns A promise if used with async/await, or void if used with a callback.
1188
1265
  */
1189
- get(params: Params$Resource$Anywherecache$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
1190
- get(params?: Params$Resource$Anywherecache$Get, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1191
- get(params: Params$Resource$Anywherecache$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1192
- get(params: Params$Resource$Anywherecache$Get, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1193
- get(params: Params$Resource$Anywherecache$Get, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1266
+ get(params: Params$Resource$Anywherecaches$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
1267
+ get(params?: Params$Resource$Anywherecaches$Get, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1268
+ get(params: Params$Resource$Anywherecaches$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1269
+ get(params: Params$Resource$Anywherecaches$Get, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1270
+ get(params: Params$Resource$Anywherecaches$Get, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1194
1271
  get(callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1195
1272
  /**
1196
1273
  * Creates an Anywhere Cache instance.
@@ -1200,11 +1277,11 @@ export declare namespace storage_v1 {
1200
1277
  * @param callback - Optional callback that handles the response.
1201
1278
  * @returns A promise if used with async/await, or void if used with a callback.
1202
1279
  */
1203
- insert(params: Params$Resource$Anywherecache$Insert, options: StreamMethodOptions): GaxiosPromise<Readable>;
1204
- insert(params?: Params$Resource$Anywherecache$Insert, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
1205
- insert(params: Params$Resource$Anywherecache$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1206
- insert(params: Params$Resource$Anywherecache$Insert, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1207
- insert(params: Params$Resource$Anywherecache$Insert, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1280
+ insert(params: Params$Resource$Anywherecaches$Insert, options: StreamMethodOptions): GaxiosPromise<Readable>;
1281
+ insert(params?: Params$Resource$Anywherecaches$Insert, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
1282
+ insert(params: Params$Resource$Anywherecaches$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1283
+ insert(params: Params$Resource$Anywherecaches$Insert, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1284
+ insert(params: Params$Resource$Anywherecaches$Insert, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1208
1285
  insert(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1209
1286
  /**
1210
1287
  * Returns a list of Anywhere Cache instances of the bucket matching the criteria.
@@ -1214,11 +1291,11 @@ export declare namespace storage_v1 {
1214
1291
  * @param callback - Optional callback that handles the response.
1215
1292
  * @returns A promise if used with async/await, or void if used with a callback.
1216
1293
  */
1217
- list(params: Params$Resource$Anywherecache$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
1218
- list(params?: Params$Resource$Anywherecache$List, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCaches>;
1219
- list(params: Params$Resource$Anywherecache$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1220
- list(params: Params$Resource$Anywherecache$List, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCaches>, callback: BodyResponseCallback<Schema$AnywhereCaches>): void;
1221
- list(params: Params$Resource$Anywherecache$List, callback: BodyResponseCallback<Schema$AnywhereCaches>): void;
1294
+ list(params: Params$Resource$Anywherecaches$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
1295
+ list(params?: Params$Resource$Anywherecaches$List, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCaches>;
1296
+ list(params: Params$Resource$Anywherecaches$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1297
+ list(params: Params$Resource$Anywherecaches$List, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCaches>, callback: BodyResponseCallback<Schema$AnywhereCaches>): void;
1298
+ list(params: Params$Resource$Anywherecaches$List, callback: BodyResponseCallback<Schema$AnywhereCaches>): void;
1222
1299
  list(callback: BodyResponseCallback<Schema$AnywhereCaches>): void;
1223
1300
  /**
1224
1301
  * Pauses an Anywhere Cache instance.
@@ -1228,11 +1305,11 @@ export declare namespace storage_v1 {
1228
1305
  * @param callback - Optional callback that handles the response.
1229
1306
  * @returns A promise if used with async/await, or void if used with a callback.
1230
1307
  */
1231
- pause(params: Params$Resource$Anywherecache$Pause, options: StreamMethodOptions): GaxiosPromise<Readable>;
1232
- pause(params?: Params$Resource$Anywherecache$Pause, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1233
- pause(params: Params$Resource$Anywherecache$Pause, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1234
- pause(params: Params$Resource$Anywherecache$Pause, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1235
- pause(params: Params$Resource$Anywherecache$Pause, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1308
+ pause(params: Params$Resource$Anywherecaches$Pause, options: StreamMethodOptions): GaxiosPromise<Readable>;
1309
+ pause(params?: Params$Resource$Anywherecaches$Pause, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1310
+ pause(params: Params$Resource$Anywherecaches$Pause, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1311
+ pause(params: Params$Resource$Anywherecaches$Pause, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1312
+ pause(params: Params$Resource$Anywherecaches$Pause, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1236
1313
  pause(callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1237
1314
  /**
1238
1315
  * Resumes a paused or disabled Anywhere Cache instance.
@@ -1242,11 +1319,11 @@ export declare namespace storage_v1 {
1242
1319
  * @param callback - Optional callback that handles the response.
1243
1320
  * @returns A promise if used with async/await, or void if used with a callback.
1244
1321
  */
1245
- resume(params: Params$Resource$Anywherecache$Resume, options: StreamMethodOptions): GaxiosPromise<Readable>;
1246
- resume(params?: Params$Resource$Anywherecache$Resume, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1247
- resume(params: Params$Resource$Anywherecache$Resume, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1248
- resume(params: Params$Resource$Anywherecache$Resume, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1249
- resume(params: Params$Resource$Anywherecache$Resume, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1322
+ resume(params: Params$Resource$Anywherecaches$Resume, options: StreamMethodOptions): GaxiosPromise<Readable>;
1323
+ resume(params?: Params$Resource$Anywherecaches$Resume, options?: MethodOptions): GaxiosPromise<Schema$AnywhereCache>;
1324
+ resume(params: Params$Resource$Anywherecaches$Resume, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1325
+ resume(params: Params$Resource$Anywherecaches$Resume, options: MethodOptions | BodyResponseCallback<Schema$AnywhereCache>, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1326
+ resume(params: Params$Resource$Anywherecaches$Resume, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1250
1327
  resume(callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1251
1328
  /**
1252
1329
  * Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.
@@ -1256,36 +1333,36 @@ export declare namespace storage_v1 {
1256
1333
  * @param callback - Optional callback that handles the response.
1257
1334
  * @returns A promise if used with async/await, or void if used with a callback.
1258
1335
  */
1259
- update(params: Params$Resource$Anywherecache$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
1260
- update(params?: Params$Resource$Anywherecache$Update, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
1261
- update(params: Params$Resource$Anywherecache$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1262
- update(params: Params$Resource$Anywherecache$Update, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1263
- update(params: Params$Resource$Anywherecache$Update, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1336
+ update(params: Params$Resource$Anywherecaches$Update, options: StreamMethodOptions): GaxiosPromise<Readable>;
1337
+ update(params?: Params$Resource$Anywherecaches$Update, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
1338
+ update(params: Params$Resource$Anywherecaches$Update, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
1339
+ update(params: Params$Resource$Anywherecaches$Update, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1340
+ update(params: Params$Resource$Anywherecaches$Update, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1264
1341
  update(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
1265
1342
  }
1266
- export interface Params$Resource$Anywherecache$Disable extends StandardParameters {
1343
+ export interface Params$Resource$Anywherecaches$Disable extends StandardParameters {
1267
1344
  /**
1268
1345
  * The ID of requested Anywhere Cache instance.
1269
1346
  */
1270
1347
  anywhereCacheId?: string;
1271
1348
  /**
1272
- * Name of the partent bucket
1349
+ * Name of the parent bucket.
1273
1350
  */
1274
1351
  bucket?: string;
1275
1352
  }
1276
- export interface Params$Resource$Anywherecache$Get extends StandardParameters {
1353
+ export interface Params$Resource$Anywherecaches$Get extends StandardParameters {
1277
1354
  /**
1278
1355
  * The ID of requested Anywhere Cache instance.
1279
1356
  */
1280
1357
  anywhereCacheId?: string;
1281
1358
  /**
1282
- * Name of the partent bucket
1359
+ * Name of the parent bucket.
1283
1360
  */
1284
1361
  bucket?: string;
1285
1362
  }
1286
- export interface Params$Resource$Anywherecache$Insert extends StandardParameters {
1363
+ export interface Params$Resource$Anywherecaches$Insert extends StandardParameters {
1287
1364
  /**
1288
- * Name of the partent bucket
1365
+ * Name of the parent bucket.
1289
1366
  */
1290
1367
  bucket?: string;
1291
1368
  /**
@@ -1293,13 +1370,13 @@ export declare namespace storage_v1 {
1293
1370
  */
1294
1371
  requestBody?: Schema$AnywhereCache;
1295
1372
  }
1296
- export interface Params$Resource$Anywherecache$List extends StandardParameters {
1373
+ export interface Params$Resource$Anywherecaches$List extends StandardParameters {
1297
1374
  /**
1298
- * Name of the partent bucket
1375
+ * Name of the parent bucket.
1299
1376
  */
1300
1377
  bucket?: string;
1301
1378
  /**
1302
- * Maximum number of items return in a single page of responses. Maximum 1000.
1379
+ * Maximum number of items to return in a single page of responses. Maximum 1000.
1303
1380
  */
1304
1381
  pageSize?: number;
1305
1382
  /**
@@ -1307,33 +1384,33 @@ export declare namespace storage_v1 {
1307
1384
  */
1308
1385
  pageToken?: string;
1309
1386
  }
1310
- export interface Params$Resource$Anywherecache$Pause extends StandardParameters {
1387
+ export interface Params$Resource$Anywherecaches$Pause extends StandardParameters {
1311
1388
  /**
1312
1389
  * The ID of requested Anywhere Cache instance.
1313
1390
  */
1314
1391
  anywhereCacheId?: string;
1315
1392
  /**
1316
- * Name of the partent bucket
1393
+ * Name of the parent bucket.
1317
1394
  */
1318
1395
  bucket?: string;
1319
1396
  }
1320
- export interface Params$Resource$Anywherecache$Resume extends StandardParameters {
1397
+ export interface Params$Resource$Anywherecaches$Resume extends StandardParameters {
1321
1398
  /**
1322
1399
  * The ID of requested Anywhere Cache instance.
1323
1400
  */
1324
1401
  anywhereCacheId?: string;
1325
1402
  /**
1326
- * Name of the partent bucket
1403
+ * Name of the parent bucket.
1327
1404
  */
1328
1405
  bucket?: string;
1329
1406
  }
1330
- export interface Params$Resource$Anywherecache$Update extends StandardParameters {
1407
+ export interface Params$Resource$Anywherecaches$Update extends StandardParameters {
1331
1408
  /**
1332
1409
  * The ID of requested Anywhere Cache instance.
1333
1410
  */
1334
1411
  anywhereCacheId?: string;
1335
1412
  /**
1336
- * Name of the partent bucket
1413
+ * Name of the parent bucket.
1337
1414
  */
1338
1415
  bucket?: string;
1339
1416
  /**
@@ -2089,6 +2166,182 @@ export declare namespace storage_v1 {
2089
2166
  */
2090
2167
  requestBody?: Schema$ObjectAccessControl;
2091
2168
  }
2169
+ export class Resource$Folders {
2170
+ context: APIRequestContext;
2171
+ constructor(context: APIRequestContext);
2172
+ /**
2173
+ * Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.
2174
+ *
2175
+ * @param params - Parameters for request
2176
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2177
+ * @param callback - Optional callback that handles the response.
2178
+ * @returns A promise if used with async/await, or void if used with a callback.
2179
+ */
2180
+ delete(params: Params$Resource$Folders$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
2181
+ delete(params?: Params$Resource$Folders$Delete, options?: MethodOptions): GaxiosPromise<void>;
2182
+ delete(params: Params$Resource$Folders$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2183
+ delete(params: Params$Resource$Folders$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
2184
+ delete(params: Params$Resource$Folders$Delete, callback: BodyResponseCallback<void>): void;
2185
+ delete(callback: BodyResponseCallback<void>): void;
2186
+ /**
2187
+ * Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
2188
+ *
2189
+ * @param params - Parameters for request
2190
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2191
+ * @param callback - Optional callback that handles the response.
2192
+ * @returns A promise if used with async/await, or void if used with a callback.
2193
+ */
2194
+ get(params: Params$Resource$Folders$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
2195
+ get(params?: Params$Resource$Folders$Get, options?: MethodOptions): GaxiosPromise<Schema$Folder>;
2196
+ get(params: Params$Resource$Folders$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2197
+ get(params: Params$Resource$Folders$Get, options: MethodOptions | BodyResponseCallback<Schema$Folder>, callback: BodyResponseCallback<Schema$Folder>): void;
2198
+ get(params: Params$Resource$Folders$Get, callback: BodyResponseCallback<Schema$Folder>): void;
2199
+ get(callback: BodyResponseCallback<Schema$Folder>): void;
2200
+ /**
2201
+ * Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.
2202
+ *
2203
+ * @param params - Parameters for request
2204
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2205
+ * @param callback - Optional callback that handles the response.
2206
+ * @returns A promise if used with async/await, or void if used with a callback.
2207
+ */
2208
+ insert(params: Params$Resource$Folders$Insert, options: StreamMethodOptions): GaxiosPromise<Readable>;
2209
+ insert(params?: Params$Resource$Folders$Insert, options?: MethodOptions): GaxiosPromise<Schema$Folder>;
2210
+ insert(params: Params$Resource$Folders$Insert, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2211
+ insert(params: Params$Resource$Folders$Insert, options: MethodOptions | BodyResponseCallback<Schema$Folder>, callback: BodyResponseCallback<Schema$Folder>): void;
2212
+ insert(params: Params$Resource$Folders$Insert, callback: BodyResponseCallback<Schema$Folder>): void;
2213
+ insert(callback: BodyResponseCallback<Schema$Folder>): void;
2214
+ /**
2215
+ * Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.
2216
+ *
2217
+ * @param params - Parameters for request
2218
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2219
+ * @param callback - Optional callback that handles the response.
2220
+ * @returns A promise if used with async/await, or void if used with a callback.
2221
+ */
2222
+ list(params: Params$Resource$Folders$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
2223
+ list(params?: Params$Resource$Folders$List, options?: MethodOptions): GaxiosPromise<Schema$Folders>;
2224
+ list(params: Params$Resource$Folders$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2225
+ list(params: Params$Resource$Folders$List, options: MethodOptions | BodyResponseCallback<Schema$Folders>, callback: BodyResponseCallback<Schema$Folders>): void;
2226
+ list(params: Params$Resource$Folders$List, callback: BodyResponseCallback<Schema$Folders>): void;
2227
+ list(callback: BodyResponseCallback<Schema$Folders>): void;
2228
+ /**
2229
+ * Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.
2230
+ *
2231
+ * @param params - Parameters for request
2232
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
2233
+ * @param callback - Optional callback that handles the response.
2234
+ * @returns A promise if used with async/await, or void if used with a callback.
2235
+ */
2236
+ rename(params: Params$Resource$Folders$Rename, options: StreamMethodOptions): GaxiosPromise<Readable>;
2237
+ rename(params?: Params$Resource$Folders$Rename, options?: MethodOptions): GaxiosPromise<Schema$GoogleLongrunningOperation>;
2238
+ rename(params: Params$Resource$Folders$Rename, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
2239
+ rename(params: Params$Resource$Folders$Rename, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
2240
+ rename(params: Params$Resource$Folders$Rename, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
2241
+ rename(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
2242
+ }
2243
+ export interface Params$Resource$Folders$Delete extends StandardParameters {
2244
+ /**
2245
+ * Name of the bucket in which the folder resides.
2246
+ */
2247
+ bucket?: string;
2248
+ /**
2249
+ * Name of a folder.
2250
+ */
2251
+ folder?: string;
2252
+ /**
2253
+ * If set, only deletes the folder if its metageneration matches this value.
2254
+ */
2255
+ ifMetagenerationMatch?: string;
2256
+ /**
2257
+ * If set, only deletes the folder if its metageneration does not match this value.
2258
+ */
2259
+ ifMetagenerationNotMatch?: string;
2260
+ }
2261
+ export interface Params$Resource$Folders$Get extends StandardParameters {
2262
+ /**
2263
+ * Name of the bucket in which the folder resides.
2264
+ */
2265
+ bucket?: string;
2266
+ /**
2267
+ * Name of a folder.
2268
+ */
2269
+ folder?: string;
2270
+ /**
2271
+ * Makes the return of the folder metadata conditional on whether the folder's current metageneration matches the given value.
2272
+ */
2273
+ ifMetagenerationMatch?: string;
2274
+ /**
2275
+ * Makes the return of the folder metadata conditional on whether the folder's current metageneration does not match the given value.
2276
+ */
2277
+ ifMetagenerationNotMatch?: string;
2278
+ }
2279
+ export interface Params$Resource$Folders$Insert extends StandardParameters {
2280
+ /**
2281
+ * Name of the bucket in which the folder resides.
2282
+ */
2283
+ bucket?: string;
2284
+ /**
2285
+ * If true, any parent folder which doesn’t exist will be created automatically.
2286
+ */
2287
+ recursive?: boolean;
2288
+ /**
2289
+ * Request body metadata
2290
+ */
2291
+ requestBody?: Schema$Folder;
2292
+ }
2293
+ export interface Params$Resource$Folders$List extends StandardParameters {
2294
+ /**
2295
+ * Name of the bucket in which to look for folders.
2296
+ */
2297
+ bucket?: string;
2298
+ /**
2299
+ * Returns results in a directory-like mode. The only supported value is '/'. If set, items will only contain folders that either exactly match the prefix, or are one level below the prefix.
2300
+ */
2301
+ delimiter?: string;
2302
+ /**
2303
+ * Filter results to folders whose names are lexicographically before endOffset. If startOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
2304
+ */
2305
+ endOffset?: string;
2306
+ /**
2307
+ * Maximum number of items to return in a single page of responses.
2308
+ */
2309
+ pageSize?: number;
2310
+ /**
2311
+ * A previously-returned page token representing part of the larger set of results to view.
2312
+ */
2313
+ pageToken?: string;
2314
+ /**
2315
+ * Filter results to folders whose paths begin with this prefix. If set, the value must either be an empty string or end with a '/'.
2316
+ */
2317
+ prefix?: string;
2318
+ /**
2319
+ * Filter results to folders whose names are lexicographically equal to or after startOffset. If endOffset is also set, the folders listed will have names between startOffset (inclusive) and endOffset (exclusive).
2320
+ */
2321
+ startOffset?: string;
2322
+ }
2323
+ export interface Params$Resource$Folders$Rename extends StandardParameters {
2324
+ /**
2325
+ * Name of the bucket in which the folders are in.
2326
+ */
2327
+ bucket?: string;
2328
+ /**
2329
+ * Name of the destination folder.
2330
+ */
2331
+ destinationFolder?: string;
2332
+ /**
2333
+ * Makes the operation conditional on whether the source object's current metageneration matches the given value.
2334
+ */
2335
+ ifSourceMetagenerationMatch?: string;
2336
+ /**
2337
+ * Makes the operation conditional on whether the source object's current metageneration does not match the given value.
2338
+ */
2339
+ ifSourceMetagenerationNotMatch?: string;
2340
+ /**
2341
+ * Name of the source folder.
2342
+ */
2343
+ sourceFolder?: string;
2344
+ }
2092
2345
  export class Resource$Managedfolders {
2093
2346
  context: APIRequestContext;
2094
2347
  constructor(context: APIRequestContext);
@@ -2261,7 +2514,7 @@ export declare namespace storage_v1 {
2261
2514
  */
2262
2515
  bucket?: string;
2263
2516
  /**
2264
- * Maximum number of items return in a single page of responses.
2517
+ * Maximum number of items to return in a single page of responses.
2265
2518
  */
2266
2519
  pageSize?: number;
2267
2520
  /**