@google-cloud/discoveryengine 1.2.0 → 1.3.0

package/build/src/v1alpha/site_search_engine_service_client.d.ts

@@ -322,6 +322,90 @@ export declare class SiteSearchEngineServiceClient {
      * ```
      */
     deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
+    /**
+     * 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: string, location: string, collection: string, engine: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationCollectionDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
      *
@@ -526,6 +610,39 @@ export declare class SiteSearchEngineServiceClient {
      * @returns {string} A string representing the data_store.
      */
     matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
+    /**
+     * Return a fully-qualified projectLocationDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
+    /**
+     * Parse the project from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Parse the location from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
+    /**
+     * Parse the data_store from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
     /**
      * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
      *

package/build/src/v1alpha/site_search_engine_service_client.js

@@ -139,10 +139,13 @@ class SiteSearchEngineServiceClient {
         // 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'),
+            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}'),
@@ -561,6 +564,120 @@ class SiteSearchEngineServiceClient {
     // --------------------
     // -- 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.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} collection
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
+            project: project,
+            location: location,
+            collection: collection,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
+    }
+    /**
+     * Parse the collection from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the collection.
+     */
+    matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
+    }
+    /**
+     * Parse the data_store from ProjectLocationCollectionDataStore resource.
+     *
+     * @param {string} projectLocationCollectionDataStoreName
+     *   A fully-qualified path representing project_location_collection_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
+        return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
+    }
     /**
      * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
      *
@@ -837,6 +954,51 @@ class SiteSearchEngineServiceClient {
     matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
         return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
     }
+    /**
+     * Return a fully-qualified projectLocationDataStore resource name string.
+     *
+     * @param {string} project
+     * @param {string} location
+     * @param {string} data_store
+     * @returns {string} Resource name string.
+     */
+    projectLocationDataStorePath(project, location, dataStore) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.render({
+            project: project,
+            location: location,
+            data_store: dataStore,
+        });
+    }
+    /**
+     * Parse the project from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the project.
+     */
+    matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
+    }
+    /**
+     * Parse the location from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the location.
+     */
+    matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
+    }
+    /**
+     * Parse the data_store from ProjectLocationDataStore resource.
+     *
+     * @param {string} projectLocationDataStoreName
+     *   A fully-qualified path representing project_location_data_store resource.
+     * @returns {string} A string representing the data_store.
+     */
+    matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
+        return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
+    }
     /**
      * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
      *

package/build/src/v1alpha/user_event_service_client.d.ts

@@ -471,6 +471,48 @@ export declare class UserEventServiceClient {
      * ```
      */
     deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
+    /**
+     * 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: string, location: string, collection: string, engine: string): string;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
+    /**
+     * 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: string): string | number;
     /**
      * Return a fully-qualified projectLocationCollectionDataStore resource name string.
      *

package/build/src/v1alpha/user_event_service_client.js

@@ -138,6 +138,7 @@ class UserEventServiceClient {
         // 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}'),
@@ -648,6 +649,63 @@ class UserEventServiceClient {
     // --------------------
     // -- 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.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@google-cloud/discoveryengine",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Discovery Engine API client for Node.js",
   "repository": {
     "type": "git",
@@ -51,7 +51,7 @@
   "devDependencies": {
     "@types/mocha": "^9.0.0",
     "@types/node": "^20.4.5",
-    "@types/sinon": "^10.0.0",
+    "@types/sinon": "^17.0.0",
     "c8": "^8.0.1",
     "gapic-tools": "^0.2.0",
     "gts": "^5.0.0",
@@ -62,7 +62,7 @@
     "long": "^5.2.3",
     "mocha": "^9.2.2",
     "pack-n-play": "^2.0.0",
-    "sinon": "^15.0.0",
+    "sinon": "^17.0.0",
     "typescript": "^5.1.6"
   },
   "engines": {