@google-cloud/discoveryengine 1.2.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +13 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +39 -4
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +9 -3
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +26 -3
  10. package/build/protos/protos.d.ts +5578 -1800
  11. package/build/protos/protos.js +14034 -5272
  12. package/build/protos/protos.json +1337 -340
  13. package/build/src/v1alpha/completion_service_client.d.ts +42 -0
  14. package/build/src/v1alpha/completion_service_client.js +58 -0
  15. package/build/src/v1alpha/conversational_search_service_client.d.ts +42 -0
  16. package/build/src/v1alpha/conversational_search_service_client.js +58 -0
  17. package/build/src/v1alpha/data_store_service_client.d.ts +1060 -0
  18. package/build/src/v1alpha/data_store_service_client.js +1431 -0
  19. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  20. package/build/src/v1alpha/document_service_client.d.ts +117 -0
  21. package/build/src/v1alpha/document_service_client.js +162 -0
  22. package/build/src/v1alpha/engine_service_client.d.ts +1079 -0
  23. package/build/src/v1alpha/engine_service_client.js +1481 -0
  24. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  25. package/build/src/v1alpha/index.d.ts +2 -0
  26. package/build/src/v1alpha/index.js +5 -1
  27. package/build/src/v1alpha/recommendation_service_client.d.ts +126 -3
  28. package/build/src/v1alpha/recommendation_service_client.js +162 -0
  29. package/build/src/v1alpha/schema_service_client.d.ts +42 -0
  30. package/build/src/v1alpha/schema_service_client.js +58 -0
  31. package/build/src/v1alpha/search_service_client.d.ts +195 -9
  32. package/build/src/v1alpha/search_service_client.js +214 -6
  33. package/build/src/v1alpha/site_search_engine_service_client.d.ts +117 -0
  34. package/build/src/v1alpha/site_search_engine_service_client.js +162 -0
  35. package/build/src/v1alpha/user_event_service_client.d.ts +42 -0
  36. package/build/src/v1alpha/user_event_service_client.js +58 -0
  37. package/package.json +3 -3
@@ -0,0 +1,58 @@
1
+ {
2
+ "interfaces": {
3
+ "google.cloud.discoveryengine.v1alpha.EngineService": {
4
+ "retry_codes": {
5
+ "non_idempotent": [],
6
+ "idempotent": [
7
+ "DEADLINE_EXCEEDED",
8
+ "UNAVAILABLE"
9
+ ]
10
+ },
11
+ "retry_params": {
12
+ "default": {
13
+ "initial_retry_delay_millis": 100,
14
+ "retry_delay_multiplier": 1.3,
15
+ "max_retry_delay_millis": 60000,
16
+ "initial_rpc_timeout_millis": 60000,
17
+ "rpc_timeout_multiplier": 1,
18
+ "max_rpc_timeout_millis": 60000,
19
+ "total_timeout_millis": 600000
20
+ }
21
+ },
22
+ "methods": {
23
+ "CreateEngine": {
24
+ "retry_codes_name": "non_idempotent",
25
+ "retry_params_name": "default"
26
+ },
27
+ "DeleteEngine": {
28
+ "retry_codes_name": "non_idempotent",
29
+ "retry_params_name": "default"
30
+ },
31
+ "UpdateEngine": {
32
+ "retry_codes_name": "non_idempotent",
33
+ "retry_params_name": "default"
34
+ },
35
+ "GetEngine": {
36
+ "retry_codes_name": "non_idempotent",
37
+ "retry_params_name": "default"
38
+ },
39
+ "ListEngines": {
40
+ "retry_codes_name": "non_idempotent",
41
+ "retry_params_name": "default"
42
+ },
43
+ "PauseEngine": {
44
+ "retry_codes_name": "non_idempotent",
45
+ "retry_params_name": "default"
46
+ },
47
+ "ResumeEngine": {
48
+ "retry_codes_name": "non_idempotent",
49
+ "retry_params_name": "default"
50
+ },
51
+ "TuneEngine": {
52
+ "retry_codes_name": "non_idempotent",
53
+ "retry_params_name": "default"
54
+ }
55
+ }
56
+ }
57
+ }
58
+ }
@@ -1,6 +1,8 @@
1
1
  export { CompletionServiceClient } from './completion_service_client';
