@google-cloud/discoveryengine 2.1.0 → 2.2.0

package/build/src/v1beta/rank_service_client.js

@@ -97,26 +97,17 @@ class RankServiceClient {
     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) {
+        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;
@@ -146,7 +137,10 @@ class RankServiceClient {
         }
         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}`);
         }
@@ -236,10 +230,10 @@ class RankServiceClient {
         }
         // Put together the "service stub" for
         // google.cloud.discoveryengine.v1beta.RankService.
-        this.rankServiceStub = this._gaxGrpc.createStub(this._opts.fallback
-            ? this._protos.lookupService('google.cloud.discoveryengine.v1beta.RankService')
-            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                this._protos.google.cloud.discoveryengine.v1beta.RankService, this._opts, this._providedCustomServicePath);
+        this.rankServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('google.cloud.discoveryengine.v1beta.RankService') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.google.cloud.discoveryengine.v1beta.RankService, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
         const rankServiceStubMethods = ['rank'];
@@ -265,8 +259,7 @@ class RankServiceClient {
      * @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';
@@ -277,8 +270,7 @@ class RankServiceClient {
      * @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';
@@ -306,7 +298,9 @@ class RankServiceClient {
      * @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.
@@ -332,13 +326,10 @@ class RankServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                ranking_config: request.rankingConfig ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'ranking_config': request.rankingConfig ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         this._log.info('rank request %j', request);
         const wrappedCallback = callback
             ? (error, response, options, rawResponse) => {
@@ -346,65 +337,64 @@ class RankServiceClient {
                 callback(error, response, options, rawResponse); // We verified callback above.
             }
             : undefined;
-        return this.innerApiCalls
-            .rank(request, options, wrappedCallback)
+        return this.innerApiCalls.rank(request, options, wrappedCallback)
             ?.then(([response, options, rawResponse]) => {
             this._log.info('rank response %j', response);
             return [response, options, rawResponse];
         });
     }
     /**
-     * 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);
     }
@@ -491,8 +481,7 @@ class RankServiceClient {
      * @returns {string} A string representing the project.
      */
     matchProjectFromEvaluationName(evaluationName) {
-        return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
-            .project;
+        return this.pathTemplates.evaluationPathTemplate.match(evaluationName).project;
     }
     /**
      * Parse the location from Evaluation resource.
@@ -502,8 +491,7 @@ class RankServiceClient {
      * @returns {string} A string representing the location.
      */
     matchLocationFromEvaluationName(evaluationName) {
-        return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
-            .location;
+        return this.pathTemplates.evaluationPathTemplate.match(evaluationName).location;
     }
     /**
      * Parse the evaluation from Evaluation resource.
@@ -513,8 +501,7 @@ class RankServiceClient {
      * @returns {string} A string representing the evaluation.
      */
     matchEvaluationFromEvaluationName(evaluationName) {
-        return this.pathTemplates.evaluationPathTemplate.match(evaluationName)
-            .evaluation;
+        return this.pathTemplates.evaluationPathTemplate.match(evaluationName).evaluation;
     }
     /**
      * Return a fully-qualified groundingConfig resource name string.
@@ -2750,8 +2737,7 @@ class RankServiceClient {
      * @returns {string} A string representing the project.
      */
     matchProjectFromRankingConfigName(rankingConfigName) {
-        return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
-            .project;
+        return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName).project;
     }
     /**
      * Parse the location from RankingConfig resource.
@@ -2761,8 +2747,7 @@ class RankServiceClient {
      * @returns {string} A string representing the location.
      */
     matchLocationFromRankingConfigName(rankingConfigName) {
-        return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
-            .location;
+        return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName).location;
     }
     /**
      * Parse the ranking_config from RankingConfig resource.
@@ -2772,8 +2757,7 @@ class RankServiceClient {
      * @returns {string} A string representing the ranking_config.
      */
     matchRankingConfigFromRankingConfigName(rankingConfigName) {
-        return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName)
-            .ranking_config;
+        return this.pathTemplates.rankingConfigPathTemplate.match(rankingConfigName).ranking_config;
     }
     /**
      * Return a fully-qualified sampleQuery resource name string.
@@ -2800,8 +2784,7 @@ class RankServiceClient {
      * @returns {string} A string representing the project.
      */
     matchProjectFromSampleQueryName(sampleQueryName) {
-        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-            .project;
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).project;
     }
     /**
      * Parse the location from SampleQuery resource.
@@ -2811,8 +2794,7 @@ class RankServiceClient {
      * @returns {string} A string representing the location.
      */
     matchLocationFromSampleQueryName(sampleQueryName) {
-        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-            .location;
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).location;
     }
     /**
      * Parse the sample_query_set from SampleQuery resource.
@@ -2822,8 +2804,7 @@ class RankServiceClient {
      * @returns {string} A string representing the sample_query_set.
      */
     matchSampleQuerySetFromSampleQueryName(sampleQueryName) {
-        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-            .sample_query_set;
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query_set;
     }
     /**
      * Parse the sample_query from SampleQuery resource.
@@ -2833,8 +2814,7 @@ class RankServiceClient {
      * @returns {string} A string representing the sample_query.
      */
     matchSampleQueryFromSampleQueryName(sampleQueryName) {
-        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName)
-            .sample_query;
+        return this.pathTemplates.sampleQueryPathTemplate.match(sampleQueryName).sample_query;
     }
     /**
      * Return a fully-qualified sampleQuerySet resource name string.
@@ -2893,7 +2873,7 @@ class RankServiceClient {
                 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/v1beta/recommendation_service_client.d.ts

@@ -253,55 +253,55 @@ export declare class RecommendationServiceClient {
     recommend(request: protos.google.cloud.discoveryengine.v1beta.IRecommendRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IRecommendResponse, protos.google.cloud.discoveryengine.v1beta.IRecommendRequest | null | undefined, {} | null | undefined>): void;
     recommend(request: protos.google.cloud.discoveryengine.v1beta.IRecommendRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IRecommendResponse, protos.google.cloud.discoveryengine.v1beta.IRecommendRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * 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: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
     /**
-     * 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: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
     /**
      * Return a fully-qualified engine resource name string.