@google-cloud/discoveryengine 1.2.0 → 1.3.1

package/build/src/v1alpha/completion_service_client.js

@@ -138,14 +138,20 @@ class CompletionServiceClient {
         // identifiers to uniquely identify resources within the API.
         // Create useful helper objects for these.
         this.pathTemplates = {
+            enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
             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}'),
+            projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
+            projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
+            projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
             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}'),
+            projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
+            projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
         };
         // Put together the default options sent with requests.
         this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.CompletionService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
@@ -318,6 +324,63 @@ class CompletionServiceClient {
     // --------------------
     // -- Path templates --
     // --------------------
+    /**
+     * Return a fully-qualified engine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @returns {string} Resource name string.
+     */
+    enginePath(project, location, collection, engine) {
+        return this.pathTemplates.enginePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+        });
+    }
+    /**
+     * Parse the project from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).project;
+    }
+    /**
+     * Parse the location from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).location;
+    }
+    /**
+     * Parse the collection from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).collection;
+    }
+    /**
+     * Parse the engine from Engine resource.
+     *
+     * @param {string} engineName
+     *   A fully-qualified path representing Engine resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromEngineName(engineName) {
+        return this.pathTemplates.enginePathTemplate.match(engineName).engine;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *
@@ -594,6 +657,201 @@ class CompletionServiceClient {
     matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
         return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
     }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @param {string} target_site
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+            target_site: targetSite,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
+    }
+    /**
+     * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the target_site.
+     */
+    matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
+    }
+    /**
+     * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} engine
+     * @param {string} conversation
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            engine: engine,
+            conversation: conversation,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
+    }
+    /**
+     * Parse the engine from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the engine.
+     */
+    matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
+    }
+    /**
+     * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
+     *
+     * @param {string} projectLocationCollectionEngineConversationName
+     *   A fully-qualified path representing project_location_collection_engine_conversation resource.
+     * @returns {string} A string representing the conversation.
+     */
+    matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
+        return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
+    }
     /**
      * Return a fully-qualified projectLocationDataStore resource name string.
      *
@@ -822,6 +1080,108 @@ class CompletionServiceClient {
     matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
         return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
+    }
+    /**
+     * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @param {string} target_site
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+            target_site: targetSite,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
+    }
+    /**
+     * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
+     *
+     * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
+     *   A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
+     * @returns {string} A string representing the target_site.
+     */
+    matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
+        return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
+    }
     /**
      * Terminate the gRPC channel and close the client.
      *