@googleapis/storage 21.2.0 → 22.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/build/v1.d.ts CHANGED
@@ -106,6 +106,10 @@ export declare namespace storage_v1 {
106
106
  * The ID of the resource, including the project number, bucket name and anywhere cache ID.
107
107
  */
108
108
  id?: string | null;
109
+ /**
110
+ * Specifies whether objects are ingested into the cache upon write.
111
+ */
112
+ ingestOnWrite?: boolean | null;
109
113
  /**
110
114
  * The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.
111
115
  */
@@ -299,6 +303,8 @@ export declare namespace storage_v1 {
299
303
  matchesSuffix?: string[];
300
304
  noncurrentTimeBefore?: string;
301
305
  numNewerVersions?: number;
306
+ sizeAboveBytes?: string;
307
+ sizeBelowBytes?: string;
302
308
  };
303
309
  }>;
304
310
  } | null;
@@ -1456,6 +1462,7 @@ export declare namespace storage_v1 {
1456
1462
  * // "bucket": "my_bucket",
1457
1463
  * // "createTime": "my_createTime",
1458
1464
  * // "id": "my_id",
1465
+ * // "ingestOnWrite": false,
1459
1466
  * // "kind": "my_kind",
1460
1467
  * // "pendingUpdate": false,
1461
1468
  * // "selfLink": "my_selfLink",
@@ -1535,6 +1542,7 @@ export declare namespace storage_v1 {
1535
1542
  * // "bucket": "my_bucket",
1536
1543
  * // "createTime": "my_createTime",
1537
1544
  * // "id": "my_id",
1545
+ * // "ingestOnWrite": false,
1538
1546
  * // "kind": "my_kind",
1539
1547
  * // "pendingUpdate": false,
1540
1548
  * // "selfLink": "my_selfLink",
@@ -1610,6 +1618,7 @@ export declare namespace storage_v1 {
1610
1618
  * // "bucket": "my_bucket",
1611
1619
  * // "createTime": "my_createTime",
1612
1620
  * // "id": "my_id",
1621
+ * // "ingestOnWrite": false,
1613
1622
  * // "kind": "my_kind",
1614
1623
  * // "pendingUpdate": false,
1615
1624
  * // "selfLink": "my_selfLink",
@@ -1773,6 +1782,7 @@ export declare namespace storage_v1 {
1773
1782
  * // "bucket": "my_bucket",
1774
1783
  * // "createTime": "my_createTime",
1775
1784
  * // "id": "my_id",
1785
+ * // "ingestOnWrite": false,
1776
1786
  * // "kind": "my_kind",
1777
1787
  * // "pendingUpdate": false,
1778
1788
  * // "selfLink": "my_selfLink",
@@ -1850,6 +1860,7 @@ export declare namespace storage_v1 {
1850
1860
  * // "bucket": "my_bucket",
1851
1861
  * // "createTime": "my_createTime",
1852
1862
  * // "id": "my_id",
1863
+ * // "ingestOnWrite": false,
1853
1864
  * // "kind": "my_kind",
1854
1865
  * // "pendingUpdate": false,
1855
1866
  * // "selfLink": "my_selfLink",
@@ -1879,7 +1890,7 @@ export declare namespace storage_v1 {
1879
1890
  resume(params: Params$Resource$Anywherecaches$Resume, callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1880
1891
  resume(callback: BodyResponseCallback<Schema$AnywhereCache>): void;
1881
1892
  /**
1882
- * Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.
1893
+ * Updates the config of an Anywhere Cache instance.
1883
1894
  * @example
1884
1895
  * ```js
1885
1896
  * // Before running the sample:
@@ -1927,6 +1938,7 @@ export declare namespace storage_v1 {
1927
1938
  * // "bucket": "my_bucket",
1928
1939
  * // "createTime": "my_createTime",
1929
1940
  * // "id": "my_id",
1941
+ * // "ingestOnWrite": false,
1930
1942
  * // "kind": "my_kind",
1931
1943
  * // "pendingUpdate": false,
1932
1944
  * // "selfLink": "my_selfLink",
@@ -4987,6 +4999,82 @@ export declare namespace storage_v1 {
4987
4999
  delete(params: Params$Resource$Folders$Delete, options: MethodOptions | BodyResponseCallback<void>, callback: BodyResponseCallback<void>): void;
4988
5000
  delete(params: Params$Resource$Folders$Delete, callback: BodyResponseCallback<void>): void;
4989
5001
  delete(callback: BodyResponseCallback<void>): void;
5002
+ /**
5003
+ * Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled.
5004
+ * @example
5005
+ * ```js
5006
+ * // Before running the sample:
5007
+ * // - Enable the API at:
5008
+ * // https://console.developers.google.com/apis/api/storage.googleapis.com
5009
+ * // - Login into gcloud by running:
5010
+ * // ```sh
5011
+ * // $ gcloud auth application-default login
5012
+ * // ```
5013
+ * // - Install the npm module by running:
5014
+ * // ```sh
5015
+ * // $ npm install googleapis
5016
+ * // ```
5017
+ *
5018
+ * const {google} = require('googleapis');
5019
+ * const storage = google.storage('v1');
5020
+ *
5021
+ * async function main() {
5022
+ * const auth = new google.auth.GoogleAuth({
5023
+ * // Scopes can be specified either as an array or as a single, space-delimited string.
5024
+ * scopes: [
5025
+ * 'https://www.googleapis.com/auth/cloud-platform',
5026
+ * 'https://www.googleapis.com/auth/devstorage.full_control',
5027
+ * 'https://www.googleapis.com/auth/devstorage.read_write',
5028
+ * ],
5029
+ * });
5030
+ *
5031
+ * // Acquire an auth client, and bind it to all future calls
5032
+ * const authClient = await auth.getClient();
5033
+ * google.options({auth: authClient});
5034
+ *
5035
+ * // Do the magic
5036
+ * const res = await storage.folders.deleteRecursive({
5037
+ * // Name of the bucket in which the folder resides.
5038
+ * bucket: 'placeholder-value',
5039
+ * // Name of a folder.
5040
+ * folder: 'placeholder-value',
5041
+ * // If set, only deletes the folder if its metageneration matches this value.
5042
+ * ifMetagenerationMatch: 'placeholder-value',
5043
+ * // If set, only deletes the folder if its metageneration does not match this value.
5044
+ * ifMetagenerationNotMatch: 'placeholder-value',
5045
+ * });
5046
+ * console.log(res.data);
5047
+ *
5048
+ * // Example response
5049
+ * // {
5050
+ * // "done": false,
5051
+ * // "error": {},
5052
+ * // "kind": "my_kind",
5053
+ * // "metadata": {},
5054
+ * // "name": "my_name",
5055
+ * // "response": {},
5056
+ * // "selfLink": "my_selfLink"
5057
+ * // }
5058
+ * }
5059
+ *
5060
+ * main().catch(e => {
5061
+ * console.error(e);
5062
+ * throw e;
5063
+ * });
5064
+ *
5065
+ * ```
5066
+ *
5067
+ * @param params - Parameters for request
5068
+ * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
5069
+ * @param callback - Optional callback that handles the response.
5070
+ * @returns A promise if used with async/await, or void if used with a callback.
5071
+ */
5072
+ deleteRecursive(params: Params$Resource$Folders$Deleterecursive, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
5073
+ deleteRecursive(params?: Params$Resource$Folders$Deleterecursive, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
5074
+ deleteRecursive(params: Params$Resource$Folders$Deleterecursive, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
5075
+ deleteRecursive(params: Params$Resource$Folders$Deleterecursive, options: MethodOptions | BodyResponseCallback<Schema$GoogleLongrunningOperation>, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5076
+ deleteRecursive(params: Params$Resource$Folders$Deleterecursive, callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
5077
+ deleteRecursive(callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>): void;
4990
5078
  /**
4991
5079
  * Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
4992
5080
  * @example
@@ -5334,6 +5422,24 @@ export declare namespace storage_v1 {
5334
5422
  */
5335
5423
  ifMetagenerationNotMatch?: string;
5336
5424
  }
5425
+ export interface Params$Resource$Folders$Deleterecursive extends StandardParameters {
5426
+ /**
5427
+ * Name of the bucket in which the folder resides.
5428
+ */
5429
+ bucket?: string;
5430
+ /**
5431
+ * Name of a folder.
5432
+ */
5433
+ folder?: string;
5434
+ /**
5435
+ * If set, only deletes the folder if its metageneration matches this value.
5436
+ */
5437
+ ifMetagenerationMatch?: string;
5438
+ /**
5439
+ * If set, only deletes the folder if its metageneration does not match this value.
5440
+ */
5441
+ ifMetagenerationNotMatch?: string;
5442
+ }
5337
5443
  export interface Params$Resource$Folders$Get extends StandardParameters {
5338
5444
  /**
5339
5445
  * Name of the bucket in which the folder resides.
@@ -8922,118 +9028,6 @@ export declare namespace storage_v1 {
8922
9028
  update(params: Params$Resource$Objects$Update, options: MethodOptions | BodyResponseCallback<Schema$Object>, callback: BodyResponseCallback<Schema$Object>): void;
8923
9029
  update(params: Params$Resource$Objects$Update, callback: BodyResponseCallback<Schema$Object>): void;
8924
9030
  update(callback: BodyResponseCallback<Schema$Object>): void;
8925
- /**
8926
- * Watch for changes on all objects in a bucket.
8927
- * @example
8928
- * ```js
8929
- * // Before running the sample:
8930
- * // - Enable the API at:
8931
- * // https://console.developers.google.com/apis/api/storage.googleapis.com
8932
- * // - Login into gcloud by running:
8933
- * // ```sh
8934
- * // $ gcloud auth application-default login
8935
- * // ```
8936
- * // - Install the npm module by running:
8937
- * // ```sh
8938
- * // $ npm install googleapis
8939
- * // ```
8940
- *
8941
- * const {google} = require('googleapis');
8942
- * const storage = google.storage('v1');
8943
- *
8944
- * async function main() {
8945
- * const auth = new google.auth.GoogleAuth({
8946
- * // Scopes can be specified either as an array or as a single, space-delimited string.
8947
- * scopes: [
8948
- * 'https://www.googleapis.com/auth/cloud-platform',
8949
- * 'https://www.googleapis.com/auth/cloud-platform.read-only',
8950
- * 'https://www.googleapis.com/auth/devstorage.full_control',
8951
- * 'https://www.googleapis.com/auth/devstorage.read_only',
8952
- * 'https://www.googleapis.com/auth/devstorage.read_write',
8953
- * ],
8954
- * });
8955
- *
8956
- * // Acquire an auth client, and bind it to all future calls
8957
- * const authClient = await auth.getClient();
8958
- * google.options({auth: authClient});
8959
- *
8960
- * // Do the magic
8961
- * const res = await storage.objects.watchAll({
8962
- * // Name of the bucket in which to look for objects.
8963
- * bucket: 'placeholder-value',
8964
- * // 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.
8965
- * delimiter: 'placeholder-value',
8966
- * // 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).
8967
- * endOffset: 'placeholder-value',
8968
- * // If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
8969
- * includeTrailingDelimiter: 'placeholder-value',
8970
- * // 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.
8971
- * maxResults: 'placeholder-value',
8972
- * // A previously-returned page token representing part of the larger set of results to view.
8973
- * pageToken: 'placeholder-value',
8974
- * // Filter results to objects whose names begin with this prefix.
8975
- * prefix: 'placeholder-value',
8976
- * // Set of properties to return. Defaults to noAcl.
8977
- * projection: 'placeholder-value',
8978
- * // 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).
8979
- * startOffset: 'placeholder-value',
8980
- * // The project to be billed for this request. Required for Requester Pays buckets.
8981
- * userProject: 'placeholder-value',
8982
- * // If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).
8983
- * versions: 'placeholder-value',
8984
- *
8985
- * // Request body metadata
8986
- * requestBody: {
8987
- * // request body parameters
8988
- * // {
8989
- * // "address": "my_address",
8990
- * // "expiration": "my_expiration",
8991
- * // "id": "my_id",
8992
- * // "kind": "my_kind",
8993
- * // "params": {},
8994
- * // "payload": false,
8995
- * // "resourceId": "my_resourceId",
8996
- * // "resourceUri": "my_resourceUri",
8997
- * // "token": "my_token",
8998
- * // "type": "my_type"
8999
- * // }
9000
- * },
9001
- * });
9002
- * console.log(res.data);
9003
- *
9004
- * // Example response
9005
- * // {
9006
- * // "address": "my_address",
9007
- * // "expiration": "my_expiration",
9008
- * // "id": "my_id",
9009
- * // "kind": "my_kind",
9010
- * // "params": {},
9011
- * // "payload": false,
9012
- * // "resourceId": "my_resourceId",
9013
- * // "resourceUri": "my_resourceUri",
9014
- * // "token": "my_token",
9015
- * // "type": "my_type"
9016
- * // }
9017
- * }
9018
- *
9019
- * main().catch(e => {
9020
- * console.error(e);
9021
- * throw e;
9022
- * });
9023
- *
9024
- * ```
9025
- *
9026
- * @param params - Parameters for request
9027
- * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
9028
- * @param callback - Optional callback that handles the response.
9029
- * @returns A promise if used with async/await, or void if used with a callback.
9030
- */
9031
- watchAll(params: Params$Resource$Objects$Watchall, options: StreamMethodOptions): Promise<GaxiosResponseWithHTTP2<Readable>>;
9032
- watchAll(params?: Params$Resource$Objects$Watchall, options?: MethodOptions): Promise<GaxiosResponseWithHTTP2<Schema$Channel>>;
9033
- watchAll(params: Params$Resource$Objects$Watchall, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
9034
- watchAll(params: Params$Resource$Objects$Watchall, options: MethodOptions | BodyResponseCallback<Schema$Channel>, callback: BodyResponseCallback<Schema$Channel>): void;
9035
- watchAll(params: Params$Resource$Objects$Watchall, callback: BodyResponseCallback<Schema$Channel>): void;
9036
- watchAll(callback: BodyResponseCallback<Schema$Channel>): void;
9037
9031
  }
9038
9032
  export interface Params$Resource$Objects$Bulkrestore extends StandardParameters {
9039
9033
  /**
@@ -9710,56 +9704,6 @@ export declare namespace storage_v1 {
9710
9704
  */
9711
9705
  requestBody?: Schema$Object;
9712
9706
  }
9713
- export interface Params$Resource$Objects$Watchall extends StandardParameters {
9714
- /**
9715
- * Name of the bucket in which to look for objects.
9716
- */
9717
- bucket?: string;
9718
- /**
9719
- * 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.
9720
- */
9721
- delimiter?: string;
9722
- /**
9723
- * 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).
9724
- */
9725
- endOffset?: string;
9726
- /**
9727
- * If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.
9728
- */
9729
- includeTrailingDelimiter?: boolean;
9730
- /**
9731
- * 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.
9732
- */
9733
- maxResults?: number;
9734
- /**
9735
- * A previously-returned page token representing part of the larger set of results to view.
9736
- */
9737
- pageToken?: string;
9738
- /**
9739
- * Filter results to objects whose names begin with this prefix.
9740
- */
9741
- prefix?: string;
9742
- /**
9743
- * Set of properties to return. Defaults to noAcl.
9744
- */
9745
- projection?: string;
9746
- /**
9747
- * 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).
9748
- */
9749
- startOffset?: string;
9750
- /**
9751
- * The project to be billed for this request. Required for Requester Pays buckets.
9752
- */
9753
- userProject?: string;
9754
- /**
9755
- * If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).
9756
- */
9757
- versions?: boolean;
9758
- /**
9759
- * Request body metadata
9760
- */
9761
- requestBody?: Schema$Channel;
9762
- }
9763
9707
  export class Resource$Operations {
9764
9708
  context: APIRequestContext;
9765
9709
  constructor(context: APIRequestContext);
package/build/v1.js CHANGED
@@ -1190,6 +1190,39 @@ var storage_v1;
1190
1190
  return (0, googleapis_common_1.createAPIRequest)(parameters);
1191
1191
  }
1192
1192
  }
1193
+ deleteRecursive(paramsOrCallback, optionsOrCallback, callback) {
1194
+ let params = (paramsOrCallback ||
1195
+ {});
1196
+ let options = (optionsOrCallback || {});
1197
+ if (typeof paramsOrCallback === 'function') {
1198
+ callback = paramsOrCallback;
1199
+ params = {};
1200
+ options = {};
1201
+ }
1202
+ if (typeof optionsOrCallback === 'function') {
1203
+ callback = optionsOrCallback;
1204
+ options = {};
1205
+ }
1206
+ const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
1207
+ const parameters = {
1208
+ options: Object.assign({
1209
+ url: (rootUrl +
1210
+ '/storage/v1/b/{bucket}/folders/{folder}/deleteRecursive').replace(/([^:]\/)\/+/g, '$1'),
1211
+ method: 'POST',
1212
+ apiVersion: '',
1213
+ }, options),
1214
+ params,
1215
+ requiredParams: ['bucket', 'folder'],
1216
+ pathParams: ['bucket', 'folder'],
1217
+ context: this.context,
1218
+ };
1219
+ if (callback) {
1220
+ (0, googleapis_common_1.createAPIRequest)(parameters, callback);
1221
+ }
1222
+ else {
1223
+ return (0, googleapis_common_1.createAPIRequest)(parameters);
1224
+ }
1225
+ }
1193
1226
  get(paramsOrCallback, optionsOrCallback, callback) {
1194
1227
  let params = (paramsOrCallback || {});
1195
1228
  let options = (optionsOrCallback || {});
@@ -2386,37 +2419,6 @@ var storage_v1;
2386
2419
  return (0, googleapis_common_1.createAPIRequest)(parameters);
2387
2420
  }
2388
2421
  }
2389
- watchAll(paramsOrCallback, optionsOrCallback, callback) {
2390
- let params = (paramsOrCallback || {});
2391
- let options = (optionsOrCallback || {});
2392
- if (typeof paramsOrCallback === 'function') {
2393
- callback = paramsOrCallback;
2394
- params = {};
2395
- options = {};
2396
- }
2397
- if (typeof optionsOrCallback === 'function') {
2398
- callback = optionsOrCallback;
2399
- options = {};
2400
- }
2401
- const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
2402
- const parameters = {
2403
- options: Object.assign({
2404
- url: (rootUrl + '/storage/v1/b/{bucket}/o/watch').replace(/([^:]\/)\/+/g, '$1'),
2405
- method: 'POST',
2406
- apiVersion: '',
2407
- }, options),
2408
- params,
2409
- requiredParams: ['bucket'],
2410
- pathParams: ['bucket'],
2411
- context: this.context,
2412
- };
2413
- if (callback) {
2414
- (0, googleapis_common_1.createAPIRequest)(parameters, callback);
2415
- }
2416
- else {
2417
- return (0, googleapis_common_1.createAPIRequest)(parameters);
2418
- }
2419
- }
2420
2422
  }
2421
2423
  storage_v1.Resource$Objects = Resource$Objects;
2422
2424
  class Resource$Operations {