@google-cloud/discoveryengine 2.1.0 → 2.3.0

package/build/src/v1/grounded_generation_service_client.js

@@ -97,28 +97,18 @@ class GroundedGenerationServiceClient {
      */
     constructor(opts, gaxInstance) {
         // Ensure that options include all the required fields.
-        const staticMembers = this
-            .constructor;
-        if (opts?.universe_domain &&
-            opts?.universeDomain &&
-            opts?.universe_domain !== opts?.universeDomain) {
+        const staticMembers = this.constructor;
+        if (opts?.universe_domain && opts?.universeDomain && opts?.universe_domain !== opts?.universeDomain) {
             throw new Error('Please set either universe_domain or universeDomain, but not both.');
         }
-        const universeDomainEnvVar = typeof process === 'object' && typeof process.env === 'object'
-            ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN']
-            : undefined;
-        this._universeDomain =
-            opts?.universeDomain ??
-                opts?.universe_domain ??
-                universeDomainEnvVar ??
-                'googleapis.com';
+        const universeDomainEnvVar = (typeof process === 'object' && typeof process.env === 'object') ? process.env['GOOGLE_CLOUD_UNIVERSE_DOMAIN'] : undefined;
+        this._universeDomain = opts?.universeDomain ?? opts?.universe_domain ?? universeDomainEnvVar ?? 'googleapis.com';
         this._servicePath = 'discoveryengine.' + this._universeDomain;
         const servicePath = opts?.servicePath || opts?.apiEndpoint || this._servicePath;
         this._providedCustomServicePath = !!(opts?.servicePath || opts?.apiEndpoint);
         const port = opts?.port || staticMembers.port;
         const clientConfig = opts?.clientConfig ?? {};
-        const fallback = opts?.fallback ??
-            (typeof window !== 'undefined' && typeof window?.fetch === 'function');
+        const fallback = opts?.fallback ?? (typeof window !== 'undefined' && typeof window?.fetch === 'function');
         opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
         // Request numeric enum values if REST transport is used.
         opts.numericEnums = true;
@@ -148,7 +138,10 @@ class GroundedGenerationServiceClient {
         }
         this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
         // Determine the client header string.
-        const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
+        const clientHeader = [
+            `gax/${this._gaxModule.version}`,
+            `gapic/${version}`,
+        ];
         if (typeof process === 'object' && 'versions' in process) {
             clientHeader.push(`gl-node/${process.versions.node}`);
         }
@@ -172,8 +165,11 @@ class GroundedGenerationServiceClient {
         this.pathTemplates = {
             enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
             groundingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/groundingConfigs/{grounding_config}'),
+            identityMappingStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}'),
             locationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}'),
             projectPathTemplate: new this._gaxModule.PathTemplate('projects/{project}'),
+            projectLocationCmekConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/cmekConfig'),
+            projectLocationCmekConfigsPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/cmekConfigs/{cmek_config}'),
             projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
             projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
             projectLocationCollectionDataStoreBranchDocumentChunkPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}/chunks/{chunk}'),
@@ -211,7 +207,7 @@ class GroundedGenerationServiceClient {
         // Some of the methods on this service provide streaming responses.
         // Provide descriptors for these.
         this.descriptors.stream = {
-            streamGenerateGroundedContent: new this._gaxModule.StreamDescriptor(this._gaxModule.StreamType.BIDI_STREAMING, !!opts.fallback, !!opts.gaxServerStreamingRetries),
+            streamGenerateGroundedContent: new this._gaxModule.StreamDescriptor(this._gaxModule.StreamType.BIDI_STREAMING, !!opts.fallback, !!opts.gaxServerStreamingRetries)
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1.GroundedGenerationService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -240,18 +236,13 @@ class GroundedGenerationServiceClient {
         }
         // Put together the "service stub" for
         // google.cloud.discoveryengine.v1.GroundedGenerationService.
-        this.groundedGenerationServiceStub = this._gaxGrpc.createStub(this._opts.fallback
-            ? this._protos.lookupService('google.cloud.discoveryengine.v1.GroundedGenerationService')
-            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                this._protos.google.cloud.discoveryengine.v1
-                    .GroundedGenerationService, this._opts, this._providedCustomServicePath);
+        this.groundedGenerationServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('google.cloud.discoveryengine.v1.GroundedGenerationService') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.google.cloud.discoveryengine.v1.GroundedGenerationService, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
-        const groundedGenerationServiceStubMethods = [
-            'streamGenerateGroundedContent',
-            'generateGroundedContent',
-            'checkGrounding',
-        ];
+        const groundedGenerationServiceStubMethods = ['streamGenerateGroundedContent', 'generateGroundedContent', 'checkGrounding'];
         for (const methodName of groundedGenerationServiceStubMethods) {
             const callPromise = this.groundedGenerationServiceStub.then(stub => (...args) => {
                 if (this._terminated) {
@@ -269,7 +260,8 @@ class GroundedGenerationServiceClient {
             }, (err) => () => {
                 throw err;
             });
-            const descriptor = this.descriptors.stream[methodName] || undefined;
+            const descriptor = this.descriptors.stream[methodName] ||
+                undefined;
             const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
             this.innerApiCalls[methodName] = apiCall;
         }
@@ -281,8 +273,7 @@ class GroundedGenerationServiceClient {
      * @returns {string} The DNS address for this service.
      */
     static get servicePath() {
-        if (typeof process === 'object' &&
-            typeof process.emitWarning === 'function') {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
             process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
         }
         return 'discoveryengine.googleapis.com';
@@ -293,8 +284,7 @@ class GroundedGenerationServiceClient {
      * @returns {string} The DNS address for this service.
      */
     static get apiEndpoint() {
-        if (typeof process === 'object' &&
-            typeof process.emitWarning === 'function') {
+        if (typeof process === 'object' && typeof process.emitWarning === 'function') {
             process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
         }
         return 'discoveryengine.googleapis.com';
@@ -322,7 +312,9 @@ class GroundedGenerationServiceClient {
      * @returns {string[]} List of default scopes.
      */
     static get scopes() {
-        return ['https://www.googleapis.com/auth/cloud-platform'];
+        return [
+            'https://www.googleapis.com/auth/cloud-platform'
+        ];
     }
     /**
      * Return the project ID used by this class.
@@ -348,13 +340,10 @@ class GroundedGenerationServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                location: request.location ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'location': request.location ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('generateGroundedContent request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -362,11 +351,16 @@ class GroundedGenerationServiceClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .generateGroundedContent(request, options, wrappedCallback)
+        return this.innerApiCalls.generateGroundedContent(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('generateGroundedContent response %j', response);
             return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
         });
     }
     checkGrounding(request, optionsOrCallback, callback) {
@@ -382,13 +376,10 @@ class GroundedGenerationServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                grounding_config: request.groundingConfig ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'grounding_config': request.groundingConfig ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('checkGrounding request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -396,11 +387,16 @@ class GroundedGenerationServiceClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .checkGrounding(request, options, wrappedCallback)
+        return this.innerApiCalls.checkGrounding(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('checkGrounding response %j', response);
             return [response, options, rawResponse];
+        }).catch((error) => {
+            if (error && 'statusDetails' in error && error.statusDetails instanceof Array) {
+                const protos = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
+                error.statusDetails = (0, google_gax_1.decodeAnyProtosInArray)(error.statusDetails, protos);
+            }
+            throw error;
         });
     }
     /**
@@ -418,64 +414,62 @@ class GroundedGenerationServiceClient {
      * region_tag:discoveryengine_v1_generated_GroundedGenerationService_StreamGenerateGroundedContent_async
      */
     streamGenerateGroundedContent(options) {
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('streamGenerateGroundedContent stream %j', options);
         return this.innerApiCalls.streamGenerateGroundedContent(null, options);
     }
     /**
-     * Gets information about a location.
-     *
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.name
-     *   Resource name for the location.
-     * @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 google.cloud.location.Location | Location}.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
-     *   for more details and examples.
-     * @example
-     * ```
-     * const [response] = await client.getLocation(request);
-     * ```
-     */
+       * Gets information about a location.
+       *
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   Resource name for the location.
+       * @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 google.cloud.location.Location | Location}.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const [response] = await client.getLocation(request);
+       * ```
+       */
     getLocation(request, options, callback) {
         return this.locationsClient.getLocation(request, options, callback);
     }
     /**
-     * Lists information about the supported locations for this service. Returns an iterable object.
-     *
-     * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
-     * @param {Object} request
-     *   The request object that will be sent.
-     * @param {string} request.name
-     *   The resource that owns the locations collection, if applicable.
-     * @param {string} request.filter
-     *   The standard list filter.
-     * @param {number} request.pageSize
-     *   The standard list page size.
-     * @param {string} request.pageToken
-     *   The standard list page token.
-     * @param {object} [options]
-     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
-     * @returns {Object}
-     *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
-     *   When you iterate the returned iterable, each element will be an object representing
-     *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
-     *   so you can stop the iteration when you don't need more results.
-     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
-     *   for more details and examples.
-     * @example
-     * ```
-     * const iterable = client.listLocationsAsync(request);
-     * for await (const response of iterable) {
-     *   // process response
-     * }
-     * ```
-     */
+       * Lists information about the supported locations for this service. Returns an iterable object.
+       *
+       * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
+       * @param {Object} request
+       *   The request object that will be sent.
+       * @param {string} request.name
+       *   The resource that owns the locations collection, if applicable.
+       * @param {string} request.filter
+       *   The standard list filter.
+       * @param {number} request.pageSize
+       *   The standard list page size.
+       * @param {string} request.pageToken
+       *   The standard list page token.
+       * @param {object} [options]
+       *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+       * @returns {Object}
+       *   An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
+       *   When you iterate the returned iterable, each element will be an object representing
+       *   {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
+       *   so you can stop the iteration when you don't need more results.
+       *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
+       *   for more details and examples.
+       * @example
+       * ```
+       * const iterable = client.listLocationsAsync(request);
+       * for await (const response of iterable) {
+       *   // process response
+       * }
+       * ```
+       */
     listLocationsAsync(request, options) {
         return this.locationsClient.listLocationsAsync(request, options);
     }
@@ -584,6 +578,51 @@ class GroundedGenerationServiceClient {
     matchGroundingConfigFromGroundingConfigName(groundingConfigName) {
         return this.pathTemplates.groundingConfigPathTemplate.match(groundingConfigName).grounding_config;
     }
+    /**
+     * Return a fully-qualified identityMappingStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} identity_mapping_store
+     * @returns {string} Resource name string.
+     */
+    identityMappingStorePath(project, location, identityMappingStore) {
+        return this.pathTemplates.identityMappingStorePathTemplate.render({
+            project: project,
+            location: location,
+            identity_mapping_store: identityMappingStore,
+        });
+    }
+    /**
+     * Parse the project from IdentityMappingStore resource.
+     *
+     * @param {string} identityMappingStoreName
+     *   A fully-qualified path representing IdentityMappingStore resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromIdentityMappingStoreName(identityMappingStoreName) {
+        return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).project;
+    }
+    /**
+     * Parse the location from IdentityMappingStore resource.
+     *
+     * @param {string} identityMappingStoreName
+     *   A fully-qualified path representing IdentityMappingStore resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromIdentityMappingStoreName(identityMappingStoreName) {
+        return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).location;
+    }
+    /**
+     * Parse the identity_mapping_store from IdentityMappingStore resource.
+     *
+     * @param {string} identityMappingStoreName
+     *   A fully-qualified path representing IdentityMappingStore resource.
+     * @returns {string} A string representing the identity_mapping_store.
+     */
+    matchIdentityMappingStoreFromIdentityMappingStoreName(identityMappingStoreName) {
+        return this.pathTemplates.identityMappingStorePathTemplate.match(identityMappingStoreName).identity_mapping_store;
+    }
     /**
      * Return a fully-qualified location resource name string.
      *
@@ -638,6 +677,84 @@ class GroundedGenerationServiceClient {
     matchProjectFromProjectName(projectName) {
         return this.pathTemplates.projectPathTemplate.match(projectName).project;
     }
+    /**
+     * Return a fully-qualified projectLocationCmekConfig resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @returns {string} Resource name string.
+     */
+    projectLocationCmekConfigPath(project, location) {
+        return this.pathTemplates.projectLocationCmekConfigPathTemplate.render({
+            project: project,
+            location: location,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCmekConfig resource.
+     *
+     * @param {string} projectLocationCmekConfigName
+     *   A fully-qualified path representing project_location_cmekConfig resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCmekConfigName(projectLocationCmekConfigName) {
+        return this.pathTemplates.projectLocationCmekConfigPathTemplate.match(projectLocationCmekConfigName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCmekConfig resource.
+     *
+     * @param {string} projectLocationCmekConfigName
+     *   A fully-qualified path representing project_location_cmekConfig resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCmekConfigName(projectLocationCmekConfigName) {
+        return this.pathTemplates.projectLocationCmekConfigPathTemplate.match(projectLocationCmekConfigName).location;
+    }
+    /**
+     * Return a fully-qualified projectLocationCmekConfigs resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} cmek_config
+     * @returns {string} Resource name string.
+     */
+    projectLocationCmekConfigsPath(project, location, cmekConfig) {
+        return this.pathTemplates.projectLocationCmekConfigsPathTemplate.render({
+            project: project,
+            location: location,
+            cmek_config: cmekConfig,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCmekConfigs resource.
+     *
+     * @param {string} projectLocationCmekConfigsName
+     *   A fully-qualified path representing project_location_cmekConfigs resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
+        return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCmekConfigs resource.
+     *
+     * @param {string} projectLocationCmekConfigsName
+     *   A fully-qualified path representing project_location_cmekConfigs resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
+        return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).location;
+    }
+    /**
+     * Parse the cmek_config from ProjectLocationCmekConfigs resource.
+     *
+     * @param {string} projectLocationCmekConfigsName
+     *   A fully-qualified path representing project_location_cmekConfigs resource.
+     * @returns {string} A string representing the cmek_config.
+     */
+    matchCmekConfigFromProjectLocationCmekConfigsName(projectLocationCmekConfigsName) {
+        return this.pathTemplates.projectLocationCmekConfigsPathTemplate.match(projectLocationCmekConfigsName).cmek_config;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *
@@ -2795,7 +2912,7 @@ class GroundedGenerationServiceClient {
                 this._log.info('ending gRPC channel');
                 this._terminated = true;
                 stub.close();
-                this.locationsClient.close();
+                this.locationsClient.close().catch(err => { throw err; });
             });
         }
         return Promise.resolve();

package/build/src/v1/grounded_generation_service_proto_list.json

@@ -1,6 +1,7 @@
 [
     "../../protos/google/cloud/discoveryengine/v1/answer.proto",
     "../../protos/google/cloud/discoveryengine/v1/chunk.proto",
+    "../../protos/google/cloud/discoveryengine/v1/cmek_config_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/common.proto",
     "../../protos/google/cloud/discoveryengine/v1/completion.proto",
     "../../protos/google/cloud/discoveryengine/v1/completion_service.proto",
@@ -18,6 +19,8 @@
     "../../protos/google/cloud/discoveryengine/v1/engine_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/grounded_generation_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/grounding.proto",
+    "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store.proto",
+    "../../protos/google/cloud/discoveryengine/v1/identity_mapping_store_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/import_config.proto",
     "../../protos/google/cloud/discoveryengine/v1/project.proto",
     "../../protos/google/cloud/discoveryengine/v1/project_service.proto",
@@ -35,5 +38,7 @@
     "../../protos/google/cloud/discoveryengine/v1/site_search_engine.proto",
     "../../protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto",
     "../../protos/google/cloud/discoveryengine/v1/user_event.proto",
-    "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto"
+    "../../protos/google/cloud/discoveryengine/v1/user_event_service.proto",
+    "../../protos/google/cloud/discoveryengine/v1/user_license.proto",
+    "../../protos/google/cloud/discoveryengine/v1/user_license_service.proto"
 ]