@google-cloud/discoveryengine 1.11.0 → 1.12.0

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

@@ -192,6 +192,81 @@ export declare class UserEventServiceClient {
     ]>;
     collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
     collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Deletes permanently all user events specified by the filter provided.
+     * Depending on the number of events specified by the filter, this operation
+     * could take hours or days to complete. To test a filter, use the list
+     * command first.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The resource name of the catalog under which the events are
+     *   created. The format is
+     *   `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}`
+     * @param {string} request.filter
+     *   Required. The filter string to specify the events to be deleted with a
+     *   length limit of 5,000 characters. The eligible fields for filtering are:
+     *
+     *   * `eventType`: Double quoted
+     *   {@link protos.google.cloud.discoveryengine.v1beta.UserEvent.event_type|UserEvent.event_type}
+     *   string.
+     *   * `eventTime`: in ISO 8601 "zulu" format.
+     *   * `userPseudoId`: Double quoted string. Specifying this will delete all
+     *     events associated with a visitor.
+     *   * `userId`: Double quoted string. Specifying this will delete all events
+     *     associated with a user.
+     *
+     *   Examples:
+     *
+     *   * Deleting all events in a time range:
+     *     `eventTime > "2012-04-23T18:25:43.511Z"
+     *     eventTime < "2012-04-23T18:30:43.511Z"`
+     *   * Deleting specific eventType:
+     *     `eventType = "search"`
+     *   * Deleting all events for a specific visitor:
+     *     `userPseudoId = "visitor1024"`
+     *   * Deleting all events inside a DataStore:
+     *     `*`
+     *
+     *   The filtering fields are assumed to have an implicit AND.
+     * @param {boolean} request.force
+     *   The `force` field is currently not supported. Purge user event requests
+     *   will permanently delete all purgeable events. Once the development is
+     *   complete:
+     *   If `force` is set to false, the method will return the expected
+     *   purge count without deleting any user events. This field will default to
+     *   false if not included in the request.
+     * @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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_async
+     */
+    purgeUserEvents(request?: protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    purgeUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    purgeUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IPurgeUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `purgeUserEvents()`.
+     * @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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_async
+     */
+    checkPurgeUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.PurgeUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.PurgeUserEventsMetadata>>;
     /**
      * Bulk import of user events. Request processing might be
      * synchronous. Events that already exist are skipped.

package/build/src/v1beta/user_event_service_client.js

@@ -301,9 +301,12 @@ class UserEventServiceClient {
         this.operationsClient = this._gaxModule
             .lro(lroOptions)
             .operationsClient(opts);
+        const purgeUserEventsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.PurgeUserEventsResponse');
+        const purgeUserEventsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.PurgeUserEventsMetadata');
         const importUserEventsResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.ImportUserEventsResponse');
         const importUserEventsMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata');
         this.descriptors.longrunning = {
+            purgeUserEvents: new this._gaxModule.LongrunningDescriptor(this.operationsClient, purgeUserEventsResponse.decode.bind(purgeUserEventsResponse), purgeUserEventsMetadata.decode.bind(purgeUserEventsMetadata)),
             importUserEvents: new this._gaxModule.LongrunningDescriptor(this.operationsClient, importUserEventsResponse.decode.bind(importUserEventsResponse), importUserEventsMetadata.decode.bind(importUserEventsMetadata)),
         };
         // Put together the default options sent with requests.
@@ -343,6 +346,7 @@ class UserEventServiceClient {
         const userEventServiceStubMethods = [
             'writeUserEvent',
             'collectUserEvent',
+            'purgeUserEvents',
             'importUserEvents',
         ];
         for (const methodName of userEventServiceStubMethods) {
@@ -463,6 +467,44 @@ class UserEventServiceClient {
         this.initialize();
         return this.innerApiCalls.collectUserEvent(request, options, callback);
     }
+    purgeUserEvents(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.purgeUserEvents(request, options, callback);
+    }
+    /**
+     * Check the status of the long running operation returned by `purgeUserEvents()`.
+     * @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 {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1beta/user_event_service.purge_user_events.js</caption>
+     * region_tag:discoveryengine_v1beta_generated_UserEventService_PurgeUserEvents_async
+     */
+    async checkPurgeUserEventsProgress(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.purgeUserEvents, this._gaxModule.createDefaultBackoffSettings());
+        return decodeOperation;
+    }
     importUserEvents(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};

package/build/src/v1beta/user_event_service_client_config.json

@@ -51,6 +51,11 @@
                     "retry_codes_name": "unavailable",
                     "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
                 },
+                "PurgeUserEvents": {
+                    "timeout_millis": 30000,
+                    "retry_codes_name": "unavailable",
+                    "retry_params_name": "ce5b960a6ed052e690863808e4f0deff3dc7d49f"
+                },
                 "ImportUserEvents": {
                     "timeout_millis": 300000,
                     "retry_codes_name": "unavailable",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/discoveryengine",
-  "version": "1.11.0",
+  "version": "1.12.0",
   "description": "Discovery Engine API client for Node.js",
   "repository": {
     "type": "git",