2
2
  export { ConversationalSearchServiceClient } from './conversational_search_service_client';
3
+ export { DataStoreServiceClient } from './data_store_service_client';
3
4
  export { DocumentServiceClient } from './document_service_client';
5
+ export { EngineServiceClient } from './engine_service_client';
4
6
  export { RecommendationServiceClient } from './recommendation_service_client';
5
7
  export { SchemaServiceClient } from './schema_service_client';
6
8
  export { SearchServiceClient } from './search_service_client';
@@ -17,13 +17,17 @@
17
17
  // ** https://github.com/googleapis/gapic-generator-typescript **
18
18
  // ** All changes to this file may be overwritten. **
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.UserEventServiceClient = exports.SiteSearchEngineServiceClient = exports.SearchServiceClient = exports.SchemaServiceClient = exports.RecommendationServiceClient = exports.DocumentServiceClient = exports.ConversationalSearchServiceClient = exports.CompletionServiceClient = void 0;
20
+ exports.UserEventServiceClient = exports.SiteSearchEngineServiceClient = exports.SearchServiceClient = exports.SchemaServiceClient = exports.RecommendationServiceClient = exports.EngineServiceClient = exports.DocumentServiceClient = exports.DataStoreServiceClient = exports.ConversationalSearchServiceClient = exports.CompletionServiceClient = void 0;
21
21
  var completion_service_client_1 = require("./completion_service_client");
22
22
  Object.defineProperty(exports, "CompletionServiceClient", { enumerable: true, get: function () { return completion_service_client_1.CompletionServiceClient; } });
23
23
  var conversational_search_service_client_1 = require("./conversational_search_service_client");
24
24
  Object.defineProperty(exports, "ConversationalSearchServiceClient", { enumerable: true, get: function () { return conversational_search_service_client_1.ConversationalSearchServiceClient; } });
25
+ var data_store_service_client_1 = require("./data_store_service_client");
26
+ Object.defineProperty(exports, "DataStoreServiceClient", { enumerable: true, get: function () { return data_store_service_client_1.DataStoreServiceClient; } });
25
27
  var document_service_client_1 = require("./document_service_client");
26
28
  Object.defineProperty(exports, "DocumentServiceClient", { enumerable: true, get: function () { return document_service_client_1.DocumentServiceClient; } });
29
+ var engine_service_client_1 = require("./engine_service_client");
30
+ Object.defineProperty(exports, "EngineServiceClient", { enumerable: true, get: function () { return engine_service_client_1.EngineServiceClient; } });
27
31
  var recommendation_service_client_1 = require("./recommendation_service_client");
28
32
  Object.defineProperty(exports, "RecommendationServiceClient", { enumerable: true, get: function () { return recommendation_service_client_1.RecommendationServiceClient; } });
29
33
  var schema_service_client_1 = require("./schema_service_client");
@@ -111,11 +111,17 @@ export declare class RecommendationServiceClient {
111
111
  * @param {Object} request
112
112
  * The request object that will be sent.
113
113
  * @param {string} request.servingConfig
114
- * Required. Full resource name of the format:
114
+ * Required. Full resource name of a
115
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ServingConfig|ServingConfig}:
116
+ * `projects/* /locations/global/collections/* /engines/* /servingConfigs/*`, or
115
117
  * `projects/* /locations/global/collections/* /dataStores/* /servingConfigs/*`
116
118
  *
