@google-cloud/discoveryengine 1.12.0 → 1.13.0

package/build/src/v1alpha/site_search_engine_service_client.d.ts

@@ -180,6 +180,33 @@ export declare class SiteSearchEngineServiceClient {
     ]>;
     getTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
     getTargetSite(request: protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ITargetSite, protos.google.cloud.discoveryengine.v1alpha.IGetTargetSiteRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Gets the URI Pattern to Document data mapping for an Advanced Site Search
+     * DataStore.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.siteSearchEngine
+     *   Required. Full resource name of the
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
+     *   such as
+     *   `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
+     * @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 {@link protos.google.cloud.discoveryengine.v1alpha.GetUriPatternDocumentDataResponse|GetUriPatternDocumentDataResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1alpha/site_search_engine_service.get_uri_pattern_document_data.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_GetUriPatternDocumentData_async
+     */
+    getUriPatternDocumentData(request?: protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest, options?: CallOptions): Promise<[
+        protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataResponse,
+        (protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest | undefined),
+        {} | undefined
+    ]>;
+    getUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest | null | undefined, {} | null | undefined>): void;
+    getUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.IGetUriPatternDocumentDataRequest | null | undefined, {} | null | undefined>): void;
     /**
      * Creates a {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}.
      *
@@ -521,6 +548,80 @@ export declare class SiteSearchEngineServiceClient {
      * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_BatchVerifyTargetSites_async
      */
     checkBatchVerifyTargetSitesProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse, protos.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata>>;
+    /**
+     * Sets the URI Pattern to Document data mapping for an Advanced Site Search
+     * DataStore.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.siteSearchEngine
+     *   Required. Full resource name of the
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SiteSearchEngine|SiteSearchEngine},
+     *   such as
+     *   `projects/* /locations/* /collections/* /dataStores/* /siteSearchEngine`.
+     * @param {number[]} request.documentDataMap
+     *   Document data keyed by URI pattern. Each entry must be consistent with
+     *   the {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}. For example:
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} = {
+     *   "type": "object",
+     *   "properties": {
+     *     "Categories": {
+     *       "type": "array",
+     *       "items": {
+     *         "retrievable": true,
+     *         "type": "string"
+     *       }
+     *     }
+     *   }
+     *
+     *   document_data_map = {
+     *     "www.url1.com/*": {
+     *       "Categories": ["category1", "category2"]
+     *     },
+     *     "www.url2.com/*": {
+     *       "Categories": ["category3"]
+     *     }
+     *   }
+     * @param {boolean} request.emptyDocumentDataMap
+     *   If true, clears the document data map. If true,
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataRequest.document_data_map|SetUriPatternDocumentDataRequest.document_data_map}
+     *   must be empty.
+     * @param {google.protobuf.Struct} request.schema
+     *   Optional. If not provided, the current
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema} is used. If provided,
+     *   validates and updates the
+     *   {@link protos.google.cloud.discoveryengine.v1alpha.Schema|Schema}. If validation fails,
+     *   an error is returned.
+     * @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/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async
+     */
+    setUriPatternDocumentData(request?: protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataRequest, options?: CallOptions): Promise<[
+        LROperation<protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataMetadata>,
+        protos.google.longrunning.IOperation | undefined,
+        {} | undefined
+    ]>;
+    setUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    setUriPatternDocumentData(request: protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.ISetUriPatternDocumentDataMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
+    /**
+     * Check the status of the long running operation returned by `setUriPatternDocumentData()`.
+     * @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/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async
+     */
+    checkSetUriPatternDocumentDataProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse, protos.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata>>;
     /**
      * Gets a list of
      * {@link protos.google.cloud.discoveryengine.v1alpha.TargetSite|TargetSite}s.

package/build/src/v1alpha/site_search_engine_service_client.js

@@ -257,6 +257,9 @@ class SiteSearchEngineServiceClient {
                         {
                             get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
                         },
+                        {
+                            get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
+                        },
                         { get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
                         {
                             get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
@@ -301,6 +304,9 @@ class SiteSearchEngineServiceClient {
                         {
                             get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
                         },
+                        {
+                            get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
+                        },
                         { get: '/v1alpha/{name=projects/*/locations/*}/operations' },
                         { get: '/v1alpha/{name=projects/*}/operations' },
                     ],
@@ -326,6 +332,8 @@ class SiteSearchEngineServiceClient {
         const recrawlUrisMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.RecrawlUrisMetadata');
         const batchVerifyTargetSitesResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesResponse');
         const batchVerifyTargetSitesMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.BatchVerifyTargetSitesMetadata');
+        const setUriPatternDocumentDataResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataResponse');
+        const setUriPatternDocumentDataMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1alpha.SetUriPatternDocumentDataMetadata');
         this.descriptors.longrunning = {
             createTargetSite: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createTargetSiteResponse.decode.bind(createTargetSiteResponse), createTargetSiteMetadata.decode.bind(createTargetSiteMetadata)),
             batchCreateTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchCreateTargetSitesResponse.decode.bind(batchCreateTargetSitesResponse), batchCreateTargetSitesMetadata.decode.bind(batchCreateTargetSitesMetadata)),
@@ -335,6 +343,7 @@ class SiteSearchEngineServiceClient {
             disableAdvancedSiteSearch: new this._gaxModule.LongrunningDescriptor(this.operationsClient, disableAdvancedSiteSearchResponse.decode.bind(disableAdvancedSiteSearchResponse), disableAdvancedSiteSearchMetadata.decode.bind(disableAdvancedSiteSearchMetadata)),
             recrawlUris: new this._gaxModule.LongrunningDescriptor(this.operationsClient, recrawlUrisResponse.decode.bind(recrawlUrisResponse), recrawlUrisMetadata.decode.bind(recrawlUrisMetadata)),
             batchVerifyTargetSites: new this._gaxModule.LongrunningDescriptor(this.operationsClient, batchVerifyTargetSitesResponse.decode.bind(batchVerifyTargetSitesResponse), batchVerifyTargetSitesMetadata.decode.bind(batchVerifyTargetSitesMetadata)),
+            setUriPatternDocumentData: new this._gaxModule.LongrunningDescriptor(this.operationsClient, setUriPatternDocumentDataResponse.decode.bind(setUriPatternDocumentDataResponse), setUriPatternDocumentDataMetadata.decode.bind(setUriPatternDocumentDataMetadata)),
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.SiteSearchEngineService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -383,6 +392,8 @@ class SiteSearchEngineServiceClient {
             'recrawlUris',
             'batchVerifyTargetSites',
             'fetchDomainVerificationStatus',
+            'setUriPatternDocumentData',
+            'getUriPatternDocumentData',
         ];
         for (const methodName of siteSearchEngineServiceStubMethods) {
             const callPromise = this.siteSearchEngineServiceStub.then(stub => (...args) => {
@@ -504,6 +515,27 @@ class SiteSearchEngineServiceClient {
         this.initialize();
         return this.innerApiCalls.getTargetSite(request, options, callback);
     }
+    getUriPatternDocumentData(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({
+                site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.getUriPatternDocumentData(request, options, callback);
+    }
     createTargetSite(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};
@@ -808,6 +840,44 @@ class SiteSearchEngineServiceClient {
         const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.batchVerifyTargetSites, this._gaxModule.createDefaultBackoffSettings());
         return decodeOperation;
     }
+    setUriPatternDocumentData(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({
+                site_search_engine: (_a = request.siteSearchEngine) !== null && _a !== void 0 ? _a : '',
+            });
+        this.initialize();
+        return this.innerApiCalls.setUriPatternDocumentData(request, options, callback);
+    }
+    /**
+     * Check the status of the long running operation returned by `setUriPatternDocumentData()`.
+     * @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/v1alpha/site_search_engine_service.set_uri_pattern_document_data.js</caption>
+     * region_tag:discoveryengine_v1alpha_generated_SiteSearchEngineService_SetUriPatternDocumentData_async
+     */
+    async checkSetUriPatternDocumentDataProgress(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.setUriPatternDocumentData, this._gaxModule.createDefaultBackoffSettings());
+        return decodeOperation;
+    }
     listTargetSites(request, optionsOrCallback, callback) {
         var _a;
         request = request || {};

package/build/src/v1alpha/site_search_engine_service_client_config.json

@@ -67,6 +67,14 @@
                 "FetchDomainVerificationStatus": {
                     "retry_codes_name": "non_idempotent",
                     "retry_params_name": "default"
+                },
+                "SetUriPatternDocumentData": {
+                    "retry_codes_name": "non_idempotent",
+                    "retry_params_name": "default"
+                },
+                "GetUriPatternDocumentData": {
+                    "retry_codes_name": "non_idempotent",
+                    "retry_params_name": "default"
                 }
             }
         }

