@google-cloud/discoveryengine 0.5.0 → 0.6.0

package/build/src/v1beta/document_service_client.d.ts

@@ -319,6 +319,69 @@ export declare class DocumentServiceClient {
      * region_tag:discoveryengine_v1beta_generated_DocumentService_ImportDocuments_async
      */
     checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata>>;
+    /**
+     * Permanently deletes all selected
+     * {@link google.cloud.discoveryengine.v1beta.Document|Document}s in a branch.
+     *
+     * This process is asynchronous. Depending on the number of
+     * {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
+     * this operation can take hours to complete. Before the delete operation
+     * completes, some {@link google.cloud.discoveryengine.v1beta.Document|Document}s
+     * might still be returned by
+     * {@link google.cloud.discoveryengine.v1beta.DocumentService.GetDocument|DocumentService.GetDocument}
+     * or
+     * {@link google.cloud.discoveryengine.v1beta.DocumentService.ListDocuments|DocumentService.ListDocuments}.
+     *
+     * To get a list of the
+     * {@link google.cloud.discoveryengine.v1beta.Document|Document}s to be deleted,
+     * set
+     * {@link google.cloud.discoveryengine.v1beta.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
+     * to false.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource name, such as
+     *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
+     * @param {string} request.filter
+     *   Required. Filter matching documents to purge. Only currently supported
+     *   value is
+     *   `*` (all items).
+     * @param {boolean} request.force
+     *   Actually performs the purge. If `force` is set to false, return the
+     *   expected purge count without deleting any documents.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing
+     *   a long running operation. Its `promise()` method returns a promise
+     *   you can `await` for.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
+     */
+    purgeDocuments(request?: protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    purgeDocuments(request: protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    purgeDocuments(request: protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeDocumentsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `purgeDocuments()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
+     */
+    checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata>>;
     /**
      * Gets a list of {@link google.cloud.discoveryengine.v1beta.Document|Document}s.
      *

package/build/src/v1beta/document_service_client.js

@@ -223,8 +223,11 @@ class DocumentServiceClient {
             .operationsClient(opts);
         const importDocumentsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.ImportDocumentsResponse');
         const importDocumentsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata');
+        const purgeDocumentsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse');
+        const purgeDocumentsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata');
         this.descriptors.longrunning = {
             importDocuments: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importDocumentsResponse.decode.bind(importDocumentsResponse), importDocumentsMetadata.decode.bind(importDocumentsMetadata)),
+            purgeDocuments: new this._gaxModule.LongrunningDescriptor(this.operationsClient, purgeDocumentsResponse.decode.bind(purgeDocumentsResponse), purgeDocumentsMetadata.decode.bind(purgeDocumentsMetadata)),
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1beta.DocumentService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -267,6 +270,7 @@ class DocumentServiceClient {
             'updateDocument',
             'deleteDocument',
             'importDocuments',
+            'purgeDocuments',
         ];
         for (const methodName of documentServiceStubMethods) {
             const callPromise = this.documentServiceStub.then(stub => (...args) => {
@@ -450,6 +454,45 @@ class DocumentServiceClient {
         const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.importDocuments, this._gaxModule.createDefaultBackoffSettings());
         return decodeOperation;
     }
+    purgeDocuments(request, optionsOrCallback, callback) {
+        var _a;
+        request = request || {};
+        let options;
+        if (typeof optionsOrCallback === 'function' && callback === undefined) {
+            callback = optionsOrCallback;
+            options = {};
+        }
+        else {
+            options = optionsOrCallback;
+        }
+        options = options || {};
+        options.otherArgs = options.otherArgs || {};
+        options.otherArgs.headers = options.otherArgs.headers || {};
+        options.otherArgs.headers['x-goog-request-params'] =
+            this._gaxModule.routingHeader.fromParams({
+                parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.purgeDocuments(request, options, callback);
+    }
+    /**
+     * Check the status of the long running operation returned by `purgeDocuments()`.
+     * @param {String} name
+     *   The operation name that will be passed.
+     * @returns {Promise} - The promise which resolves to an object.
+     *   The decoded operation object has result and metadata field to get information from.
+     *   Please see the
+     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/document_service.purge_documents.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_DocumentService_PurgeDocuments_async
+     */
+    async checkPurgeDocumentsProgress(name) {
+        const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
+        const [operation] = await this.operationsClient.getOperation(request);
+        const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.purgeDocuments, this._gaxModule.createDefaultBackoffSettings());
+        return decodeOperation;
+    }
     listDocuments(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};

package/build/src/v1beta/document_service_client_config.json

@@ -70,6 +70,11 @@
                     "timeout_millis": 300000,
                     "retry_codes_name": "unavailable",
                     "retry_params_name": "e6a9f61a856ca7c2128ab9550ca4fb9e97c77876"
+                },
+                "PurgeDocuments": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 }
             }
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/discoveryengine",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "description": "Discovery Engine API client for Node.js",
   "repository": {
     "type": "git",
@@ -31,7 +31,7 @@
   ],
   "scripts": {
     "clean": "gts clean",
-    "compile": "tsc -p . && cp -r protos build/ && minifyProtoJson",
+    "compile": "tsc -p . && cp -r protos build/",
     "compile-protos": "compileProtos src",
     "docs": "jsdoc -c .jsdoc.js",
     "predocs-test": "npm run docs",
@@ -39,10 +39,11 @@
     "fix": "gts fix",
     "lint": "gts check",
     "prepare": "npm run compile-protos && npm run compile",
-    "system-test": "npm run compile && c8 mocha build/system-test",
-    "test": "c8 mocha build/test",
-    "samples-test": "npm run compile && cd samples/ && npm link ../ && npm i && npm test",
-    "prelint": "cd samples; npm link ../; npm i"
+    "prelint": "cd samples; npm link ../; npm i",
+    "postpack": "minifyProtoJson",
+    "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
+    "system-test": "c8 mocha build/system-test",
+    "test": "c8 mocha build/test"
   },
   "dependencies": {
     "google-gax": "^3.5.8"
@@ -57,6 +58,7 @@
     "jsdoc-fresh": "^2.0.0",
     "jsdoc-region-tag": "^2.0.0",
     "linkinator": "^4.0.0",
+    "long": "^5.2.3",
     "mocha": "^9.2.2",
     "null-loader": "^4.0.1",
     "pack-n-play": "^1.0.0-2",