117
- * Before you can request recommendations from your model, you must create at
118
- * least one serving config for it.
119
+ * One default serving config is created along with your recommendation engine
120
+ * creation. The engine ID will be used as the ID of the default serving
121
+ * config. For example, for Engine
122
+ * `projects/* /locations/global/collections/* /engines/my-engine`, you can use
123
+ * `projects/* /locations/global/collections/* /engines/my-engine/servingConfigs/my-engine`
124
+ * for your {@link protos.|Recommend} requests.
119
125
  * @param {google.cloud.discoveryengine.v1alpha.UserEvent} request.userEvent
120
126
  * Required. Context about the user, what they are looking at and what action
121
127
  * they took to trigger the Recommend request. Note that this user event
@@ -284,6 +290,90 @@ export declare class RecommendationServiceClient {
284
290
  * ```
285
291
  */
286
292
  listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
293
+ /**
294
+ * Return a fully-qualified engine resource name string.
295
+ *
296
+ * @param {string} project
297
+ * @param {string} location
298
+ * @param {string} collection
299
+ * @param {string} engine
300
+ * @returns {string} Resource name string.
301
+ */
302
+ enginePath(project: string, location: string, collection: string, engine: string): string;
303
+ /**
304
+ * Parse the project from Engine resource.
305
+ *
306
+ * @param {string} engineName
307
+ * A fully-qualified path representing Engine resource.
308
+ * @returns {string} A string representing the project.
309
+ */
310
+ matchProjectFromEngineName(engineName: string): string | number;
311
+ /**
312
+ * Parse the location from Engine resource.
313
+ *
314
+ * @param {string} engineName
315
+ * A fully-qualified path representing Engine resource.
316
+ * @returns {string} A string representing the location.
317
+ */
318
+ matchLocationFromEngineName(engineName: string): string | number;
319
+ /**
320
+ * Parse the collection from Engine resource.
321
+ *
322
+ * @param {string} engineName
323
+ * A fully-qualified path representing Engine resource.
324
+ * @returns {string} A string representing the collection.
325
+ */
326
+ matchCollectionFromEngineName(engineName: string): string | number;
327
+ /**
328
+ * Parse the engine from Engine resource.
329
+ *
330
+ * @param {string} engineName
331
+ * A fully-qualified path representing Engine resource.
332
+ * @returns {string} A string representing the engine.
333
+ */
334
+ matchEngineFromEngineName(engineName: string): string | number;
335
+ /**
336
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
337
+ *
338
+ * @param {string} project
339
+ * @param {string} location
340
+ * @param {string} collection
341
+ * @param {string} data_store
342
+ * @returns {string} Resource name string.
343
+ */
344
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
345
+ /**
346
+ * Parse the project from ProjectLocationCollectionDataStore resource.
347
+ *
348
+ * @param {string} projectLocationCollectionDataStoreName
349
+ * A fully-qualified path representing project_location_collection_data_store resource.
350
+ * @returns {string} A string representing the project.
351
+ */
352
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
353
+ /**
354
+ * Parse the location from ProjectLocationCollectionDataStore resource.
355
+ *
356
+ * @param {string} projectLocationCollectionDataStoreName
357
+ * A fully-qualified path representing project_location_collection_data_store resource.
358
+ * @returns {string} A string representing the location.
359
+ */
360
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
361
+ /**
362
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
363
+ *
364
+ * @param {string} projectLocationCollectionDataStoreName
365
+ * A fully-qualified path representing project_location_collection_data_store resource.
366
+ * @returns {string} A string representing the collection.
367
+ */
368
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
369
+ /**
370
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
371
+ *
372
+ * @param {string} projectLocationCollectionDataStoreName
373
+ * A fully-qualified path representing project_location_collection_data_store resource.
374
+ * @returns {string} A string representing the data_store.
375
+ */
376
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
287
377
  /**
288
378
  * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
289
379
  *
@@ -548,6 +638,39 @@ export declare class RecommendationServiceClient {
548
638
  * @returns {string} A string representing the serving_config.
549
639
  */
550
640
  matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName: string): string | number;
641
+ /**
642
+ * Return a fully-qualified projectLocationDataStore resource name string.
643
+ *
644
+ * @param {string} project
645
+ * @param {string} location
646
+ * @param {string} data_store
647
+ * @returns {string} Resource name string.
648
+ */
649
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
650
+ /**
651
+ * Parse the project from ProjectLocationDataStore resource.
652
+ *
653
+ * @param {string} projectLocationDataStoreName
654
+ * A fully-qualified path representing project_location_data_store resource.
655
+ * @returns {string} A string representing the project.
656
+ */
657
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
658
+ /**
659
+ * Parse the location from ProjectLocationDataStore resource.
660
+ *
661
+ * @param {string} projectLocationDataStoreName
662
+ * A fully-qualified path representing project_location_data_store resource.
663
+ * @returns {string} A string representing the location.
664
+ */
665
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
666
+ /**
667
+ * Parse the data_store from ProjectLocationDataStore resource.
668
+ *
669
+ * @param {string} projectLocationDataStoreName
670
+ * A fully-qualified path representing project_location_data_store resource.
671
+ * @returns {string} A string representing the data_store.
672
+ */
673
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
551
674
  /**
552
675
  * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
553
676
  *
@@ -139,11 +139,14 @@ class RecommendationServiceClient {
139
139
  // identifiers to uniquely identify resources within the API.
140
140
  // Create useful helper objects for these.
141
141
  this.pathTemplates = {
142
+ enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
143
+ projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
142
144
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
143
145
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
144
146
  projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
145
147
  projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
146
148
  projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
149
+ projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
147
150
  projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
148
151
  projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
149
152
  projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
@@ -320,6 +323,120 @@ class RecommendationServiceClient {
320
323
  // --------------------
321
324
  // -- Path templates --
322
325
  // --------------------
326
+ /**
327
+ * Return a fully-qualified engine resource name string.
328
+ *
329
+ * @param {string} project
330
+ * @param {string} location
331
+ * @param {string} collection
332
+ * @param {string} engine
333
+ * @returns {string} Resource name string.
334
+ */
335
+ enginePath(project, location, collection, engine) {
336
+ return this.pathTemplates.enginePathTemplate.render({
337
+ project: project,
338
+ location: location,
339
+ collection: collection,
340
+ engine: engine,
341
+ });
342
+ }
343
+ /**
344
+ * Parse the project from Engine resource.
345
+ *
346
+ * @param {string} engineName
347
+ * A fully-qualified path representing Engine resource.
348
+ * @returns {string} A string representing the project.
349
+ */
350
+ matchProjectFromEngineName(engineName) {
351
+ return this.pathTemplates.enginePathTemplate.match(engineName).project;
352
+ }
353
+ /**
354
+ * Parse the location from Engine resource.
355
+ *
356
+ * @param {string} engineName
357
+ * A fully-qualified path representing Engine resource.
358
+ * @returns {string} A string representing the location.
359
+ */
360
+ matchLocationFromEngineName(engineName) {
361
+ return this.pathTemplates.enginePathTemplate.match(engineName).location;
362
+ }
363
+ /**
364
+ * Parse the collection from Engine resource.
365
+ *
366
+ * @param {string} engineName
367
+ * A fully-qualified path representing Engine resource.
368
+ * @returns {string} A string representing the collection.
369
+ */
370
+ matchCollectionFromEngineName(engineName) {
371
+ return this.pathTemplates.enginePathTemplate.match(engineName).collection;
372
+ }
373
+ /**
374
+ * Parse the engine from Engine resource.
375
+ *
376
+ * @param {string} engineName
377
+ * A fully-qualified path representing Engine resource.
378
+ * @returns {string} A string representing the engine.
379
+ */
380
+ matchEngineFromEngineName(engineName) {
381
+ return this.pathTemplates.enginePathTemplate.match(engineName).engine;
382
+ }
383
+ /**
384
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
385
+ *
386
+ * @param {string} project
387
+ * @param {string} location
388
+ * @param {string} collection
389
+ * @param {string} data_store
390
+ * @returns {string} Resource name string.
391
+ */
392
+ projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
393
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
394
+ project: project,
395
+ location: location,
396
+ collection: collection,
397
+ data_store: dataStore,
398
+ });
399
+ }
400
+ /**
401
+ * Parse the project from ProjectLocationCollectionDataStore resource.
402
+ *
403
+ * @param {string} projectLocationCollectionDataStoreName
404
+ * A fully-qualified path representing project_location_collection_data_store resource.
405
+ * @returns {string} A string representing the project.
406
+ */
407
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
408
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
409
+ }
410
+ /**
411
+ * Parse the location from ProjectLocationCollectionDataStore resource.
412
+ *
413
+ * @param {string} projectLocationCollectionDataStoreName
414
+ * A fully-qualified path representing project_location_collection_data_store resource.
415
+ * @returns {string} A string representing the location.
416
+ */
417
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
418
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
419
+ }
420
+ /**
421
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
422
+ *
423
+ * @param {string} projectLocationCollectionDataStoreName
424
+ * A fully-qualified path representing project_location_collection_data_store resource.
425
+ * @returns {string} A string representing the collection.
426
+ */
427
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
428
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
429
+ }
430
+ /**
431
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
432
+ *
433
+ * @param {string} projectLocationCollectionDataStoreName
434
+ * A fully-qualified path representing project_location_collection_data_store resource.
435
+ * @returns {string} A string representing the data_store.
436
+ */
437
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
438
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
439
+ }
323
440
  /**
324
441
  * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
325
442
  *
@@ -677,6 +794,51 @@ class RecommendationServiceClient {
677
794
  matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
678
795
  return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
679
796
  }
797
+ /**
798
+ * Return a fully-qualified projectLocationDataStore resource name string.
799
+ *
800
+ * @param {string} project
801
+ * @param {string} location
802
+ * @param {string} data_store
803
+ * @returns {string} Resource name string.
804
+ */
805
+ projectLocationDataStorePath(project, location, dataStore) {
806
+ return this.pathTemplates.projectLocationDataStorePathTemplate.render({
807
+ project: project,
808
+ location: location,
809
+ data_store: dataStore,
810
+ });
811
+ }
812
+ /**
813
+ * Parse the project from ProjectLocationDataStore resource.
814
+ *
815
+ * @param {string} projectLocationDataStoreName
816
+ * A fully-qualified path representing project_location_data_store resource.
817
+ * @returns {string} A string representing the project.
818
+ */
819
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
820
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
821
+ }
822
+ /**
823
+ * Parse the location from ProjectLocationDataStore resource.
824
+ *
825
+ * @param {string} projectLocationDataStoreName
826
+ * A fully-qualified path representing project_location_data_store resource.
827
+ * @returns {string} A string representing the location.
828
+ */
829
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
830
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
831
+ }
832
+ /**
833
+ * Parse the data_store from ProjectLocationDataStore resource.
834
+ *
835
+ * @param {string} projectLocationDataStoreName
836
+ * A fully-qualified path representing project_location_data_store resource.
837
+ * @returns {string} A string representing the data_store.
838
+ */
839
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
840
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
841
+ }
680
842
  /**
681
843
  * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
682
844
  *
@@ -553,6 +553,48 @@ export declare class SchemaServiceClient {
553
553
  * ```
554
554
  */
555
555
  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>;
556
+ /**
557
+ * Return a fully-qualified engine resource name string.
558
+ *
559
+ * @param {string} project
560
+ * @param {string} location
561
+ * @param {string} collection
562
+ * @param {string} engine
563
+ * @returns {string} Resource name string.
564
+ */
565
+ enginePath(project: string, location: string, collection: string, engine: string): string;
566
+ /**
567
+ * Parse the project from Engine resource.
568
+ *
569
+ * @param {string} engineName
570
+ * A fully-qualified path representing Engine resource.
571
+ * @returns {string} A string representing the project.
572
+ */
573
+ matchProjectFromEngineName(engineName: string): string | number;
574
+ /**
575
+ * Parse the location from Engine resource.
576
+ *
577
+ * @param {string} engineName
578
+ * A fully-qualified path representing Engine resource.
579
+ * @returns {string} A string representing the location.
580
+ */
581
+ matchLocationFromEngineName(engineName: string): string | number;
582
+ /**
583
+ * Parse the collection from Engine resource.
584
+ *
585
+ * @param {string} engineName
586
+ * A fully-qualified path representing Engine resource.
587
+ * @returns {string} A string representing the collection.
588
+ */
589
+ matchCollectionFromEngineName(engineName: string): string | number;
590
+ /**
591
+ * Parse the engine from Engine resource.
592
+ *
593
+ * @param {string} engineName
594
+ * A fully-qualified path representing Engine resource.
595
+ * @returns {string} A string representing the engine.
596
+ */
597
+ matchEngineFromEngineName(engineName: string): string | number;
556
598
  /**
557
599
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
558
600
  *
@@ -138,6 +138,7 @@ class SchemaServiceClient {
138
138
  // identifiers to uniquely identify resources within the API.
139
139
  // Create useful helper objects for these.
140
140
  this.pathTemplates = {
141
+ enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
141
142
  projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
142
143
  projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
143
144
  projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
@@ -801,6 +802,63 @@ class SchemaServiceClient {
801
802
  // --------------------
802
803
  // -- Path templates --
803
804
  // --------------------
805
+ /**
806
+ * Return a fully-qualified engine resource name string.
807
+ *
808
+ * @param {string} project
809
+ * @param {string} location
810
+ * @param {string} collection
811
+ * @param {string} engine
812
+ * @returns {string} Resource name string.
813
+ */
814
+ enginePath(project, location, collection, engine) {
815
+ return this.pathTemplates.enginePathTemplate.render({
816
+ project: project,
817
+ location: location,
818
+ collection: collection,
819
+ engine: engine,
820
+ });
821
+ }
822
+ /**
823
+ * Parse the project from Engine resource.
824
+ *
825
+ * @param {string} engineName
826
+ * A fully-qualified path representing Engine resource.
827
+ * @returns {string} A string representing the project.
828
+ */
829
+ matchProjectFromEngineName(engineName) {
830
+ return this.pathTemplates.enginePathTemplate.match(engineName).project;
831
+ }
832
+ /**
833
+ * Parse the location from Engine resource.
834
+ *
835
+ * @param {string} engineName
836
+ * A fully-qualified path representing Engine resource.
837
+ * @returns {string} A string representing the location.
838
+ */
839
+ matchLocationFromEngineName(engineName) {
840
+ return this.pathTemplates.enginePathTemplate.match(engineName).location;
841
+ }
842
+ /**
843
+ * Parse the collection from Engine resource.
844
+ *
845
+ * @param {string} engineName
846
+ * A fully-qualified path representing Engine resource.
847
+ * @returns {string} A string representing the collection.
848
+ */
849
+ matchCollectionFromEngineName(engineName) {
850
+ return this.pathTemplates.enginePathTemplate.match(engineName).collection;
851
+ }
852
+ /**
853
+ * Parse the engine from Engine resource.
854
+ *
855
+ * @param {string} engineName
856
+ * A fully-qualified path representing Engine resource.
857
+ * @returns {string} A string representing the engine.
858
+ */
859
+ matchEngineFromEngineName(engineName) {
860
+ return this.pathTemplates.enginePathTemplate.match(engineName).engine;
861
+ }
804
862
  /**
805
863
  * Return a fully-qualified projectLocationCollectionDataStore resource name string.
806
864
  *