package/build/src/v1alpha/user_event_service_client.js

@@ -249,6 +249,9 @@ class UserEventServiceClient {
                         {
                             get: '/v1alpha/{name=projects/*/locations/*/evaluations/*/operations/*}',
                         },
+                        {
+                            get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*/operations/*}',
+                        },
                         { get: '/v1alpha/{name=projects/*/locations/*/operations/*}' },
                         {
                             get: '/v1alpha/{name=projects/*/locations/*/sampleQuerySets/*/operations/*}',
@@ -293,6 +296,9 @@ class UserEventServiceClient {
                         {
                             get: '/v1alpha/{name=projects/*/locations/*/dataStores/*}/operations',
                         },
+                        {
+                            get: '/v1alpha/{name=projects/*/locations/*/identity_mapping_stores/*}/operations',
+                        },
                         { get: '/v1alpha/{name=projects/*/locations/*}/operations' },
                         { get: '/v1alpha/{name=projects/*}/operations' },
                     ],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/discoveryengine",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "description": "Discovery Engine API client for Node.js",
   "repository": {
     "type": "git",
@@ -43,7 +43,7 @@
     "postpack": "minifyProtoJson",
     "samples-test": "cd samples/ && npm link ../ && npm i && npm test",
     "system-test": "c8 mocha build/system-test",
-    "test": "c8 mocha build/test"
+    "test": "NODE_OPTIONS=--max-old-space-size=8192 c8 mocha build/test"
   },
   "dependencies": {
     "google-gax": "^4.0.3"