@google-cloud/discoveryengine 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +63 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
  16. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
  29. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +40 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  36. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  39. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +38 -0
  40. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
  42. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
  43. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  45. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  46. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  47. package/build/protos/protos.d.ts +42822 -21397
  48. package/build/protos/protos.js +110509 -61572
  49. package/build/protos/protos.json +11779 -6752
  50. package/build/src/index.d.ts +10 -1
  51. package/build/src/index.js +11 -2
  52. package/build/src/v1/completion_service_client.d.ts +489 -7
  53. package/build/src/v1/completion_service_client.js +716 -12
  54. package/build/src/v1/completion_service_client_config.json +10 -0
  55. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  56. package/build/src/v1/conversational_search_service_client.js +467 -10
  57. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  58. package/build/src/v1/data_store_service_client.js +1768 -0
  59. package/build/src/v1/data_store_service_client_config.json +46 -0
  60. package/build/src/v1/document_service_client.d.ts +347 -2
  61. package/build/src/v1/document_service_client.js +507 -10
  62. package/build/src/v1/engine_service_client.d.ts +1211 -0
  63. package/build/src/v1/engine_service_client.js +1731 -0
  64. package/build/src/v1/engine_service_client_config.json +46 -0
  65. package/build/src/v1/index.d.ts +3 -0
  66. package/build/src/v1/index.js +8 -2
  67. package/build/src/v1/schema_service_client.d.ts +272 -2
  68. package/build/src/v1/schema_service_client.js +403 -10
  69. package/build/src/v1/search_service_client.d.ts +515 -11
  70. package/build/src/v1/search_service_client.js +649 -16
  71. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  72. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  73. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  74. package/build/src/v1/user_event_service_client.d.ts +272 -2
  75. package/build/src/v1/user_event_service_client.js +403 -10
  76. package/build/src/v1alpha/completion_service_client.d.ts +230 -2
  77. package/build/src/v1alpha/completion_service_client.js +339 -10
  78. package/build/src/v1alpha/conversational_search_service_client.d.ts +247 -2
  79. package/build/src/v1alpha/conversational_search_service_client.js +339 -10
  80. package/build/src/v1alpha/data_store_service_client.d.ts +230 -2
  81. package/build/src/v1alpha/data_store_service_client.js +347 -12
  82. package/build/src/v1alpha/document_service_client.d.ts +230 -2
  83. package/build/src/v1alpha/document_service_client.js +347 -12
  84. package/build/src/v1alpha/engine_service_client.d.ts +231 -3
  85. package/build/src/v1alpha/engine_service_client.js +347 -12
  86. package/build/src/v1alpha/index.d.ts +1 -0
  87. package/build/src/v1alpha/index.js +4 -2
  88. package/build/src/v1alpha/recommendation_service_client.d.ts +230 -2
  89. package/build/src/v1alpha/recommendation_service_client.js +339 -10
  90. package/build/src/v1alpha/schema_service_client.d.ts +230 -2
  91. package/build/src/v1alpha/schema_service_client.js +347 -12
  92. package/build/src/v1alpha/search_service_client.d.ts +269 -2
  93. package/build/src/v1alpha/search_service_client.js +365 -10
  94. package/build/src/v1alpha/search_tuning_service_client.d.ts +977 -0
  95. package/build/src/v1alpha/search_tuning_service_client.js +1479 -0
  96. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  97. package/build/src/v1alpha/site_search_engine_service_client.d.ts +750 -3
  98. package/build/src/v1alpha/site_search_engine_service_client.js +838 -14
  99. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  100. package/build/src/v1alpha/user_event_service_client.d.ts +230 -2
  101. package/build/src/v1alpha/user_event_service_client.js +347 -12
  102. package/build/src/v1beta/completion_service_client.d.ts +633 -7
  103. package/build/src/v1beta/completion_service_client.js +912 -12
  104. package/build/src/v1beta/completion_service_client_config.json +10 -0
  105. package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
  106. package/build/src/v1beta/conversational_search_service_client.js +467 -10
  107. package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
  108. package/build/src/v1beta/data_store_service_client.js +1966 -0
  109. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  110. package/build/src/v1beta/document_service_client.d.ts +491 -2
  111. package/build/src/v1beta/document_service_client.js +707 -12
  112. package/build/src/v1beta/engine_service_client.d.ts +1357 -0
  113. package/build/src/v1beta/engine_service_client.js +1928 -0
  114. package/build/src/v1beta/engine_service_client_config.json +46 -0
  115. package/build/src/v1beta/index.d.ts +4 -0
  116. package/build/src/v1beta/index.js +10 -2
  117. package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
  118. package/build/src/v1beta/recommendation_service_client.js +571 -10
  119. package/build/src/v1beta/schema_service_client.d.ts +416 -2
  120. package/build/src/v1beta/schema_service_client.js +603 -12
  121. package/build/src/v1beta/search_service_client.d.ts +539 -29
  122. package/build/src/v1beta/search_service_client.js +665 -28
  123. package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
  124. package/build/src/v1beta/serving_config_service_client.js +1563 -0
  125. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  126. package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
  127. package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
  128. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  129. package/build/src/v1beta/user_event_service_client.d.ts +416 -2
  130. package/build/src/v1beta/user_event_service_client.js +603 -12
  131. package/package.json +3 -3
