@google-cloud/discoveryengine 0.8.0 → 1.1.0

package/build/src/v1/schema_service_client.js

@@ -27,7 +27,7 @@ const jsonProtos = require("../../protos/protos.json");
 const gapicConfig = require("./schema_service_client_config.json");
 const version = require('../../../package.json').version;
 /**
- *  Service for managing {@link google.cloud.discoveryengine.v1.Schema|Schema}s.
+ *  Service for managing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s.
  * @class
  * @memberof v1
  */
@@ -60,8 +60,7 @@ class SchemaServiceClient {
      *     API remote host.
      * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
      *     Follows the structure of {@link gapicConfig}.
-     * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
-     *     Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
+     * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
      *     For more information, please check the
      *     {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
      * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
@@ -69,7 +68,7 @@ class SchemaServiceClient {
      *     HTTP implementation. Load only fallback version and pass it to the constructor:
      *     ```
      *     const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
-     *     const client = new SchemaServiceClient({fallback: 'rest'}, gax);
+     *     const client = new SchemaServiceClient({fallback: true}, gax);
      *     ```
      */
     constructor(opts, gaxInstance) {
@@ -115,6 +114,7 @@ class SchemaServiceClient {
         if (servicePath === staticMembers.servicePath) {
             this.auth.defaultScopes = staticMembers.scopes;
         }
+        this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
         // Determine the client header string.
         const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
         if (typeof process !== 'undefined' && 'versions' in process) {
@@ -126,7 +126,7 @@ class SchemaServiceClient {
         if (!opts.fallback) {
             clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
         }
-        else if (opts.fallback === 'rest') {
+        else {
             clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
         }
         if (opts.libName && opts.libVersion) {
@@ -140,9 +140,11 @@ class SchemaServiceClient {
         this.pathTemplates = {
             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}'),
+            projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
             projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
             projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
             projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
+            projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
             projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
         };
         // Some of the methods on this service return "paged" results,
@@ -159,7 +161,7 @@ class SchemaServiceClient {
             auth: this.auth,
             grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
         };
-        if (opts.fallback === 'rest') {
+        if (opts.fallback) {
             lroOptions.protoJson = protoFilesRoot;
             lroOptions.httpRules = [
                 {
@@ -178,6 +180,15 @@ class SchemaServiceClient {
                         {
                             get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
                         },
+                        {
+                            get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}',
+                        },
+                        {
+                            get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}',
+                        },
+                        {
+                            get: '/v1/{name=projects/*/locations/*/collections/*/engines/*/operations/*}',
+                        },
                         {
                             get: '/v1/{name=projects/*/locations/*/collections/*/operations/*}',
                         },
@@ -207,9 +218,18 @@ class SchemaServiceClient {
                         {
                             get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
                         },
+                        {
+                            get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations',
+                        },
+                        {
+                            get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations',
+                        },
                         {
                             get: '/v1/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
                         },
+                        {
+                            get: '/v1/{name=projects/*/locations/*/collections/*/engines/*}/operations',
+                        },
                         { get: '/v1/{name=projects/*/locations/*/collections/*}/operations' },
                         {
                             get: '/v1/{name=projects/*/locations/*/dataStores/*/branches/*}/operations',
@@ -385,8 +405,7 @@ class SchemaServiceClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1/schema_service.create_schema.js</caption>
      * region_tag:discoveryengine_v1_generated_SchemaService_CreateSchema_async
@@ -424,8 +443,7 @@ class SchemaServiceClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1/schema_service.update_schema.js</caption>
      * region_tag:discoveryengine_v1_generated_SchemaService_UpdateSchema_async
@@ -463,8 +481,7 @@ class SchemaServiceClient {
      *   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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
+     *   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/v1/schema_service.delete_schema.js</caption>
      * region_tag:discoveryengine_v1_generated_SchemaService_DeleteSchema_async
@@ -504,31 +521,30 @@ class SchemaServiceClient {
      *   Required. The parent data store resource name, in the format of
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
      * @param {number} request.pageSize
-     *   The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
+     *   The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
      *   return. The service may return fewer than this value.
      *
      *   If unspecified, at most 100
-     *   {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
+     *   {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
      *
      *   The maximum value is 1000; values above 1000 will be coerced to 1000.
      * @param {string} request.pageToken
      *   A page token, received from a previous
-     *   {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   must match the call that provided the page token.
      * @param {object} [options]
      *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
      * @returns {Stream}
-     *   An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Schema | Schema} on 'data' event.
+     *   An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Schema|Schema} on 'data' event.
      *   The client library will perform auto-pagination by default: it will call the API as many
      *   times as needed. Note that it can affect your quota.
      *   We recommend using `listSchemasAsync()`
      *   method described below for async iteration which you can stop as needed.
-     *   Please see the
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      */
     listSchemasStream(request, options) {
@@ -556,30 +572,29 @@ class SchemaServiceClient {
      *   Required. The parent data store resource name, in the format of
      *   `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
      * @param {number} request.pageSize
-     *   The maximum number of {@link google.cloud.discoveryengine.v1.Schema|Schema}s to
+     *   The maximum number of {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s to
      *   return. The service may return fewer than this value.
      *
      *   If unspecified, at most 100
-     *   {@link google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
+     *   {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}s will be returned.
      *
      *   The maximum value is 1000; values above 1000 will be coerced to 1000.
      * @param {string} request.pageToken
      *   A page token, received from a previous
-     *   {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   call. Provide this to retrieve the subsequent page.
      *
      *   When paginating, all other parameters provided to
-     *   {@link google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
+     *   {@link protos.google.cloud.discoveryengine.v1.SchemaService.ListSchemas|SchemaService.ListSchemas}
      *   must match the call that provided the 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 [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols).
+     *   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.discoveryengine.v1.Schema | Schema}. The API will be called under the hood as needed, once per the page,
+     *   {@link protos.google.cloud.discoveryengine.v1.Schema|Schema}. 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
-     *   [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
      *   for more details and examples.
      * @example <caption>include:samples/generated/v1/schema_service.list_schemas.js</caption>
      * region_tag:discoveryengine_v1_generated_SchemaService_ListSchemas_async
@@ -599,6 +614,61 @@ class SchemaServiceClient {
         this.initialize();
         return this.descriptors.page.listSchemas.asyncIterate(this.innerApiCalls['listSchemas'], 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);
+     * ```
+     */
+    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
+     * }
+     * ```
+     */
+    listLocationsAsync(request, options) {
+        return this.locationsClient.listLocationsAsync(request, options);
+    }
     /**
      * 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
@@ -868,6 +938,75 @@ class SchemaServiceClient {
     matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
     }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            conversation: conversation,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
+    }
+    /**
+     * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreConversationName
+     *   A fully-qualified path representing project_location_collection_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
      *
@@ -1051,6 +1190,63 @@ class SchemaServiceClient {
     matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
         return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStoreConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            conversation: conversation,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
+    }
+    /**
+     * Parse the conversation from ProjectLocationDataStoreConversation resource.
+     *
+     * @param {string} projectLocationDataStoreConversationName
+     *   A fully-qualified path representing project_location_data_store_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
+        return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreSchema resource name string.
      *
@@ -1119,6 +1315,7 @@ class SchemaServiceClient {
             return this.schemaServiceStub.then(stub => {
                 this._terminated = true;
                 stub.close();
+                this.locationsClient.close();
                 this.operationsClient.close();
             });
         }