@google-cloud/discoveryengine 2.0.1 → 2.2.0

package/build/src/v1alpha/search_service_client.js

@@ -97,26 +97,17 @@ class SearchServiceClient {
     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 SearchServiceClient {
         }
         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}`);
         }
@@ -212,7 +206,7 @@ class SearchServiceClient {
         // (e.g. 50 results at a time, with tokens to get subsequent
         // pages). Denote the keys used for pagination and results.
         this.descriptors.page = {
-            search: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results'),
+            search: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'results')
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.SearchService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -241,11 +235,10 @@ class SearchServiceClient {
         }
         // Put together the "service stub" for
         // google.cloud.discoveryengine.v1alpha.SearchService.
-        this.searchServiceStub = this._gaxGrpc.createStub(this._opts.fallback
-            ? this._protos.lookupService('google.cloud.discoveryengine.v1alpha.SearchService')
-            : // eslint-disable-next-line @typescript-eslint/no-explicit-any
-                this._protos.google.cloud.discoveryengine.v1alpha
-                    .SearchService, this._opts, this._providedCustomServicePath);
+        this.searchServiceStub = this._gaxGrpc.createStub(this._opts.fallback ?
+            this._protos.lookupService('google.cloud.discoveryengine.v1alpha.SearchService') :
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            this._protos.google.cloud.discoveryengine.v1alpha.SearchService, this._opts, this._providedCustomServicePath);
         // Iterate over each of the methods that the service provides
         // and create an API call method for each.
         const searchServiceStubMethods = ['search'];
@@ -259,7 +252,8 @@ class SearchServiceClient {
             }, (err) => () => {
                 throw err;
             });
-            const descriptor = this.descriptors.page[methodName] || undefined;
+            const descriptor = this.descriptors.page[methodName] ||
+                undefined;
             const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
             this.innerApiCalls[methodName] = apiCall;
         }
@@ -271,8 +265,7 @@ class SearchServiceClient {
      * @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';
@@ -283,8 +276,7 @@ class SearchServiceClient {
      * @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';
@@ -312,7 +304,9 @@ class SearchServiceClient {
      * @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.
@@ -338,13 +332,10 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
-        this.initialize().catch(err => {
-            throw err;
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
         });
+        this.initialize().catch(err => { throw err; });
         const wrappedCallback = callback
             ? (error, values, nextPageRequest, rawResponse) => {
                 this._log.info('search values %j', values);
@@ -643,15 +634,12 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
+        });
         const defaultCallSettings = this._defaults['search'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('search stream %j', request);
         return this.descriptors.page.search.createStream(this.innerApiCalls.search, request, callSettings);
     }
@@ -942,70 +930,67 @@ class SearchServiceClient {
         options = options || {};
         options.otherArgs = options.otherArgs || {};
         options.otherArgs.headers = options.otherArgs.headers || {};
-        options.otherArgs.headers['x-goog-request-params'] =
-            this._gaxModule.routingHeader.fromParams({
-                serving_config: request.servingConfig ?? '',
-            });
+        options.otherArgs.headers['x-goog-request-params'] = this._gaxModule.routingHeader.fromParams({
+            'serving_config': request.servingConfig ?? '',
+        });
         const defaultCallSettings = this._defaults['search'];
         const callSettings = defaultCallSettings.merge(options);
-        this.initialize().catch(err => {
-            throw err;
-        });
+        this.initialize().catch(err => { throw err; });
         this._log.info('search iterate %j', request);
         return this.descriptors.page.search.asyncIterate(this.innerApiCalls['search'], request, callSettings);
     }
     /**
-     * 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);
     }
@@ -1033,8 +1018,7 @@ class SearchServiceClient {
      * @returns {string} A string representing the project.
      */
     matchProjectFromAclConfigName(aclConfigName) {
-        return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
-            .project;
+        return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).project;
     }
     /**
      * Parse the location from AclConfig resource.
@@ -1044,8 +1028,7 @@ class SearchServiceClient {
      * @returns {string} A string representing the location.
      */
     matchLocationFromAclConfigName(aclConfigName) {
-        return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName)
-            .location;
+        return this.pathTemplates.aclConfigPathTemplate.match(aclConfigName).location;
     }
     /**
      * Return a fully-qualified engine resource name string.
@@ -1127,8 +1110,7 @@ class SearchServiceClient {
      * @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.
@@ -1138,8 +1120,7 @@ class SearchServiceClient {
      * @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.
@@ -1149,8 +1130,7 @@ class SearchServiceClient {
      * @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 project resource name string.
@@ -3343,8 +3323,7 @@ class SearchServiceClient {
      * @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.
@@ -3354,8 +3333,7 @@ class SearchServiceClient {
      * @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.
@@ -3365,8 +3343,7 @@ class SearchServiceClient {
      * @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.
@@ -3376,8 +3353,7 @@ class SearchServiceClient {
      * @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.
@@ -3436,7 +3412,7 @@ class SearchServiceClient {
                 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/v1alpha/search_tuning_service_client.d.ts

@@ -137,7 +137,7 @@ export declare class SearchTuningServiceClient {
      */
     listCustomModels(request?: protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsRequest, options?: CallOptions): Promise<[
         protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsResponse,
-        (protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsRequest | undefined),
+        protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsRequest | undefined,
         {} | undefined
     ]>;
     listCustomModels(request: protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsResponse, protos.google.cloud.discoveryengine.v1alpha.IListCustomModelsRequest | null | undefined, {} | null | undefined>): void;
@@ -193,86 +193,86 @@ export declare class SearchTuningServiceClient {
      */
     checkTrainCustomModelProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse, protos.google.cloud.discoveryengine.v1alpha.TrainCustomModelMetadata>>;
     /**
-     * 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>;
     /**
-     * Gets the latest state of a long-running operation.  Clients can use this
-     * method to poll the operation result at intervals as recommended by the API
-     * service.
-     *
-     * @param {Object} request - The request object that will be sent.
-     * @param {string} request.name - The name of the operation resource.
-     * @param {Object=} options
-     *   Optional parameters. You can override the default settings for this call,
-     *   e.g, timeout, retries, paginations, etc. See {@link
-     *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
-     *   for the details.
-     * @param {function(?Error, ?Object)=} callback
-     *   The function which will be called with the result of the API call.
-     *
-     *   The second parameter to the callback is an object representing
-     *   {@link google.longrunning.Operation | google.longrunning.Operation}.
-     * @return {Promise} - The promise which resolves to an array.
-     *   The first element of the array is an object representing
-     * {@link google.longrunning.Operation | google.longrunning.Operation}.
-     * The promise has a method named "cancel" which cancels the ongoing API call.
-     *
-     * @example
-     * ```
-     * const client = longrunning.operationsClient();
-     * const name = '';
-     * const [response] = await client.getOperation({name});
-     * // doThingsWith(response)
-     * ```
-     */
+       * Gets the latest state of a long-running operation.  Clients can use this
+       * method to poll the operation result at intervals as recommended by the API
+       * service.
+       *
+       * @param {Object} request - The request object that will be sent.
+       * @param {string} request.name - The name of the operation resource.
+       * @param {Object=} options
+       *   Optional parameters. You can override the default settings for this call,
+       *   e.g, timeout, retries, paginations, etc. See {@link
+       *   https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
+       *   for the details.
+       * @param {function(?Error, ?Object)=} callback
+       *   The function which will be called with the result of the API call.
+       *
+       *   The second parameter to the callback is an object representing
+       *   {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * @return {Promise} - The promise which resolves to an array.
+       *   The first element of the array is an object representing
+       * {@link google.longrunning.Operation | google.longrunning.Operation}.
+       * The promise has a method named "cancel" which cancels the ongoing API call.
+       *
+       * @example
+       * ```
+       * const client = longrunning.operationsClient();
+       * const name = '';
+       * const [response] = await client.getOperation({name});
+       * // doThingsWith(response)
+       * ```
+       */
     getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
     /**
      * Lists operations that match the specified filter in the request. If the