@@ -0,0 +1,1928 @@
1
+ "use strict";
2
+ // Copyright 2024 Google LLC
3
+ //
4
+ // Licensed under the Apache License, Version 2.0 (the "License");
5
+ // you may not use this file except in compliance with the License.
6
+ // You may obtain a copy of the License at
7
+ //
8
+ // https://www.apache.org/licenses/LICENSE-2.0
9
+ //
10
+ // Unless required by applicable law or agreed to in writing, software
11
+ // distributed under the License is distributed on an "AS IS" BASIS,
12
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ // See the License for the specific language governing permissions and
14
+ // limitations under the License.
15
+ //
16
+ // ** This file is automatically generated by gapic-generator-typescript. **
17
+ // ** https://github.com/googleapis/gapic-generator-typescript **
18
+ // ** All changes to this file may be overwritten. **
19
+ Object.defineProperty(exports, "__esModule", { value: true });
20
+ exports.EngineServiceClient = void 0;
21
+ const jsonProtos = require("../../protos/protos.json");
22
+ /**
23
+ * Client JSON configuration object, loaded from
24
+ * `src/v1beta/engine_service_client_config.json`.
25
+ * This file defines retry strategy and timeouts for all API methods in this library.
26
+ */
27
+ const gapicConfig = require("./engine_service_client_config.json");
28
+ const version = require('../../../package.json').version;
29
+ /**
30
+ * Service for managing {@link protos.google.cloud.discoveryengine.v1beta.Engine|Engine}
31
+ * configuration.
32
+ * @class
33
+ * @memberof v1beta
34
+ */
35
+ class EngineServiceClient {
36
+ /**
37
+ * Construct an instance of EngineServiceClient.
38
+ *
39
+ * @param {object} [options] - The configuration object.
40
+ * The options accepted by the constructor are described in detail
41
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
42
+ * The common options are:
43
+ * @param {object} [options.credentials] - Credentials object.
44
+ * @param {string} [options.credentials.client_email]
45
+ * @param {string} [options.credentials.private_key]
46
+ * @param {string} [options.email] - Account email address. Required when
47
+ * using a .pem or .p12 keyFilename.
48
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
49
+ * .p12 key downloaded from the Google Developers Console. If you provide
50
+ * a path to a JSON file, the projectId option below is not necessary.
51
+ * NOTE: .pem and .p12 require you to specify options.email as well.
52
+ * @param {number} [options.port] - The port on which to connect to
53
+ * the remote host.
54
+ * @param {string} [options.projectId] - The project ID from the Google
55
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
56
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
57
+ * app is running in an environment which supports
58
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
59
+ * your project ID will be detected automatically.
60
+ * @param {string} [options.apiEndpoint] - The domain name of the
61
+ * API remote host.
62
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
63
+ * Follows the structure of {@link gapicConfig}.
64
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
65
+ * For more information, please check the
66
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
67
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
68
+ * need to avoid loading the default gRPC version and want to use the fallback
69
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
70
+ * ```
71
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
72
+ * const client = new EngineServiceClient({fallback: true}, gax);
73
+ * ```
74
+ */
75
+ constructor(opts, gaxInstance) {
76
+ var _a, _b, _c, _d;
77
+ this._terminated = false;
78
+ this.descriptors = {
79
+ page: {},
80
+ stream: {},
81
+ longrunning: {},
82
+ batching: {},
83
+ };
84
+ // Ensure that options include all the required fields.
85
+ const staticMembers = this.constructor;
86
+ if ((opts === null || opts === void 0 ? void 0 : opts.universe_domain) &&
87
+ (opts === null || opts === void 0 ? void 0 : opts.universeDomain) &&
88
+ (opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== (opts === null || opts === void 0 ? void 0 : opts.universeDomain)) {
89
+ throw new Error('Please set either universe_domain or universeDomain, but not both.');
90
+ }
91
+ this._universeDomain =
92
+ (_b = (_a = opts === null || opts === void 0 ? void 0 : opts.universeDomain) !== null && _a !== void 0 ? _a : opts === null || opts === void 0 ? void 0 : opts.universe_domain) !== null && _b !== void 0 ? _b : 'googleapis.com';
93
+ this._servicePath = 'discoveryengine.' + this._universeDomain;
94
+ const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || this._servicePath;
95
+ this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
96
+ const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
97
+ const clientConfig = (_c = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _c !== void 0 ? _c : {};
98
+ const fallback = (_d = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _d !== void 0 ? _d : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
99
+ opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
100
+ // Request numeric enum values if REST transport is used.
101
+ opts.numericEnums = true;
102
+ // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
103
+ if (servicePath !== this._servicePath && !('scopes' in opts)) {
104
+ opts['scopes'] = staticMembers.scopes;
105
+ }
106
+ // Load google-gax module synchronously if needed
107
+ if (!gaxInstance) {
108
+ gaxInstance = require('google-gax');
109
+ }
110
+ // Choose either gRPC or proto-over-HTTP implementation of google-gax.
111
+ this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
112
+ // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
113
+ this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
114
+ // Save options to use in initialize() method.
115
+ this._opts = opts;
116
+ // Save the auth object to the client, for use by other methods.
117
+ this.auth = this._gaxGrpc.auth;
118
+ // Set useJWTAccessWithScope on the auth object.
119
+ this.auth.useJWTAccessWithScope = true;
120
+ // Set defaultServicePath on the auth object.
121
+ this.auth.defaultServicePath = this._servicePath;
122
+ // Set the default scopes in auth client if needed.
123
+ if (servicePath === this._servicePath) {
124
+ this.auth.defaultScopes = staticMembers.scopes;
125
+ }
126
+ this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
127
+ // Determine the client header string.
128
+ const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
129
+ if (typeof process !== 'undefined' && 'versions' in process) {
130
+ clientHeader.push(`gl-node/${process.versions.node}`);
131
+ }
132
+ else {
133
+ clientHeader.push(`gl-web/${this._gaxModule.version}`);
134
+ }
135
+ if (!opts.fallback) {
136
+ clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
137
+ }
138
+ else {
139
+ clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
140
+ }
141
+ if (opts.libName && opts.libVersion) {
142
+ clientHeader.push(`${opts.libName}/${opts.libVersion}`);
143
+ }
144
+ // Load the applicable protos.
145
+ this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
146
+ // This API contains "path templates"; forward-slash-separated
147
+ // identifiers to uniquely identify resources within the API.
148
+ // Create useful helper objects for these.
149
+ this.pathTemplates = {
150
+ collectionPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}'),
151
+ enginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}'),
152
+ projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
153
+ projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
154
+ projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
155
+ projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
156
+ projectLocationCollectionDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/servingConfigs/{serving_config}'),
157
+ projectLocationCollectionDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine'),
158
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
159
+ projectLocationCollectionEngineConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/conversations/{conversation}'),
160
+ projectLocationCollectionEngineServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/servingConfigs/{serving_config}'),
161
+ projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
162
+ projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
163
+ projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
164
+ projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
165
+ projectLocationDataStoreServingConfigPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/servingConfigs/{serving_config}'),
166
+ projectLocationDataStoreSiteSearchEnginePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine'),
167
+ projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}'),
168
+ };
169
+ // Some of the methods on this service return "paged" results,
170
+ // (e.g. 50 results at a time, with tokens to get subsequent
171
+ // pages). Denote the keys used for pagination and results.
172
+ this.descriptors.page = {
173
+ listEngines: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'engines'),
174
+ };
175
+ const protoFilesRoot = this._gaxModule.protobuf.Root.fromJSON(jsonProtos);
176
+ // This API contains "long-running operations", which return a
177
+ // an Operation object that allows for tracking of the operation,
178
+ // rather than holding a request open.
179
+ const lroOptions = {
180
+ auth: this.auth,
181
+ grpc: 'grpc' in this._gaxGrpc ? this._gaxGrpc.grpc : undefined,
182
+ };
183
+ if (opts.fallback) {
184
+ lroOptions.protoJson = protoFilesRoot;
185
+ lroOptions.httpRules = [
186
+ {
187
+ selector: 'google.longrunning.Operations.GetOperation',
188
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}',
189
+ additional_bindings: [
190
+ {
191
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}',
192
+ },
193
+ {
194
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}',
195
+ },
196
+ {
197
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}',
198
+ },
199
+ {
200
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}',
201
+ },
202
+ {
203
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}',
204
+ },
205
+ {
206
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}',
207
+ },
208
+ {
209
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/engines/*/operations/*}',
210
+ },
211
+ {
212
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}',
213
+ },
214
+ {
215
+ get: '/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}',
216
+ },
217
+ {
218
+ get: '/v1beta/{name=projects/*/locations/*/dataStores/*/models/*/operations/*}',
219
+ },
220
+ {
221
+ get: '/v1beta/{name=projects/*/locations/*/dataStores/*/operations/*}',
222
+ },
223
+ { get: '/v1beta/{name=projects/*/locations/*/operations/*}' },
224
+ { get: '/v1beta/{name=projects/*/operations/*}' },
225
+ ],
226
+ },
227
+ {
228
+ selector: 'google.longrunning.Operations.ListOperations',
229
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataConnector}/operations',
230
+ additional_bindings: [
231
+ {
232
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations',
233
+ },
234
+ {
235
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations',
236
+ },
237
+ {
238
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations',
239
+ },
240
+ {
241
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations',
242
+ },
243
+ {
244
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations',
245
+ },
246
+ {
247
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations',
248
+ },
249
+ {
250
+ get: '/v1beta/{name=projects/*/locations/*/collections/*/engines/*}/operations',
251
+ },
252
+ {
253
+ get: '/v1beta/{name=projects/*/locations/*/collections/*}/operations',
254
+ },
255
+ {
256
+ get: '/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*}/operations',
257
+ },
258
+ {
259
+ get: '/v1beta/{name=projects/*/locations/*/dataStores/*/models/*}/operations',
260
+ },
261
+ {
262
+ get: '/v1beta/{name=projects/*/locations/*/dataStores/*}/operations',
263
+ },
264
+ { get: '/v1beta/{name=projects/*/locations/*}/operations' },
265
+ { get: '/v1beta/{name=projects/*}/operations' },
266
+ ],
267
+ },
268
+ ];
269
+ }
270
+ this.operationsClient = this._gaxModule
271
+ .lro(lroOptions)
272
+ .operationsClient(opts);
273
+ const createEngineResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.Engine');
274
+ const createEngineMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.CreateEngineMetadata');
275
+ const deleteEngineResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
276
+ const deleteEngineMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.DeleteEngineMetadata');
277
+ this.descriptors.longrunning = {
278
+ createEngine: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createEngineResponse.decode.bind(createEngineResponse), createEngineMetadata.decode.bind(createEngineMetadata)),
279
+ deleteEngine: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteEngineResponse.decode.bind(deleteEngineResponse), deleteEngineMetadata.decode.bind(deleteEngineMetadata)),
280
+ };
281
+ // Put together the default options sent with requests.
282
+ this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1beta.EngineService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
283
+ // Set up a dictionary of "inner API calls"; the core implementation
284
+ // of calling the API is handled in `google-gax`, with this code
285
+ // merely providing the destination and request information.
286
+ this.innerApiCalls = {};
287
+ // Add a warn function to the client constructor so it can be easily tested.
288
+ this.warn = this._gaxModule.warn;
289
+ }
290
+ /**
291
+ * Initialize the client.
292
+ * Performs asynchronous operations (such as authentication) and prepares the client.
293
+ * This function will be called automatically when any class method is called for the
294
+ * first time, but if you need to initialize it before calling an actual method,
295
+ * feel free to call initialize() directly.
296
+ *
297
+ * You can await on this method if you want to make sure the client is initialized.
298
+ *
299
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
300
+ */
301
+ initialize() {
302
+ // If the client stub promise is already initialized, return immediately.
303
+ if (this.engineServiceStub) {
304
+ return this.engineServiceStub;
305
+ }
306
+ // Put together the "service stub" for
307
+ // google.cloud.discoveryengine.v1beta.EngineService.
308
+ this.engineServiceStub = this._gaxGrpc.createStub(this._opts.fallback
309
+ ? this._protos.lookupService('google.cloud.discoveryengine.v1beta.EngineService')
310
+ : // eslint-disable-next-line @typescript-eslint/no-explicit-any
311
+ this._protos.google.cloud.discoveryengine.v1beta
312
+ .EngineService, this._opts, this._providedCustomServicePath);
313
+ // Iterate over each of the methods that the service provides
314
+ // and create an API call method for each.
315
+ const engineServiceStubMethods = [
316
+ 'createEngine',
317
+ 'deleteEngine',
318
+ 'updateEngine',
319
+ 'getEngine',
320
+ 'listEngines',
321
+ ];
322
+ for (const methodName of engineServiceStubMethods) {
323
+ const callPromise = this.engineServiceStub.then(stub => (...args) => {
324
+ if (this._terminated) {
325
+ return Promise.reject('The client has already been closed.');
326
+ }
327
+ const func = stub[methodName];
328
+ return func.apply(stub, args);
329
+ }, (err) => () => {
330
+ throw err;
331
+ });
332
+ const descriptor = this.descriptors.page[methodName] ||
333
+ this.descriptors.longrunning[methodName] ||
334
+ undefined;
335
+ const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
336
+ this.innerApiCalls[methodName] = apiCall;
337
+ }
338
+ return this.engineServiceStub;
339
+ }
340
+ /**
341
+ * The DNS address for this API service.
342
+ * @deprecated Use the apiEndpoint method of the client instance.
343
+ * @returns {string} The DNS address for this service.
344
+ */
345
+ static get servicePath() {
346
+ if (typeof process !== undefined &&
347
+ typeof process.emitWarning === 'function') {
348
+ process.emitWarning('Static servicePath is deprecated, please use the instance method instead.', 'DeprecationWarning');
349
+ }
350
+ return 'discoveryengine.googleapis.com';
351
+ }
352
+ /**
353
+ * The DNS address for this API service - same as servicePath.
354
+ * @deprecated Use the apiEndpoint method of the client instance.
355
+ * @returns {string} The DNS address for this service.
356
+ */
357
+ static get apiEndpoint() {
358
+ if (typeof process !== undefined &&
359
+ typeof process.emitWarning === 'function') {
360
+ process.emitWarning('Static apiEndpoint is deprecated, please use the instance method instead.', 'DeprecationWarning');
361
+ }
362
+ return 'discoveryengine.googleapis.com';
363
+ }
364
+ /**
365
+ * The DNS address for this API service.
366
+ * @returns {string} The DNS address for this service.
367
+ */
368
+ get apiEndpoint() {
369
+ return this._servicePath;
370
+ }
371
+ get universeDomain() {
372
+ return this._universeDomain;
373
+ }
374
+ /**
375
+ * The port for this API service.
376
+ * @returns {number} The default port for this service.
377
+ */
378
+ static get port() {
379
+ return 443;
380
+ }
381
+ /**
382
+ * The scopes needed to make gRPC calls for every method defined
383
+ * in this service.
384
+ * @returns {string[]} List of default scopes.
385
+ */
386
+ static get scopes() {
387
+ return ['https://www.googleapis.com/auth/cloud-platform'];
388
+ }
389
+ /**
390
+ * Return the project ID used by this class.
391
+ * @returns {Promise} A promise that resolves to string containing the project ID.
392
+ */
393
+ getProjectId(callback) {
394
+ if (callback) {
395
+ this.auth.getProjectId(callback);
396
+ return;
397
+ }
398
+ return this.auth.getProjectId();
399
+ }
400
+ updateEngine(request, optionsOrCallback, callback) {
401
+ var _a;
402
+ request = request || {};
403
+ let options;
404
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
405
+ callback = optionsOrCallback;
406
+ options = {};
407
+ }
408
+ else {
409
+ options = optionsOrCallback;
410
+ }
411
+ options = options || {};
412
+ options.otherArgs = options.otherArgs || {};
413
+ options.otherArgs.headers = options.otherArgs.headers || {};
414
+ options.otherArgs.headers['x-goog-request-params'] =
415
+ this._gaxModule.routingHeader.fromParams({
416
+ 'engine.name': (_a = request.engine.name) !== null && _a !== void 0 ? _a : '',
417
+ });
418
+ this.initialize();
419
+ return this.innerApiCalls.updateEngine(request, options, callback);
420
+ }
421
+ getEngine(request, optionsOrCallback, callback) {
422
+ var _a;
423
+ request = request || {};
424
+ let options;
425
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
426
+ callback = optionsOrCallback;
427
+ options = {};
428
+ }
429
+ else {
430
+ options = optionsOrCallback;
431
+ }
432
+ options = options || {};
433
+ options.otherArgs = options.otherArgs || {};
434
+ options.otherArgs.headers = options.otherArgs.headers || {};
435
+ options.otherArgs.headers['x-goog-request-params'] =
436
+ this._gaxModule.routingHeader.fromParams({
437
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
438
+ });
439
+ this.initialize();
440
+ return this.innerApiCalls.getEngine(request, options, callback);
441
+ }
442
+ createEngine(request, optionsOrCallback, callback) {
443
+ var _a;
444
+ request = request || {};
445
+ let options;
446
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
447
+ callback = optionsOrCallback;
448
+ options = {};
449
+ }
450
+ else {
451
+ options = optionsOrCallback;
452
+ }
453
+ options = options || {};
454
+ options.otherArgs = options.otherArgs || {};
455
+ options.otherArgs.headers = options.otherArgs.headers || {};
456
+ options.otherArgs.headers['x-goog-request-params'] =
457
+ this._gaxModule.routingHeader.fromParams({
458
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
459
+ });
460
+ this.initialize();
461
+ return this.innerApiCalls.createEngine(request, options, callback);
462
+ }
463
+ /**
464
+ * Check the status of the long running operation returned by `createEngine()`.
465
+ * @param {String} name
466
+ * The operation name that will be passed.
467
+ * @returns {Promise} - The promise which resolves to an object.
468
+ * The decoded operation object has result and metadata field to get information from.
469
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
470
+ * for more details and examples.
471
+ * @example <caption>include:samples/generated/v1beta/engine_service.create_engine.js</caption>
472
+ * region_tag:discoveryengine_v1beta_generated_EngineService_CreateEngine_async
473
+ */
474
+ async checkCreateEngineProgress(name) {
475
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
476
+ const [operation] = await this.operationsClient.getOperation(request);
477
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.createEngine, this._gaxModule.createDefaultBackoffSettings());
478
+ return decodeOperation;
479
+ }
480
+ deleteEngine(request, optionsOrCallback, callback) {
481
+ var _a;
482
+ request = request || {};
483
+ let options;
484
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
485
+ callback = optionsOrCallback;
486
+ options = {};
487
+ }
488
+ else {
489
+ options = optionsOrCallback;
490
+ }
491
+ options = options || {};
492
+ options.otherArgs = options.otherArgs || {};
493
+ options.otherArgs.headers = options.otherArgs.headers || {};
494
+ options.otherArgs.headers['x-goog-request-params'] =
495
+ this._gaxModule.routingHeader.fromParams({
496
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
497
+ });
498
+ this.initialize();
499
+ return this.innerApiCalls.deleteEngine(request, options, callback);
500
+ }
501
+ /**
502
+ * Check the status of the long running operation returned by `deleteEngine()`.
503
+ * @param {String} name
504
+ * The operation name that will be passed.
505
+ * @returns {Promise} - The promise which resolves to an object.
506
+ * The decoded operation object has result and metadata field to get information from.
507
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
508
+ * for more details and examples.
509
+ * @example <caption>include:samples/generated/v1beta/engine_service.delete_engine.js</caption>
510
+ * region_tag:discoveryengine_v1beta_generated_EngineService_DeleteEngine_async
511
+ */
512
+ async checkDeleteEngineProgress(name) {
513
+ const request = new this._gaxModule.operationsProtos.google.longrunning.GetOperationRequest({ name });
514
+ const [operation] = await this.operationsClient.getOperation(request);
515
+ const decodeOperation = new this._gaxModule.Operation(operation, this.descriptors.longrunning.deleteEngine, this._gaxModule.createDefaultBackoffSettings());
516
+ return decodeOperation;
517
+ }
518
+ listEngines(request, optionsOrCallback, callback) {
519
+ var _a;
520
+ request = request || {};
521
+ let options;
522
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
523
+ callback = optionsOrCallback;
524
+ options = {};
525
+ }
526
+ else {
527
+ options = optionsOrCallback;
528
+ }
529
+ options = options || {};
530
+ options.otherArgs = options.otherArgs || {};
531
+ options.otherArgs.headers = options.otherArgs.headers || {};
532
+ options.otherArgs.headers['x-goog-request-params'] =
533
+ this._gaxModule.routingHeader.fromParams({
534
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
535
+ });
536
+ this.initialize();
537
+ return this.innerApiCalls.listEngines(request, options, callback);
538
+ }
539
+ /**
540
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
541
+ * @param {Object} request
542
+ * The request object that will be sent.
543
+ * @param {string} request.parent
544
+ * Required. The parent resource name, such as
545
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
546
+ * @param {number} [request.pageSize]
547
+ * Optional. Not supported.
548
+ * @param {string} [request.pageToken]
549
+ * Optional. Not supported.
550
+ * @param {string} [request.filter]
551
+ * Optional. Filter by solution type. For example:
552
+ * solution_type=SOLUTION_TYPE_SEARCH
553
+ * @param {object} [options]
554
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
555
+ * @returns {Stream}
556
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.Engine|Engine} on 'data' event.
557
+ * The client library will perform auto-pagination by default: it will call the API as many
558
+ * times as needed. Note that it can affect your quota.
559
+ * We recommend using `listEnginesAsync()`
560
+ * method described below for async iteration which you can stop as needed.
561
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
562
+ * for more details and examples.
563
+ */
564
+ listEnginesStream(request, options) {
565
+ var _a;
566
+ request = request || {};
567
+ options = options || {};
568
+ options.otherArgs = options.otherArgs || {};
569
+ options.otherArgs.headers = options.otherArgs.headers || {};
570
+ options.otherArgs.headers['x-goog-request-params'] =
571
+ this._gaxModule.routingHeader.fromParams({
572
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
573
+ });
574
+ const defaultCallSettings = this._defaults['listEngines'];
575
+ const callSettings = defaultCallSettings.merge(options);
576
+ this.initialize();
577
+ return this.descriptors.page.listEngines.createStream(this.innerApiCalls.listEngines, request, callSettings);
578
+ }
579
+ /**
580
+ * Equivalent to `listEngines`, but returns an iterable object.
581
+ *
582
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
583
+ * @param {Object} request
584
+ * The request object that will be sent.
585
+ * @param {string} request.parent
586
+ * Required. The parent resource name, such as
587
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
588
+ * @param {number} [request.pageSize]
589
+ * Optional. Not supported.
590
+ * @param {string} [request.pageToken]
591
+ * Optional. Not supported.
592
+ * @param {string} [request.filter]
593
+ * Optional. Filter by solution type. For example:
594
+ * solution_type=SOLUTION_TYPE_SEARCH
595
+ * @param {object} [options]
596
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
597
+ * @returns {Object}
598
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
599
+ * When you iterate the returned iterable, each element will be an object representing
600
+ * {@link protos.google.cloud.discoveryengine.v1beta.Engine|Engine}. The API will be called under the hood as needed, once per the page,
601
+ * so you can stop the iteration when you don't need more results.
602
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
603
+ * for more details and examples.
604
+ * @example <caption>include:samples/generated/v1beta/engine_service.list_engines.js</caption>
605
+ * region_tag:discoveryengine_v1beta_generated_EngineService_ListEngines_async
606
+ */
607
+ listEnginesAsync(request, options) {
608
+ var _a;
609
+ request = request || {};
610
+ options = options || {};
611
+ options.otherArgs = options.otherArgs || {};
612
+ options.otherArgs.headers = options.otherArgs.headers || {};
613
+ options.otherArgs.headers['x-goog-request-params'] =
614
+ this._gaxModule.routingHeader.fromParams({
615
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
616
+ });
617
+ const defaultCallSettings = this._defaults['listEngines'];
618
+ const callSettings = defaultCallSettings.merge(options);
619
+ this.initialize();
620
+ return this.descriptors.page.listEngines.asyncIterate(this.innerApiCalls['listEngines'], request, callSettings);
621
+ }
622
+ /**
623
+ * Gets information about a location.
624
+ *
625
+ * @param {Object} request
626
+ * The request object that will be sent.
627
+ * @param {string} request.name
628
+ * Resource name for the location.
629
+ * @param {object} [options]
630
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
631
+ * @returns {Promise} - The promise which resolves to an array.
632
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
633
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
634
+ * for more details and examples.
635
+ * @example
636
+ * ```
637
+ * const [response] = await client.getLocation(request);
638
+ * ```
639
+ */
640
+ getLocation(request, options, callback) {
641
+ return this.locationsClient.getLocation(request, options, callback);
642
+ }
643
+ /**
644
+ * Lists information about the supported locations for this service. Returns an iterable object.
645
+ *
646
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
647
+ * @param {Object} request
648
+ * The request object that will be sent.
649
+ * @param {string} request.name
650
+ * The resource that owns the locations collection, if applicable.
651
+ * @param {string} request.filter
652
+ * The standard list filter.
653
+ * @param {number} request.pageSize
654
+ * The standard list page size.
655
+ * @param {string} request.pageToken
656
+ * The standard list page token.
657
+ * @param {object} [options]
658
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
659
+ * @returns {Object}
660
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
661
+ * When you iterate the returned iterable, each element will be an object representing
662
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
663
+ * so you can stop the iteration when you don't need more results.
664
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
665
+ * for more details and examples.
666
+ * @example
667
+ * ```
668
+ * const iterable = client.listLocationsAsync(request);
669
+ * for await (const response of iterable) {
670
+ * // process response
671
+ * }
672
+ * ```
673
+ */
674
+ listLocationsAsync(request, options) {
675
+ return this.locationsClient.listLocationsAsync(request, options);
676
+ }
677
+ /**
678
+ * Gets the latest state of a long-running operation. Clients can use this
679
+ * method to poll the operation result at intervals as recommended by the API
680
+ * service.
681
+ *
682
+ * @param {Object} request - The request object that will be sent.
683
+ * @param {string} request.name - The name of the operation resource.
684
+ * @param {Object=} options
685
+ * Optional parameters. You can override the default settings for this call,
686
+ * e.g, timeout, retries, paginations, etc. See {@link
687
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
688
+ * for the details.
689
+ * @param {function(?Error, ?Object)=} callback
690
+ * The function which will be called with the result of the API call.
691
+ *
692
+ * The second parameter to the callback is an object representing
693
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
694
+ * @return {Promise} - The promise which resolves to an array.
695
+ * The first element of the array is an object representing
696
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
697
+ * The promise has a method named "cancel" which cancels the ongoing API call.
698
+ *
699
+ * @example
700
+ * ```
701
+ * const client = longrunning.operationsClient();
702
+ * const name = '';
703
+ * const [response] = await client.getOperation({name});
704
+ * // doThingsWith(response)
705
+ * ```
706
+ */
707
+ getOperation(request, options, callback) {
708
+ return this.operationsClient.getOperation(request, options, callback);
709
+ }
710
+ /**
711
+ * Lists operations that match the specified filter in the request. If the
712
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
713
+ *
714
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
715
+ *
716
+ * @param {Object} request - The request object that will be sent.
717
+ * @param {string} request.name - The name of the operation collection.
718
+ * @param {string} request.filter - The standard list filter.
719
+ * @param {number=} request.pageSize -
720
+ * The maximum number of resources contained in the underlying API
721
+ * response. If page streaming is performed per-resource, this
722
+ * parameter does not affect the return value. If page streaming is
723
+ * performed per-page, this determines the maximum number of
724
+ * resources in a page.
725
+ * @param {Object=} options
726
+ * Optional parameters. You can override the default settings for this call,
727
+ * e.g, timeout, retries, paginations, etc. See {@link
728
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
729
+ * details.
730
+ * @returns {Object}
731
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
732
+ *
733
+ * @example
734
+ * ```
735
+ * const client = longrunning.operationsClient();
736
+ * for await (const response of client.listOperationsAsync(request));
737
+ * // doThingsWith(response)
738
+ * ```
739
+ */
740
+ listOperationsAsync(request, options) {
741
+ return this.operationsClient.listOperationsAsync(request, options);
742
+ }
743
+ /**
744
+ * Starts asynchronous cancellation on a long-running operation. The server
745
+ * makes a best effort to cancel the operation, but success is not
746
+ * guaranteed. If the server doesn't support this method, it returns
747
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
748
+ * {@link Operations.GetOperation} or
749
+ * other methods to check whether the cancellation succeeded or whether the
750
+ * operation completed despite cancellation. On successful cancellation,
751
+ * the operation is not deleted; instead, it becomes an operation with
752
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
753
+ * 1, corresponding to `Code.CANCELLED`.
754
+ *
755
+ * @param {Object} request - The request object that will be sent.
756
+ * @param {string} request.name - The name of the operation resource to be cancelled.
757
+ * @param {Object=} options
758
+ * Optional parameters. You can override the default settings for this call,
759
+ * e.g, timeout, retries, paginations, etc. See {@link
760
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
761
+ * details.
762
+ * @param {function(?Error)=} callback
763
+ * The function which will be called with the result of the API call.
764
+ * @return {Promise} - The promise which resolves when API call finishes.
765
+ * The promise has a method named "cancel" which cancels the ongoing API
766
+ * call.
767
+ *
768
+ * @example
769
+ * ```
770
+ * const client = longrunning.operationsClient();
771
+ * await client.cancelOperation({name: ''});
772
+ * ```
773
+ */
774
+ cancelOperation(request, options, callback) {
775
+ return this.operationsClient.cancelOperation(request, options, callback);
776
+ }
777
+ /**
778
+ * Deletes a long-running operation. This method indicates that the client is
779
+ * no longer interested in the operation result. It does not cancel the
780
+ * operation. If the server doesn't support this method, it returns
781
+ * `google.rpc.Code.UNIMPLEMENTED`.
782
+ *
783
+ * @param {Object} request - The request object that will be sent.
784
+ * @param {string} request.name - The name of the operation resource to be deleted.
785
+ * @param {Object=} options
786
+ * Optional parameters. You can override the default settings for this call,
787
+ * e.g, timeout, retries, paginations, etc. See {@link
788
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
789
+ * for the details.
790
+ * @param {function(?Error)=} callback
791
+ * The function which will be called with the result of the API call.
792
+ * @return {Promise} - The promise which resolves when API call finishes.
793
+ * The promise has a method named "cancel" which cancels the ongoing API
794
+ * call.
795
+ *
796
+ * @example
797
+ * ```
798
+ * const client = longrunning.operationsClient();
799
+ * await client.deleteOperation({name: ''});
800
+ * ```
801
+ */
802
+ deleteOperation(request, options, callback) {
803
+ return this.operationsClient.deleteOperation(request, options, callback);
804
+ }
805
+ // --------------------
806
+ // -- Path templates --
807
+ // --------------------
808
+ /**
809
+ * Return a fully-qualified collection resource name string.
810
+ *
811
+ * @param {string} project
812
+ * @param {string} location
813
+ * @param {string} collection
814
+ * @returns {string} Resource name string.
815
+ */
816
+ collectionPath(project, location, collection) {
817
+ return this.pathTemplates.collectionPathTemplate.render({
818
+ project: project,
819
+ location: location,
820
+ collection: collection,
821
+ });
822
+ }
823
+ /**
824
+ * Parse the project from Collection resource.
825
+ *
826
+ * @param {string} collectionName
827
+ * A fully-qualified path representing Collection resource.
828
+ * @returns {string} A string representing the project.
829
+ */
830
+ matchProjectFromCollectionName(collectionName) {
831
+ return this.pathTemplates.collectionPathTemplate.match(collectionName)
832
+ .project;
833
+ }
834
+ /**
835
+ * Parse the location from Collection resource.
836
+ *
837
+ * @param {string} collectionName
838
+ * A fully-qualified path representing Collection resource.
839
+ * @returns {string} A string representing the location.
840
+ */
841
+ matchLocationFromCollectionName(collectionName) {
842
+ return this.pathTemplates.collectionPathTemplate.match(collectionName)
843
+ .location;
844
+ }
845
+ /**
846
+ * Parse the collection from Collection resource.
847
+ *
848
+ * @param {string} collectionName
849
+ * A fully-qualified path representing Collection resource.
850
+ * @returns {string} A string representing the collection.
851
+ */
852
+ matchCollectionFromCollectionName(collectionName) {
853
+ return this.pathTemplates.collectionPathTemplate.match(collectionName)
854
+ .collection;
855
+ }
856
+ /**
857
+ * Return a fully-qualified engine resource name string.
858
+ *
859
+ * @param {string} project
860
+ * @param {string} location
861
+ * @param {string} collection
862
+ * @param {string} engine
863
+ * @returns {string} Resource name string.
864
+ */
865
+ enginePath(project, location, collection, engine) {
866
+ return this.pathTemplates.enginePathTemplate.render({
867
+ project: project,
868
+ location: location,
869
+ collection: collection,
870
+ engine: engine,
871
+ });
872
+ }
873
+ /**
874
+ * Parse the project from Engine resource.
875
+ *
876
+ * @param {string} engineName
877
+ * A fully-qualified path representing Engine resource.
878
+ * @returns {string} A string representing the project.
879
+ */
880
+ matchProjectFromEngineName(engineName) {
881
+ return this.pathTemplates.enginePathTemplate.match(engineName).project;
882
+ }
883
+ /**
884
+ * Parse the location from Engine resource.
885
+ *
886
+ * @param {string} engineName
887
+ * A fully-qualified path representing Engine resource.
888
+ * @returns {string} A string representing the location.
889
+ */
890
+ matchLocationFromEngineName(engineName) {
891
+ return this.pathTemplates.enginePathTemplate.match(engineName).location;
892
+ }
893
+ /**
894
+ * Parse the collection from Engine resource.
895
+ *
896
+ * @param {string} engineName
897
+ * A fully-qualified path representing Engine resource.
898
+ * @returns {string} A string representing the collection.
899
+ */
900
+ matchCollectionFromEngineName(engineName) {
901
+ return this.pathTemplates.enginePathTemplate.match(engineName).collection;
902
+ }
903
+ /**
904
+ * Parse the engine from Engine resource.
905
+ *
906
+ * @param {string} engineName
907
+ * A fully-qualified path representing Engine resource.
908
+ * @returns {string} A string representing the engine.
909
+ */
910
+ matchEngineFromEngineName(engineName) {
911
+ return this.pathTemplates.enginePathTemplate.match(engineName).engine;
912
+ }
913
+ /**
914
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
915
+ *
916
+ * @param {string} project
917
+ * @param {string} location
918
+ * @param {string} collection
919
+ * @param {string} data_store
920
+ * @returns {string} Resource name string.
921
+ */
922
+ projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
923
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
924
+ project: project,
925
+ location: location,
926
+ collection: collection,
927
+ data_store: dataStore,
928
+ });
929
+ }
930
+ /**
931
+ * Parse the project from ProjectLocationCollectionDataStore resource.
932
+ *
933
+ * @param {string} projectLocationCollectionDataStoreName
934
+ * A fully-qualified path representing project_location_collection_data_store resource.
935
+ * @returns {string} A string representing the project.
936
+ */
937
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
938
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
939
+ }
940
+ /**
941
+ * Parse the location from ProjectLocationCollectionDataStore resource.
942
+ *
943
+ * @param {string} projectLocationCollectionDataStoreName
944
+ * A fully-qualified path representing project_location_collection_data_store resource.
945
+ * @returns {string} A string representing the location.
946
+ */
947
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
948
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
949
+ }
950
+ /**
951
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
952
+ *
953
+ * @param {string} projectLocationCollectionDataStoreName
954
+ * A fully-qualified path representing project_location_collection_data_store resource.
955
+ * @returns {string} A string representing the collection.
956
+ */
957
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
958
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
959
+ }
960
+ /**
961
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
962
+ *
963
+ * @param {string} projectLocationCollectionDataStoreName
964
+ * A fully-qualified path representing project_location_collection_data_store resource.
965
+ * @returns {string} A string representing the data_store.
966
+ */
967
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
968
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
969
+ }
970
+ /**
971
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
972
+ *
973
+ * @param {string} project
974
+ * @param {string} location
975
+ * @param {string} collection
976
+ * @param {string} data_store
977
+ * @param {string} branch
978
+ * @param {string} document
979
+ * @returns {string} Resource name string.
980
+ */
981
+ projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document) {
982
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.render({
983
+ project: project,
984
+ location: location,
985
+ collection: collection,
986
+ data_store: dataStore,
987
+ branch: branch,
988
+ document: document,
989
+ });
990
+ }
991
+ /**
992
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
993
+ *
994
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
995
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
996
+ * @returns {string} A string representing the project.
997
+ */
998
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
999
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).project;
1000
+ }
1001
+ /**
1002
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
1003
+ *
1004
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1005
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1006
+ * @returns {string} A string representing the location.
1007
+ */
1008
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1009
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).location;
1010
+ }
1011
+ /**
1012
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
1013
+ *
1014
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1015
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1016
+ * @returns {string} A string representing the collection.
1017
+ */
1018
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1019
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).collection;
1020
+ }
1021
+ /**
1022
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
1023
+ *
1024
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1025
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1026
+ * @returns {string} A string representing the data_store.
1027
+ */
1028
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1029
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).data_store;
1030
+ }
1031
+ /**
1032
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
1033
+ *
1034
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1035
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1036
+ * @returns {string} A string representing the branch.
1037
+ */
1038
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1039
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).branch;
1040
+ }
1041
+ /**
1042
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
1043
+ *
1044
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1045
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1046
+ * @returns {string} A string representing the document.
1047
+ */
1048
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1049
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
1050
+ }
1051
+ /**
1052
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
1053
+ *
1054
+ * @param {string} project
1055
+ * @param {string} location
1056
+ * @param {string} collection
1057
+ * @param {string} data_store
1058
+ * @param {string} conversation
1059
+ * @returns {string} Resource name string.
1060
+ */
1061
+ projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
1062
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
1063
+ project: project,
1064
+ location: location,
1065
+ collection: collection,
1066
+ data_store: dataStore,
1067
+ conversation: conversation,
1068
+ });
1069
+ }
1070
+ /**
1071
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
1072
+ *
1073
+ * @param {string} projectLocationCollectionDataStoreConversationName
1074
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1075
+ * @returns {string} A string representing the project.
1076
+ */
1077
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1078
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
1079
+ }
1080
+ /**
1081
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
1082
+ *
1083
+ * @param {string} projectLocationCollectionDataStoreConversationName
1084
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1085
+ * @returns {string} A string representing the location.
1086
+ */
1087
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1088
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
1089
+ }
1090
+ /**
1091
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
1092
+ *
1093
+ * @param {string} projectLocationCollectionDataStoreConversationName
1094
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1095
+ * @returns {string} A string representing the collection.
1096
+ */
1097
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1098
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
1099
+ }
1100
+ /**
1101
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
1102
+ *
1103
+ * @param {string} projectLocationCollectionDataStoreConversationName
1104
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1105
+ * @returns {string} A string representing the data_store.
1106
+ */
1107
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1108
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
1109
+ }
1110
+ /**
1111
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
1112
+ *
1113
+ * @param {string} projectLocationCollectionDataStoreConversationName
1114
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1115
+ * @returns {string} A string representing the conversation.
1116
+ */
1117
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1118
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1119
+ }
1120
+ /**
1121
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
1122
+ *
1123
+ * @param {string} project
1124
+ * @param {string} location
1125
+ * @param {string} collection
1126
+ * @param {string} data_store
1127
+ * @param {string} schema
1128
+ * @returns {string} Resource name string.
1129
+ */
1130
+ projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema) {
1131
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.render({
1132
+ project: project,
1133
+ location: location,
1134
+ collection: collection,
1135
+ data_store: dataStore,
1136
+ schema: schema,
1137
+ });
1138
+ }
1139
+ /**
1140
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
1141
+ *
1142
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1143
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1144
+ * @returns {string} A string representing the project.
1145
+ */
1146
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1147
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).project;
1148
+ }
1149
+ /**
1150
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
1151
+ *
1152
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1153
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1154
+ * @returns {string} A string representing the location.
1155
+ */
1156
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1157
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).location;
1158
+ }
1159
+ /**
1160
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
1161
+ *
1162
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1163
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1164
+ * @returns {string} A string representing the collection.
1165
+ */
1166
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1167
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).collection;
1168
+ }
1169
+ /**
1170
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
1171
+ *
1172
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1173
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1174
+ * @returns {string} A string representing the data_store.
1175
+ */
1176
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1177
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).data_store;
1178
+ }
1179
+ /**
1180
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
1181
+ *
1182
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1183
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1184
+ * @returns {string} A string representing the schema.
1185
+ */
1186
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1187
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
1188
+ }
1189
+ /**
1190
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
1191
+ *
1192
+ * @param {string} project
1193
+ * @param {string} location
1194
+ * @param {string} collection
1195
+ * @param {string} data_store
1196
+ * @param {string} serving_config
1197
+ * @returns {string} Resource name string.
1198
+ */
1199
+ projectLocationCollectionDataStoreServingConfigPath(project, location, collection, dataStore, servingConfig) {
1200
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.render({
1201
+ project: project,
1202
+ location: location,
1203
+ collection: collection,
1204
+ data_store: dataStore,
1205
+ serving_config: servingConfig,
1206
+ });
1207
+ }
1208
+ /**
1209
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
1210
+ *
1211
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1212
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1213
+ * @returns {string} A string representing the project.
1214
+ */
1215
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1216
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).project;
1217
+ }
1218
+ /**
1219
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1220
+ *
1221
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1222
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1223
+ * @returns {string} A string representing the location.
1224
+ */
1225
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1226
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).location;
1227
+ }
1228
+ /**
1229
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1230
+ *
1231
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1232
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1233
+ * @returns {string} A string representing the collection.
1234
+ */
1235
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1236
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).collection;
1237
+ }
1238
+ /**
1239
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1240
+ *
1241
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1242
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1243
+ * @returns {string} A string representing the data_store.
1244
+ */
1245
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1246
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).data_store;
1247
+ }
1248
+ /**
1249
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1250
+ *
1251
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1252
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1253
+ * @returns {string} A string representing the serving_config.
1254
+ */
1255
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1256
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
1257
+ }
1258
+ /**
1259
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1260
+ *
1261
+ * @param {string} project
1262
+ * @param {string} location
1263
+ * @param {string} collection
1264
+ * @param {string} data_store
1265
+ * @returns {string} Resource name string.
1266
+ */
1267
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
1268
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
1269
+ project: project,
1270
+ location: location,
1271
+ collection: collection,
1272
+ data_store: dataStore,
1273
+ });
1274
+ }
1275
+ /**
1276
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1277
+ *
1278
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1279
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1280
+ * @returns {string} A string representing the project.
1281
+ */
1282
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1283
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
1284
+ }
1285
+ /**
1286
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1287
+ *
1288
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1289
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1290
+ * @returns {string} A string representing the location.
1291
+ */
1292
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1293
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
1294
+ }
1295
+ /**
1296
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1297
+ *
1298
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1299
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1300
+ * @returns {string} A string representing the collection.
1301
+ */
1302
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1303
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
1304
+ }
1305
+ /**
1306
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1307
+ *
1308
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1309
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1310
+ * @returns {string} A string representing the data_store.
1311
+ */
1312
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1313
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
1314
+ }
1315
+ /**
1316
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1317
+ *
1318
+ * @param {string} project
1319
+ * @param {string} location
1320
+ * @param {string} collection
1321
+ * @param {string} data_store
1322
+ * @param {string} target_site
1323
+ * @returns {string} Resource name string.
1324
+ */
1325
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
1326
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1327
+ project: project,
1328
+ location: location,
1329
+ collection: collection,
1330
+ data_store: dataStore,
1331
+ target_site: targetSite,
1332
+ });
1333
+ }
1334
+ /**
1335
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1336
+ *
1337
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1338
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1339
+ * @returns {string} A string representing the project.
1340
+ */
1341
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1342
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
1343
+ }
1344
+ /**
1345
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1346
+ *
1347
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1348
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1349
+ * @returns {string} A string representing the location.
1350
+ */
1351
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1352
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
1353
+ }
1354
+ /**
1355
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1356
+ *
1357
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1358
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1359
+ * @returns {string} A string representing the collection.
1360
+ */
1361
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1362
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
1363
+ }
1364
+ /**
1365
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1366
+ *
1367
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1368
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1369
+ * @returns {string} A string representing the data_store.
1370
+ */
1371
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1372
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
1373
+ }
1374
+ /**
1375
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1376
+ *
1377
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1378
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1379
+ * @returns {string} A string representing the target_site.
1380
+ */
1381
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1382
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1383
+ }
1384
+ /**
1385
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1386
+ *
1387
+ * @param {string} project
1388
+ * @param {string} location
1389
+ * @param {string} collection
1390
+ * @param {string} engine
1391
+ * @param {string} conversation
1392
+ * @returns {string} Resource name string.
1393
+ */
1394
+ projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
1395
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
1396
+ project: project,
1397
+ location: location,
1398
+ collection: collection,
1399
+ engine: engine,
1400
+ conversation: conversation,
1401
+ });
1402
+ }
1403
+ /**
1404
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1405
+ *
1406
+ * @param {string} projectLocationCollectionEngineConversationName
1407
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1408
+ * @returns {string} A string representing the project.
1409
+ */
1410
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1411
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
1412
+ }
1413
+ /**
1414
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1415
+ *
1416
+ * @param {string} projectLocationCollectionEngineConversationName
1417
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1418
+ * @returns {string} A string representing the location.
1419
+ */
1420
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1421
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
1422
+ }
1423
+ /**
1424
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1425
+ *
1426
+ * @param {string} projectLocationCollectionEngineConversationName
1427
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1428
+ * @returns {string} A string representing the collection.
1429
+ */
1430
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1431
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
1432
+ }
1433
+ /**
1434
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1435
+ *
1436
+ * @param {string} projectLocationCollectionEngineConversationName
1437
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1438
+ * @returns {string} A string representing the engine.
1439
+ */
1440
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1441
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
1442
+ }
1443
+ /**
1444
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1445
+ *
1446
+ * @param {string} projectLocationCollectionEngineConversationName
1447
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1448
+ * @returns {string} A string representing the conversation.
1449
+ */
1450
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1451
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
1452
+ }
1453
+ /**
1454
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1455
+ *
1456
+ * @param {string} project
1457
+ * @param {string} location
1458
+ * @param {string} collection
1459
+ * @param {string} engine
1460
+ * @param {string} serving_config
1461
+ * @returns {string} Resource name string.
1462
+ */
1463
+ projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig) {
1464
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.render({
1465
+ project: project,
1466
+ location: location,
1467
+ collection: collection,
1468
+ engine: engine,
1469
+ serving_config: servingConfig,
1470
+ });
1471
+ }
1472
+ /**
1473
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1474
+ *
1475
+ * @param {string} projectLocationCollectionEngineServingConfigName
1476
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1477
+ * @returns {string} A string representing the project.
1478
+ */
1479
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1480
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).project;
1481
+ }
1482
+ /**
1483
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1484
+ *
1485
+ * @param {string} projectLocationCollectionEngineServingConfigName
1486
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1487
+ * @returns {string} A string representing the location.
1488
+ */
1489
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1490
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).location;
1491
+ }
1492
+ /**
1493
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1494
+ *
1495
+ * @param {string} projectLocationCollectionEngineServingConfigName
1496
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1497
+ * @returns {string} A string representing the collection.
1498
+ */
1499
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1500
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).collection;
1501
+ }
1502
+ /**
1503
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1504
+ *
1505
+ * @param {string} projectLocationCollectionEngineServingConfigName
1506
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1507
+ * @returns {string} A string representing the engine.
1508
+ */
1509
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1510
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).engine;
1511
+ }
1512
+ /**
1513
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1514
+ *
1515
+ * @param {string} projectLocationCollectionEngineServingConfigName
1516
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1517
+ * @returns {string} A string representing the serving_config.
1518
+ */
1519
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1520
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
1521
+ }
1522
+ /**
1523
+ * Return a fully-qualified projectLocationDataStore resource name string.
1524
+ *
1525
+ * @param {string} project
1526
+ * @param {string} location
1527
+ * @param {string} data_store
1528
+ * @returns {string} Resource name string.
1529
+ */
1530
+ projectLocationDataStorePath(project, location, dataStore) {
1531
+ return this.pathTemplates.projectLocationDataStorePathTemplate.render({
1532
+ project: project,
1533
+ location: location,
1534
+ data_store: dataStore,
1535
+ });
1536
+ }
1537
+ /**
1538
+ * Parse the project from ProjectLocationDataStore resource.
1539
+ *
1540
+ * @param {string} projectLocationDataStoreName
1541
+ * A fully-qualified path representing project_location_data_store resource.
1542
+ * @returns {string} A string representing the project.
1543
+ */
1544
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1545
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
1546
+ }
1547
+ /**
1548
+ * Parse the location from ProjectLocationDataStore resource.
1549
+ *
1550
+ * @param {string} projectLocationDataStoreName
1551
+ * A fully-qualified path representing project_location_data_store resource.
1552
+ * @returns {string} A string representing the location.
1553
+ */
1554
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1555
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
1556
+ }
1557
+ /**
1558
+ * Parse the data_store from ProjectLocationDataStore resource.
1559
+ *
1560
+ * @param {string} projectLocationDataStoreName
1561
+ * A fully-qualified path representing project_location_data_store resource.
1562
+ * @returns {string} A string representing the data_store.
1563
+ */
1564
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1565
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
1566
+ }
1567
+ /**
1568
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
1569
+ *
1570
+ * @param {string} project
1571
+ * @param {string} location
1572
+ * @param {string} data_store
1573
+ * @param {string} branch
1574
+ * @param {string} document
1575
+ * @returns {string} Resource name string.
1576
+ */
1577
+ projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document) {
1578
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.render({
1579
+ project: project,
1580
+ location: location,
1581
+ data_store: dataStore,
1582
+ branch: branch,
1583
+ document: document,
1584
+ });
1585
+ }
1586
+ /**
1587
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
1588
+ *
1589
+ * @param {string} projectLocationDataStoreBranchDocumentName
1590
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1591
+ * @returns {string} A string representing the project.
1592
+ */
1593
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1594
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).project;
1595
+ }
1596
+ /**
1597
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
1598
+ *
1599
+ * @param {string} projectLocationDataStoreBranchDocumentName
1600
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1601
+ * @returns {string} A string representing the location.
1602
+ */
1603
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1604
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).location;
1605
+ }
1606
+ /**
1607
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
1608
+ *
1609
+ * @param {string} projectLocationDataStoreBranchDocumentName
1610
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1611
+ * @returns {string} A string representing the data_store.
1612
+ */
1613
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1614
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).data_store;
1615
+ }
1616
+ /**
1617
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
1618
+ *
1619
+ * @param {string} projectLocationDataStoreBranchDocumentName
1620
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1621
+ * @returns {string} A string representing the branch.
1622
+ */
1623
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1624
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).branch;
1625
+ }
1626
+ /**
1627
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
1628
+ *
1629
+ * @param {string} projectLocationDataStoreBranchDocumentName
1630
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1631
+ * @returns {string} A string representing the document.
1632
+ */
1633
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1634
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
1635
+ }
1636
+ /**
1637
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
1638
+ *
1639
+ * @param {string} project
1640
+ * @param {string} location
1641
+ * @param {string} data_store
1642
+ * @param {string} conversation
1643
+ * @returns {string} Resource name string.
1644
+ */
1645
+ projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
1646
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
1647
+ project: project,
1648
+ location: location,
1649
+ data_store: dataStore,
1650
+ conversation: conversation,
1651
+ });
1652
+ }
1653
+ /**
1654
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1655
+ *
1656
+ * @param {string} projectLocationDataStoreConversationName
1657
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1658
+ * @returns {string} A string representing the project.
1659
+ */
1660
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1661
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
1662
+ }
1663
+ /**
1664
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1665
+ *
1666
+ * @param {string} projectLocationDataStoreConversationName
1667
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1668
+ * @returns {string} A string representing the location.
1669
+ */
1670
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1671
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
1672
+ }
1673
+ /**
1674
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1675
+ *
1676
+ * @param {string} projectLocationDataStoreConversationName
1677
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1678
+ * @returns {string} A string representing the data_store.
1679
+ */
1680
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1681
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
1682
+ }
1683
+ /**
1684
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1685
+ *
1686
+ * @param {string} projectLocationDataStoreConversationName
1687
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1688
+ * @returns {string} A string representing the conversation.
1689
+ */
1690
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1691
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
1692
+ }
1693
+ /**
1694
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1695
+ *
1696
+ * @param {string} project
1697
+ * @param {string} location
1698
+ * @param {string} data_store
1699
+ * @param {string} schema
1700
+ * @returns {string} Resource name string.
1701
+ */
1702
+ projectLocationDataStoreSchemaPath(project, location, dataStore, schema) {
1703
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.render({
1704
+ project: project,
1705
+ location: location,
1706
+ data_store: dataStore,
1707
+ schema: schema,
1708
+ });
1709
+ }
1710
+ /**
1711
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1712
+ *
1713
+ * @param {string} projectLocationDataStoreSchemaName
1714
+ * A fully-qualified path representing project_location_data_store_schema resource.
1715
+ * @returns {string} A string representing the project.
1716
+ */
1717
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1718
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).project;
1719
+ }
1720
+ /**
1721
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1722
+ *
1723
+ * @param {string} projectLocationDataStoreSchemaName
1724
+ * A fully-qualified path representing project_location_data_store_schema resource.
1725
+ * @returns {string} A string representing the location.
1726
+ */
1727
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1728
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).location;
1729
+ }
1730
+ /**
1731
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1732
+ *
1733
+ * @param {string} projectLocationDataStoreSchemaName
1734
+ * A fully-qualified path representing project_location_data_store_schema resource.
1735
+ * @returns {string} A string representing the data_store.
1736
+ */
1737
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1738
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).data_store;
1739
+ }
1740
+ /**
1741
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1742
+ *
1743
+ * @param {string} projectLocationDataStoreSchemaName
1744
+ * A fully-qualified path representing project_location_data_store_schema resource.
1745
+ * @returns {string} A string representing the schema.
1746
+ */
1747
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1748
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
1749
+ }
1750
+ /**
1751
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
1752
+ *
1753
+ * @param {string} project
1754
+ * @param {string} location
1755
+ * @param {string} data_store
1756
+ * @param {string} serving_config
1757
+ * @returns {string} Resource name string.
1758
+ */
1759
+ projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig) {
1760
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.render({
1761
+ project: project,
1762
+ location: location,
1763
+ data_store: dataStore,
1764
+ serving_config: servingConfig,
1765
+ });
1766
+ }
1767
+ /**
1768
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
1769
+ *
1770
+ * @param {string} projectLocationDataStoreServingConfigName
1771
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1772
+ * @returns {string} A string representing the project.
1773
+ */
1774
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1775
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).project;
1776
+ }
1777
+ /**
1778
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
1779
+ *
1780
+ * @param {string} projectLocationDataStoreServingConfigName
1781
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1782
+ * @returns {string} A string representing the location.
1783
+ */
1784
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1785
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).location;
1786
+ }
1787
+ /**
1788
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1789
+ *
1790
+ * @param {string} projectLocationDataStoreServingConfigName
1791
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1792
+ * @returns {string} A string representing the data_store.
1793
+ */
1794
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1795
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).data_store;
1796
+ }
1797
+ /**
1798
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1799
+ *
1800
+ * @param {string} projectLocationDataStoreServingConfigName
1801
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1802
+ * @returns {string} A string representing the serving_config.
1803
+ */
1804
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1805
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
1806
+ }
1807
+ /**
1808
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1809
+ *
1810
+ * @param {string} project
1811
+ * @param {string} location
1812
+ * @param {string} data_store
1813
+ * @returns {string} Resource name string.
1814
+ */
1815
+ projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
1816
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
1817
+ project: project,
1818
+ location: location,
1819
+ data_store: dataStore,
1820
+ });
1821
+ }
1822
+ /**
1823
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1824
+ *
1825
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1826
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1827
+ * @returns {string} A string representing the project.
1828
+ */
1829
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1830
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
1831
+ }
1832
+ /**
1833
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1834
+ *
1835
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1836
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1837
+ * @returns {string} A string representing the location.
1838
+ */
1839
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1840
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
1841
+ }
1842
+ /**
1843
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1844
+ *
1845
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1846
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1847
+ * @returns {string} A string representing the data_store.
1848
+ */
1849
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1850
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
1851
+ }
1852
+ /**
1853
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1854
+ *
1855
+ * @param {string} project
1856
+ * @param {string} location
1857
+ * @param {string} data_store
1858
+ * @param {string} target_site
1859
+ * @returns {string} Resource name string.
1860
+ */
1861
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
1862
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1863
+ project: project,
1864
+ location: location,
1865
+ data_store: dataStore,
1866
+ target_site: targetSite,
1867
+ });
1868
+ }
1869
+ /**
1870
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1871
+ *
1872
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1873
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1874
+ * @returns {string} A string representing the project.
1875
+ */
1876
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1877
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
1878
+ }
1879
+ /**
1880
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1881
+ *
1882
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1883
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1884
+ * @returns {string} A string representing the location.
1885
+ */
1886
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1887
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
1888
+ }
1889
+ /**
1890
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1891
+ *
1892
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1893
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1894
+ * @returns {string} A string representing the data_store.
1895
+ */
1896
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1897
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
1898
+ }
1899
+ /**
1900
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1901
+ *
1902
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1903
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1904
+ * @returns {string} A string representing the target_site.
1905
+ */
1906
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1907
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
1908
+ }
1909
+ /**
1910
+ * Terminate the gRPC channel and close the client.
1911
+ *
1912
+ * The client will no longer be usable and all future behavior is undefined.
1913
+ * @returns {Promise} A promise that resolves when the client is closed.
1914
+ */
1915
+ close() {
1916
+ if (this.engineServiceStub && !this._terminated) {
1917
+ return this.engineServiceStub.then(stub => {
1918
+ this._terminated = true;
1919
+ stub.close();
1920
+ this.locationsClient.close();
1921
+ this.operationsClient.close();
1922
+ });
1923
+ }
1924
+ return Promise.resolve();
1925
+ }
1926
+ }
1927
+ exports.EngineServiceClient = EngineServiceClient;
1928
+ //# sourceMappingURL=engine_service_client.js.map