@googleapis/storage 21.1.0 → 21.3.0

package/v1.ts

@@ -176,6 +176,10 @@ export namespace storage_v1 {
      * The ID of the resource, including the project number, bucket name and anywhere cache ID.
      */
     id?: string | null;
+    /**
+     * Specifies whether objects are ingested into the cache upon write.
+     */
+    ingestOnWrite?: boolean | null;
     /**
      * The kind of item this is. For Anywhere Cache, this is always storage#anywhereCache.
      */
@@ -1462,6 +1466,7 @@ export namespace storage_v1 {
      *   //   "bucket": "my_bucket",
      *   //   "createTime": "my_createTime",
      *   //   "id": "my_id",
+     *   //   "ingestOnWrite": false,
      *   //   "kind": "my_kind",
      *   //   "pendingUpdate": false,
      *   //   "selfLink": "my_selfLink",
@@ -1618,6 +1623,7 @@ export namespace storage_v1 {
      *   //   "bucket": "my_bucket",
      *   //   "createTime": "my_createTime",
      *   //   "id": "my_id",
+     *   //   "ingestOnWrite": false,
      *   //   "kind": "my_kind",
      *   //   "pendingUpdate": false,
      *   //   "selfLink": "my_selfLink",
@@ -1770,6 +1776,7 @@ export namespace storage_v1 {
      *       //   "bucket": "my_bucket",
      *       //   "createTime": "my_createTime",
      *       //   "id": "my_id",
+     *       //   "ingestOnWrite": false,
      *       //   "kind": "my_kind",
      *       //   "pendingUpdate": false,
      *       //   "selfLink": "my_selfLink",
@@ -2091,6 +2098,7 @@ export namespace storage_v1 {
      *   //   "bucket": "my_bucket",
      *   //   "createTime": "my_createTime",
      *   //   "id": "my_id",
+     *   //   "ingestOnWrite": false,
      *   //   "kind": "my_kind",
      *   //   "pendingUpdate": false,
      *   //   "selfLink": "my_selfLink",
@@ -2245,6 +2253,7 @@ export namespace storage_v1 {
      *   //   "bucket": "my_bucket",
      *   //   "createTime": "my_createTime",
      *   //   "id": "my_id",
+     *   //   "ingestOnWrite": false,
      *   //   "kind": "my_kind",
      *   //   "pendingUpdate": false,
      *   //   "selfLink": "my_selfLink",
@@ -2351,7 +2360,7 @@ export namespace storage_v1 {
     }
 
     /**
-     * Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.
+     * Updates the config of an Anywhere Cache instance.
      * @example
      * ```js
      * // Before running the sample:
@@ -2399,6 +2408,7 @@ export namespace storage_v1 {
      *       //   "bucket": "my_bucket",
      *       //   "createTime": "my_createTime",
      *       //   "id": "my_id",
+     *       //   "ingestOnWrite": false,
      *       //   "kind": "my_kind",
      *       //   "pendingUpdate": false,
      *       //   "selfLink": "my_selfLink",
@@ -7634,6 +7644,163 @@ export namespace storage_v1 {
       }
     }
 
+    /**
+     * Deletes a folder recursively. Only applicable to buckets with hierarchical namespace enabled.
+     * @example
+     * ```js
+     * // Before running the sample:
+     * // - Enable the API at:
+     * //   https://console.developers.google.com/apis/api/storage.googleapis.com
+     * // - Login into gcloud by running:
+     * //   ```sh
+     * //   $ gcloud auth application-default login
+     * //   ```
+     * // - Install the npm module by running:
+     * //   ```sh
+     * //   $ npm install googleapis
+     * //   ```
+     *
+     * const {google} = require('googleapis');
+     * const storage = google.storage('v1');
+     *
+     * async function main() {
+     *   const auth = new google.auth.GoogleAuth({
+     *     // Scopes can be specified either as an array or as a single, space-delimited string.
+     *     scopes: [
+     *       'https://www.googleapis.com/auth/cloud-platform',
+     *       'https://www.googleapis.com/auth/devstorage.full_control',
+     *       'https://www.googleapis.com/auth/devstorage.read_write',
+     *     ],
+     *   });
+     *
+     *   // Acquire an auth client, and bind it to all future calls
+     *   const authClient = await auth.getClient();
+     *   google.options({auth: authClient});
+     *
+     *   // Do the magic
+     *   const res = await storage.folders.deleteRecursive({
+     *     // Name of the bucket in which the folder resides.
+     *     bucket: 'placeholder-value',
+     *     // Name of a folder.
+     *     folder: 'placeholder-value',
+     *     // If set, only deletes the folder if its metageneration matches this value.
+     *     ifMetagenerationMatch: 'placeholder-value',
+     *     // If set, only deletes the folder if its metageneration does not match this value.
+     *     ifMetagenerationNotMatch: 'placeholder-value',
+     *   });
+     *   console.log(res.data);
+     *
+     *   // Example response
+     *   // {
+     *   //   "done": false,
+     *   //   "error": {},
+     *   //   "kind": "my_kind",
+     *   //   "metadata": {},
+     *   //   "name": "my_name",
+     *   //   "response": {},
+     *   //   "selfLink": "my_selfLink"
+     *   // }
+     * }
+     *
+     * main().catch(e => {
+     *   console.error(e);
+     *   throw e;
+     * });
+     *
+     * ```
+     *
+     * @param params - Parameters for request
+     * @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
+     * @param callback - Optional callback that handles the response.
+     * @returns A promise if used with async/await, or void if used with a callback.
+     */
+    deleteRecursive(
+      params: Params$Resource$Folders$Deleterecursive,
+      options: StreamMethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Readable>>;
+    deleteRecursive(
+      params?: Params$Resource$Folders$Deleterecursive,
+      options?: MethodOptions
+    ): Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>;
+    deleteRecursive(
+      params: Params$Resource$Folders$Deleterecursive,
+      options: StreamMethodOptions | BodyResponseCallback<Readable>,
+      callback: BodyResponseCallback<Readable>
+    ): void;
+    deleteRecursive(
+      params: Params$Resource$Folders$Deleterecursive,
+      options:
+        | MethodOptions
+        | BodyResponseCallback<Schema$GoogleLongrunningOperation>,
+      callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
+    ): void;
+    deleteRecursive(
+      params: Params$Resource$Folders$Deleterecursive,
+      callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
+    ): void;
+    deleteRecursive(
+      callback: BodyResponseCallback<Schema$GoogleLongrunningOperation>
+    ): void;
+    deleteRecursive(
+      paramsOrCallback?:
+        | Params$Resource$Folders$Deleterecursive
+        | BodyResponseCallback<Schema$GoogleLongrunningOperation>
+        | BodyResponseCallback<Readable>,
+      optionsOrCallback?:
+        | MethodOptions
+        | StreamMethodOptions
+        | BodyResponseCallback<Schema$GoogleLongrunningOperation>
+        | BodyResponseCallback<Readable>,
+      callback?:
+        | BodyResponseCallback<Schema$GoogleLongrunningOperation>
+        | BodyResponseCallback<Readable>
+    ):
+      | void
+      | Promise<GaxiosResponseWithHTTP2<Schema$GoogleLongrunningOperation>>
+      | Promise<GaxiosResponseWithHTTP2<Readable>> {
+      let params = (paramsOrCallback ||
+        {}) as Params$Resource$Folders$Deleterecursive;
+      let options = (optionsOrCallback || {}) as MethodOptions;
+
+      if (typeof paramsOrCallback === 'function') {
+        callback = paramsOrCallback;
+        params = {} as Params$Resource$Folders$Deleterecursive;
+        options = {};
+      }
+
+      if (typeof optionsOrCallback === 'function') {
+        callback = optionsOrCallback;
+        options = {};
+      }
+
+      const rootUrl = options.rootUrl || 'https://storage.googleapis.com/';
+      const parameters = {
+        options: Object.assign(
+          {
+            url: (
+              rootUrl +
+              '/storage/v1/b/{bucket}/folders/{folder}/deleteRecursive'
+            ).replace(/([^:]\/)\/+/g, '$1'),
+            method: 'POST',
+            apiVersion: '',
+          },
+          options
+        ),
+        params,
+        requiredParams: ['bucket', 'folder'],
+        pathParams: ['bucket', 'folder'],
+        context: this.context,
+      };
+      if (callback) {
+        createAPIRequest<Schema$GoogleLongrunningOperation>(
+          parameters,
+          callback as BodyResponseCallback<unknown>
+        );
+      } else {
+        return createAPIRequest<Schema$GoogleLongrunningOperation>(parameters);
+      }
+    }
+
     /**
      * Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.
      * @example
@@ -8289,6 +8456,24 @@ export namespace storage_v1 {
      */
     ifMetagenerationNotMatch?: string;
   }
+  export interface Params$Resource$Folders$Deleterecursive extends StandardParameters {
+    /**
+     * Name of the bucket in which the folder resides.
+     */
+    bucket?: string;
+    /**
+     * Name of a folder.
+     */
+    folder?: string;
+    /**
+     * If set, only deletes the folder if its metageneration matches this value.
+     */
+    ifMetagenerationMatch?: string;
+    /**
+     * If set, only deletes the folder if its metageneration does not match this value.
+     */
+    ifMetagenerationNotMatch?: string;
+  }
   export interface Params$Resource$Folders$Get extends StandardParameters {
     /**
      * Name of the bucket in which the folder resides.
@@ -11592,6 +11777,8 @@ export namespace storage_v1 {
      *     destinationObject: 'placeholder-value',
      *     // Apply a predefined set of access controls to the destination object.
      *     destinationPredefinedAcl: 'placeholder-value',
+     *     // Specifies which groups of Object Contexts from the source object(s) should be dropped from the destination object.
+     *     dropContextGroups: 'placeholder-value',
      *     // 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.
      *     ifGenerationMatch: 'placeholder-value',
      *     // Makes the operation conditional on whether the object's current metageneration matches the given value.
@@ -13617,6 +13804,8 @@ export namespace storage_v1 {
      *     destinationObject: 'placeholder-value',
      *     // Apply a predefined set of access controls to the destination object.
      *     destinationPredefinedAcl: 'placeholder-value',
+     *     // Specifies which groups of Object Contexts from the source object should be dropped from the destination object.
+     *     dropContextGroups: 'placeholder-value',
      *     // 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.
      *     ifGenerationMatch: 'placeholder-value',
      *     // 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.
@@ -14582,6 +14771,10 @@ export namespace storage_v1 {
      * Apply a predefined set of access controls to the destination object.
      */
     destinationPredefinedAcl?: string;
+    /**
+     * Specifies which groups of Object Contexts from the source object(s) should be dropped from the destination object.
+     */
+    dropContextGroups?: string[];
     /**
      * 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.
      */
@@ -15073,6 +15266,10 @@ export namespace storage_v1 {
      * Apply a predefined set of access controls to the destination object.
      */
     destinationPredefinedAcl?: string;
+    /**
+     * Specifies which groups of Object Contexts from the source object should be dropped from the destination object.
+     */
+    dropContextGroups?: string[];
     /**
      * 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.
      */