@google-cloud/discoveryengine 1.1.0 → 1.2.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 (49) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +26 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
  10. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
  11. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
  12. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
  13. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
  18. package/build/protos/protos.d.ts +12587 -7
  19. package/build/protos/protos.js +34918 -3126
  20. package/build/protos/protos.json +3458 -5
  21. package/build/src/index.d.ts +3 -1
  22. package/build/src/index.js +4 -1
  23. package/build/src/v1alpha/completion_service_client.d.ts +603 -0
  24. package/build/src/v1alpha/completion_service_client.js +843 -0
  25. package/build/src/v1alpha/completion_service_client_config.json +43 -0
  26. package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
  27. package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
  28. package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
  29. package/build/src/v1alpha/document_service_client.d.ts +1140 -0
  30. package/build/src/v1alpha/document_service_client.js +1393 -0
  31. package/build/src/v1alpha/document_service_client_config.json +82 -0
  32. package/build/src/v1alpha/index.d.ts +8 -0
  33. package/build/src/v1alpha/index.js +37 -0
  34. package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
  35. package/build/src/v1alpha/recommendation_service_client.js +938 -0
  36. package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
  37. package/build/src/v1alpha/schema_service_client.d.ts +935 -0
  38. package/build/src/v1alpha/schema_service_client.js +1327 -0
  39. package/build/src/v1alpha/schema_service_client_config.json +63 -0
  40. package/build/src/v1alpha/search_service_client.d.ts +1208 -0
  41. package/build/src/v1alpha/search_service_client.js +1432 -0
  42. package/build/src/v1alpha/search_service_client_config.json +43 -0
  43. package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
  44. package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
  45. package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
  46. package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
  47. package/build/src/v1alpha/user_event_service_client.js +1174 -0
  48. package/build/src/v1alpha/user_event_service_client_config.json +67 -0
  49. package/package.json +3 -3
@@ -0,0 +1,843 @@
1
+ "use strict";
2
+ // Copyright 2023 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.CompletionServiceClient = void 0;
21
+ const jsonProtos = require("../../protos/protos.json");
22
+ /**
23
+ * Client JSON configuration object, loaded from
24
+ * `src/v1alpha/completion_service_client_config.json`.
25
+ * This file defines retry strategy and timeouts for all API methods in this library.
26
+ */
27
+ const gapicConfig = require("./completion_service_client_config.json");
28
+ const version = require('../../../package.json').version;
29
+ /**
30
+ * Service for Auto-Completion.
31
+ * @class
32
+ * @memberof v1alpha
33
+ */
34
+ class CompletionServiceClient {
35
+ /**
36
+ * Construct an instance of CompletionServiceClient.
37
+ *
38
+ * @param {object} [options] - The configuration object.
39
+ * The options accepted by the constructor are described in detail
40
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
41
+ * The common options are:
42
+ * @param {object} [options.credentials] - Credentials object.
43
+ * @param {string} [options.credentials.client_email]
44
+ * @param {string} [options.credentials.private_key]
45
+ * @param {string} [options.email] - Account email address. Required when
46
+ * using a .pem or .p12 keyFilename.
47
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
48
+ * .p12 key downloaded from the Google Developers Console. If you provide
49
+ * a path to a JSON file, the projectId option below is not necessary.
50
+ * NOTE: .pem and .p12 require you to specify options.email as well.
51
+ * @param {number} [options.port] - The port on which to connect to
52
+ * the remote host.
53
+ * @param {string} [options.projectId] - The project ID from the Google
54
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
55
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
56
+ * app is running in an environment which supports
57
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
58
+ * your project ID will be detected automatically.
59
+ * @param {string} [options.apiEndpoint] - The domain name of the
60
+ * API remote host.
61
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
62
+ * Follows the structure of {@link gapicConfig}.
63
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
64
+ * For more information, please check the
65
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
66
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
67
+ * need to avoid loading the default gRPC version and want to use the fallback
68
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
69
+ * ```
70
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
71
+ * const client = new CompletionServiceClient({fallback: true}, gax);
72
+ * ```
73
+ */
74
+ constructor(opts, gaxInstance) {
75
+ var _a, _b;
76
+ this._terminated = false;
77
+ this.descriptors = {
78
+ page: {},
79
+ stream: {},
80
+ longrunning: {},
81
+ batching: {},
82
+ };
83
+ // Ensure that options include all the required fields.
84
+ const staticMembers = this.constructor;
85
+ const servicePath = (opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint) || staticMembers.servicePath;
86
+ this._providedCustomServicePath = !!((opts === null || opts === void 0 ? void 0 : opts.servicePath) || (opts === null || opts === void 0 ? void 0 : opts.apiEndpoint));
87
+ const port = (opts === null || opts === void 0 ? void 0 : opts.port) || staticMembers.port;
88
+ const clientConfig = (_a = opts === null || opts === void 0 ? void 0 : opts.clientConfig) !== null && _a !== void 0 ? _a : {};
89
+ const fallback = (_b = opts === null || opts === void 0 ? void 0 : opts.fallback) !== null && _b !== void 0 ? _b : (typeof window !== 'undefined' && typeof (window === null || window === void 0 ? void 0 : window.fetch) === 'function');
90
+ opts = Object.assign({ servicePath, port, clientConfig, fallback }, opts);
91
+ // Request numeric enum values if REST transport is used.
92
+ opts.numericEnums = true;
93
+ // If scopes are unset in options and we're connecting to a non-default endpoint, set scopes just in case.
94
+ if (servicePath !== staticMembers.servicePath && !('scopes' in opts)) {
95
+ opts['scopes'] = staticMembers.scopes;
96
+ }
97
+ // Load google-gax module synchronously if needed
98
+ if (!gaxInstance) {
99
+ gaxInstance = require('google-gax');
100
+ }
101
+ // Choose either gRPC or proto-over-HTTP implementation of google-gax.
102
+ this._gaxModule = opts.fallback ? gaxInstance.fallback : gaxInstance;
103
+ // Create a `gaxGrpc` object, with any grpc-specific options sent to the client.
104
+ this._gaxGrpc = new this._gaxModule.GrpcClient(opts);
105
+ // Save options to use in initialize() method.
106
+ this._opts = opts;
107
+ // Save the auth object to the client, for use by other methods.
108
+ this.auth = this._gaxGrpc.auth;
109
+ // Set useJWTAccessWithScope on the auth object.
110
+ this.auth.useJWTAccessWithScope = true;
111
+ // Set defaultServicePath on the auth object.
112
+ this.auth.defaultServicePath = staticMembers.servicePath;
113
+ // Set the default scopes in auth client if needed.
114
+ if (servicePath === staticMembers.servicePath) {
115
+ this.auth.defaultScopes = staticMembers.scopes;
116
+ }
117
+ this.locationsClient = new this._gaxModule.LocationsClient(this._gaxGrpc, opts);
118
+ // Determine the client header string.
119
+ const clientHeader = [`gax/${this._gaxModule.version}`, `gapic/${version}`];
120
+ if (typeof process !== 'undefined' && 'versions' in process) {
121
+ clientHeader.push(`gl-node/${process.versions.node}`);
122
+ }
123
+ else {
124
+ clientHeader.push(`gl-web/${this._gaxModule.version}`);
125
+ }
126
+ if (!opts.fallback) {
127
+ clientHeader.push(`grpc/${this._gaxGrpc.grpcVersion}`);
128
+ }
129
+ else {
130
+ clientHeader.push(`rest/${this._gaxGrpc.grpcVersion}`);
131
+ }
132
+ if (opts.libName && opts.libVersion) {
133
+ clientHeader.push(`${opts.libName}/${opts.libVersion}`);
134
+ }
135
+ // Load the applicable protos.
136
+ this._protos = this._gaxGrpc.loadProtoJSON(jsonProtos);
137
+ // This API contains "path templates"; forward-slash-separated
138
+ // identifiers to uniquely identify resources within the API.
139
+ // Create useful helper objects for these.
140
+ this.pathTemplates = {
141
+ projectLocationCollectionDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}'),
142
+ projectLocationCollectionDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
143
+ projectLocationCollectionDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/conversations/{conversation}'),
144
+ projectLocationCollectionDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}'),
145
+ projectLocationDataStorePathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}'),
146
+ projectLocationDataStoreBranchDocumentPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document}'),
147
+ projectLocationDataStoreConversationPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/conversations/{conversation}'),
148
+ projectLocationDataStoreSchemaPathTemplate: new this._gaxModule.PathTemplate('projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}'),
149
+ };
150
+ // Put together the default options sent with requests.
151
+ this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1alpha.CompletionService', gapicConfig, opts.clientConfig || {}, { 'x-goog-api-client': clientHeader.join(' ') });
152
+ // Set up a dictionary of "inner API calls"; the core implementation
153
+ // of calling the API is handled in `google-gax`, with this code
154
+ // merely providing the destination and request information.
155
+ this.innerApiCalls = {};
156
+ // Add a warn function to the client constructor so it can be easily tested.
157
+ this.warn = this._gaxModule.warn;
158
+ }
159
+ /**
160
+ * Initialize the client.
161
+ * Performs asynchronous operations (such as authentication) and prepares the client.
162
+ * This function will be called automatically when any class method is called for the
163
+ * first time, but if you need to initialize it before calling an actual method,
164
+ * feel free to call initialize() directly.
165
+ *
166
+ * You can await on this method if you want to make sure the client is initialized.
167
+ *
168
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
169
+ */
170
+ initialize() {
171
+ // If the client stub promise is already initialized, return immediately.
172
+ if (this.completionServiceStub) {
173
+ return this.completionServiceStub;
174
+ }
175
+ // Put together the "service stub" for
176
+ // google.cloud.discoveryengine.v1alpha.CompletionService.
177
+ this.completionServiceStub = this._gaxGrpc.createStub(this._opts.fallback
178
+ ? this._protos.lookupService('google.cloud.discoveryengine.v1alpha.CompletionService')
179
+ : // eslint-disable-next-line @typescript-eslint/no-explicit-any
180
+ this._protos.google.cloud.discoveryengine.v1alpha
181
+ .CompletionService, this._opts, this._providedCustomServicePath);
182
+ // Iterate over each of the methods that the service provides
183
+ // and create an API call method for each.
184
+ const completionServiceStubMethods = ['completeQuery'];
185
+ for (const methodName of completionServiceStubMethods) {
186
+ const callPromise = this.completionServiceStub.then(stub => (...args) => {
187
+ if (this._terminated) {
188
+ return Promise.reject('The client has already been closed.');
189
+ }
190
+ const func = stub[methodName];
191
+ return func.apply(stub, args);
192
+ }, (err) => () => {
193
+ throw err;
194
+ });
195
+ const descriptor = undefined;
196
+ const apiCall = this._gaxModule.createApiCall(callPromise, this._defaults[methodName], descriptor, this._opts.fallback);
197
+ this.innerApiCalls[methodName] = apiCall;
198
+ }
199
+ return this.completionServiceStub;
200
+ }
201
+ /**
202
+ * The DNS address for this API service.
203
+ * @returns {string} The DNS address for this service.
204
+ */
205
+ static get servicePath() {
206
+ return 'discoveryengine.googleapis.com';
207
+ }
208
+ /**
209
+ * The DNS address for this API service - same as servicePath(),
210
+ * exists for compatibility reasons.
211
+ * @returns {string} The DNS address for this service.
212
+ */
213
+ static get apiEndpoint() {
214
+ return 'discoveryengine.googleapis.com';
215
+ }
216
+ /**
217
+ * The port for this API service.
218
+ * @returns {number} The default port for this service.
219
+ */
220
+ static get port() {
221
+ return 443;
222
+ }
223
+ /**
224
+ * The scopes needed to make gRPC calls for every method defined
225
+ * in this service.
226
+ * @returns {string[]} List of default scopes.
227
+ */
228
+ static get scopes() {
229
+ return ['https://www.googleapis.com/auth/cloud-platform'];
230
+ }
231
+ /**
232
+ * Return the project ID used by this class.
233
+ * @returns {Promise} A promise that resolves to string containing the project ID.
234
+ */
235
+ getProjectId(callback) {
236
+ if (callback) {
237
+ this.auth.getProjectId(callback);
238
+ return;
239
+ }
240
+ return this.auth.getProjectId();
241
+ }
242
+ completeQuery(request, optionsOrCallback, callback) {
243
+ var _a;
244
+ request = request || {};
245
+ let options;
246
+ if (typeof optionsOrCallback === 'function' && callback === undefined) {
247
+ callback = optionsOrCallback;
248
+ options = {};
249
+ }
250
+ else {
251
+ options = optionsOrCallback;
252
+ }
253
+ options = options || {};
254
+ options.otherArgs = options.otherArgs || {};
255
+ options.otherArgs.headers = options.otherArgs.headers || {};
256
+ options.otherArgs.headers['x-goog-request-params'] =
257
+ this._gaxModule.routingHeader.fromParams({
258
+ data_store: (_a = request.dataStore) !== null && _a !== void 0 ? _a : '',
259
+ });
260
+ this.initialize();
261
+ return this.innerApiCalls.completeQuery(request, options, callback);
262
+ }
263
+ /**
264
+ * Gets information about a location.
265
+ *
266
+ * @param {Object} request
267
+ * The request object that will be sent.
268
+ * @param {string} request.name
269
+ * Resource name for the location.
270
+ * @param {object} [options]
271
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
272
+ * @returns {Promise} - The promise which resolves to an array.
273
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
274
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
275
+ * for more details and examples.
276
+ * @example
277
+ * ```
278
+ * const [response] = await client.getLocation(request);
279
+ * ```
280
+ */
281
+ getLocation(request, options, callback) {
282
+ return this.locationsClient.getLocation(request, options, callback);
283
+ }
284
+ /**
285
+ * Lists information about the supported locations for this service. Returns an iterable object.
286
+ *
287
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
288
+ * @param {Object} request
289
+ * The request object that will be sent.
290
+ * @param {string} request.name
291
+ * The resource that owns the locations collection, if applicable.
292
+ * @param {string} request.filter
293
+ * The standard list filter.
294
+ * @param {number} request.pageSize
295
+ * The standard list page size.
296
+ * @param {string} request.pageToken
297
+ * The standard list page token.
298
+ * @param {object} [options]
299
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
300
+ * @returns {Object}
301
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
302
+ * When you iterate the returned iterable, each element will be an object representing
303
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
304
+ * so you can stop the iteration when you don't need more results.
305
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
306
+ * for more details and examples.
307
+ * @example
308
+ * ```
309
+ * const iterable = client.listLocationsAsync(request);
310
+ * for await (const response of iterable) {
311
+ * // process response
312
+ * }
313
+ * ```
314
+ */
315
+ listLocationsAsync(request, options) {
316
+ return this.locationsClient.listLocationsAsync(request, options);
317
+ }
318
+ // --------------------
319
+ // -- Path templates --
320
+ // --------------------
321
+ /**
322
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
323
+ *
324
+ * @param {string} project
325
+ * @param {string} location
326
+ * @param {string} collection
327
+ * @param {string} data_store
328
+ * @returns {string} Resource name string.
329
+ */
330
+ projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
331
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
332
+ project: project,
333
+ location: location,
334
+ collection: collection,
335
+ data_store: dataStore,
336
+ });
337
+ }
338
+ /**
339
+ * Parse the project from ProjectLocationCollectionDataStore resource.
340
+ *
341
+ * @param {string} projectLocationCollectionDataStoreName
342
+ * A fully-qualified path representing project_location_collection_data_store resource.
343
+ * @returns {string} A string representing the project.
344
+ */
345
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
346
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
347
+ }
348
+ /**
349
+ * Parse the location from ProjectLocationCollectionDataStore resource.
350
+ *
351
+ * @param {string} projectLocationCollectionDataStoreName
352
+ * A fully-qualified path representing project_location_collection_data_store resource.
353
+ * @returns {string} A string representing the location.
354
+ */
355
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
356
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
357
+ }
358
+ /**
359
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
360
+ *
361
+ * @param {string} projectLocationCollectionDataStoreName
362
+ * A fully-qualified path representing project_location_collection_data_store resource.
363
+ * @returns {string} A string representing the collection.
364
+ */
365
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
366
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
367
+ }
368
+ /**
369
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
370
+ *
371
+ * @param {string} projectLocationCollectionDataStoreName
372
+ * A fully-qualified path representing project_location_collection_data_store resource.
373
+ * @returns {string} A string representing the data_store.
374
+ */
375
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
376
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
377
+ }
378
+ /**
379
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
380
+ *
381
+ * @param {string} project
382
+ * @param {string} location
383
+ * @param {string} collection
384
+ * @param {string} data_store
385
+ * @param {string} branch
386
+ * @param {string} document
387
+ * @returns {string} Resource name string.
388
+ */
389
+ projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document) {
390
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.render({
391
+ project: project,
392
+ location: location,
393
+ collection: collection,
394
+ data_store: dataStore,
395
+ branch: branch,
396
+ document: document,
397
+ });
398
+ }
399
+ /**
400
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
401
+ *
402
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
403
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
404
+ * @returns {string} A string representing the project.
405
+ */
406
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
407
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).project;
408
+ }
409
+ /**
410
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
411
+ *
412
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
413
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
414
+ * @returns {string} A string representing the location.
415
+ */
416
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
417
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).location;
418
+ }
419
+ /**
420
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
421
+ *
422
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
423
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
424
+ * @returns {string} A string representing the collection.
425
+ */
426
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
427
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).collection;
428
+ }
429
+ /**
430
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
431
+ *
432
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
433
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
434
+ * @returns {string} A string representing the data_store.
435
+ */
436
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
437
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).data_store;
438
+ }
439
+ /**
440
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
441
+ *
442
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
443
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
444
+ * @returns {string} A string representing the branch.
445
+ */
446
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
447
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).branch;
448
+ }
449
+ /**
450
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
451
+ *
452
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
453
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
454
+ * @returns {string} A string representing the document.
455
+ */
456
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
457
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
458
+ }
459
+ /**
460
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
461
+ *
462
+ * @param {string} project
463
+ * @param {string} location
464
+ * @param {string} collection
465
+ * @param {string} data_store
466
+ * @param {string} conversation
467
+ * @returns {string} Resource name string.
468
+ */
469
+ projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
470
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
471
+ project: project,
472
+ location: location,
473
+ collection: collection,
474
+ data_store: dataStore,
475
+ conversation: conversation,
476
+ });
477
+ }
478
+ /**
479
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
480
+ *
481
+ * @param {string} projectLocationCollectionDataStoreConversationName
482
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
483
+ * @returns {string} A string representing the project.
484
+ */
485
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
486
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
487
+ }
488
+ /**
489
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
490
+ *
491
+ * @param {string} projectLocationCollectionDataStoreConversationName
492
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
493
+ * @returns {string} A string representing the location.
494
+ */
495
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
496
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
497
+ }
498
+ /**
499
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
500
+ *
501
+ * @param {string} projectLocationCollectionDataStoreConversationName
502
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
503
+ * @returns {string} A string representing the collection.
504
+ */
505
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
506
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
507
+ }
508
+ /**
509
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
510
+ *
511
+ * @param {string} projectLocationCollectionDataStoreConversationName
512
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
513
+ * @returns {string} A string representing the data_store.
514
+ */
515
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
516
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
517
+ }
518
+ /**
519
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
520
+ *
521
+ * @param {string} projectLocationCollectionDataStoreConversationName
522
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
523
+ * @returns {string} A string representing the conversation.
524
+ */
525
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
526
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
527
+ }
528
+ /**
529
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
530
+ *
531
+ * @param {string} project
532
+ * @param {string} location
533
+ * @param {string} collection
534
+ * @param {string} data_store
535
+ * @param {string} schema
536
+ * @returns {string} Resource name string.
537
+ */
538
+ projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema) {
539
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.render({
540
+ project: project,
541
+ location: location,
542
+ collection: collection,
543
+ data_store: dataStore,
544
+ schema: schema,
545
+ });
546
+ }
547
+ /**
548
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
549
+ *
550
+ * @param {string} projectLocationCollectionDataStoreSchemaName
551
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
552
+ * @returns {string} A string representing the project.
553
+ */
554
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
555
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).project;
556
+ }
557
+ /**
558
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
559
+ *
560
+ * @param {string} projectLocationCollectionDataStoreSchemaName
561
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
562
+ * @returns {string} A string representing the location.
563
+ */
564
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
565
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).location;
566
+ }
567
+ /**
568
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
569
+ *
570
+ * @param {string} projectLocationCollectionDataStoreSchemaName
571
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
572
+ * @returns {string} A string representing the collection.
573
+ */
574
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
575
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).collection;
576
+ }
577
+ /**
578
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
579
+ *
580
+ * @param {string} projectLocationCollectionDataStoreSchemaName
581
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
582
+ * @returns {string} A string representing the data_store.
583
+ */
584
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
585
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).data_store;
586
+ }
587
+ /**
588
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
589
+ *
590
+ * @param {string} projectLocationCollectionDataStoreSchemaName
591
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
592
+ * @returns {string} A string representing the schema.
593
+ */
594
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
595
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
596
+ }
597
+ /**
598
+ * Return a fully-qualified projectLocationDataStore resource name string.
599
+ *
600
+ * @param {string} project
601
+ * @param {string} location
602
+ * @param {string} data_store
603
+ * @returns {string} Resource name string.
604
+ */
605
+ projectLocationDataStorePath(project, location, dataStore) {
606
+ return this.pathTemplates.projectLocationDataStorePathTemplate.render({
607
+ project: project,
608
+ location: location,
609
+ data_store: dataStore,
610
+ });
611
+ }
612
+ /**
613
+ * Parse the project from ProjectLocationDataStore resource.
614
+ *
615
+ * @param {string} projectLocationDataStoreName
616
+ * A fully-qualified path representing project_location_data_store resource.
617
+ * @returns {string} A string representing the project.
618
+ */
619
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
620
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
621
+ }
622
+ /**
623
+ * Parse the location from ProjectLocationDataStore resource.
624
+ *
625
+ * @param {string} projectLocationDataStoreName
626
+ * A fully-qualified path representing project_location_data_store resource.
627
+ * @returns {string} A string representing the location.
628
+ */
629
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
630
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
631
+ }
632
+ /**
633
+ * Parse the data_store from ProjectLocationDataStore resource.
634
+ *
635
+ * @param {string} projectLocationDataStoreName
636
+ * A fully-qualified path representing project_location_data_store resource.
637
+ * @returns {string} A string representing the data_store.
638
+ */
639
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
640
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
641
+ }
642
+ /**
643
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
644
+ *
645
+ * @param {string} project
646
+ * @param {string} location
647
+ * @param {string} data_store
648
+ * @param {string} branch
649
+ * @param {string} document
650
+ * @returns {string} Resource name string.
651
+ */
652
+ projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document) {
653
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.render({
654
+ project: project,
655
+ location: location,
656
+ data_store: dataStore,
657
+ branch: branch,
658
+ document: document,
659
+ });
660
+ }
661
+ /**
662
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
663
+ *
664
+ * @param {string} projectLocationDataStoreBranchDocumentName
665
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
666
+ * @returns {string} A string representing the project.
667
+ */
668
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
669
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).project;
670
+ }
671
+ /**
672
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
673
+ *
674
+ * @param {string} projectLocationDataStoreBranchDocumentName
675
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
676
+ * @returns {string} A string representing the location.
677
+ */
678
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
679
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).location;
680
+ }
681
+ /**
682
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
683
+ *
684
+ * @param {string} projectLocationDataStoreBranchDocumentName
685
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
686
+ * @returns {string} A string representing the data_store.
687
+ */
688
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
689
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).data_store;
690
+ }
691
+ /**
692
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
693
+ *
694
+ * @param {string} projectLocationDataStoreBranchDocumentName
695
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
696
+ * @returns {string} A string representing the branch.
697
+ */
698
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
699
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).branch;
700
+ }
701
+ /**
702
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
703
+ *
704
+ * @param {string} projectLocationDataStoreBranchDocumentName
705
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
706
+ * @returns {string} A string representing the document.
707
+ */
708
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
709
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
710
+ }
711
+ /**
712
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
713
+ *
714
+ * @param {string} project
715
+ * @param {string} location
716
+ * @param {string} data_store
717
+ * @param {string} conversation
718
+ * @returns {string} Resource name string.
719
+ */
720
+ projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
721
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
722
+ project: project,
723
+ location: location,
724
+ data_store: dataStore,
725
+ conversation: conversation,
726
+ });
727
+ }
728
+ /**
729
+ * Parse the project from ProjectLocationDataStoreConversation resource.
730
+ *
731
+ * @param {string} projectLocationDataStoreConversationName
732
+ * A fully-qualified path representing project_location_data_store_conversation resource.
733
+ * @returns {string} A string representing the project.
734
+ */
735
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
736
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
737
+ }
738
+ /**
739
+ * Parse the location from ProjectLocationDataStoreConversation resource.
740
+ *
741
+ * @param {string} projectLocationDataStoreConversationName
742
+ * A fully-qualified path representing project_location_data_store_conversation resource.
743
+ * @returns {string} A string representing the location.
744
+ */
745
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
746
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
747
+ }
748
+ /**
749
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
750
+ *
751
+ * @param {string} projectLocationDataStoreConversationName
752
+ * A fully-qualified path representing project_location_data_store_conversation resource.
753
+ * @returns {string} A string representing the data_store.
754
+ */
755
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
756
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
757
+ }
758
+ /**
759
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
760
+ *
761
+ * @param {string} projectLocationDataStoreConversationName
762
+ * A fully-qualified path representing project_location_data_store_conversation resource.
763
+ * @returns {string} A string representing the conversation.
764
+ */
765
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
766
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
767
+ }
768
+ /**
769
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
770
+ *
771
+ * @param {string} project
772
+ * @param {string} location
773
+ * @param {string} data_store
774
+ * @param {string} schema
775
+ * @returns {string} Resource name string.
776
+ */
777
+ projectLocationDataStoreSchemaPath(project, location, dataStore, schema) {
778
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.render({
779
+ project: project,
780
+ location: location,
781
+ data_store: dataStore,
782
+ schema: schema,
783
+ });
784
+ }
785
+ /**
786
+ * Parse the project from ProjectLocationDataStoreSchema resource.
787
+ *
788
+ * @param {string} projectLocationDataStoreSchemaName
789
+ * A fully-qualified path representing project_location_data_store_schema resource.
790
+ * @returns {string} A string representing the project.
791
+ */
792
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
793
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).project;
794
+ }
795
+ /**
796
+ * Parse the location from ProjectLocationDataStoreSchema resource.
797
+ *
798
+ * @param {string} projectLocationDataStoreSchemaName
799
+ * A fully-qualified path representing project_location_data_store_schema resource.
800
+ * @returns {string} A string representing the location.
801
+ */
802
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
803
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).location;
804
+ }
805
+ /**
806
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
807
+ *
808
+ * @param {string} projectLocationDataStoreSchemaName
809
+ * A fully-qualified path representing project_location_data_store_schema resource.
810
+ * @returns {string} A string representing the data_store.
811
+ */
812
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
813
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).data_store;
814
+ }
815
+ /**
816
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
817
+ *
818
+ * @param {string} projectLocationDataStoreSchemaName
819
+ * A fully-qualified path representing project_location_data_store_schema resource.
820
+ * @returns {string} A string representing the schema.
821
+ */
822
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
823
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
824
+ }
825
+ /**
826
+ * Terminate the gRPC channel and close the client.
827
+ *
828
+ * The client will no longer be usable and all future behavior is undefined.
829
+ * @returns {Promise} A promise that resolves when the client is closed.
830
+ */
831
+ close() {
832
+ if (this.completionServiceStub && !this._terminated) {
833
+ return this.completionServiceStub.then(stub => {
834
+ this._terminated = true;
835
+ stub.close();
836
+ this.locationsClient.close();
837
+ });
838
+ }
839
+ return Promise.resolve();
840
+ }
841
+ }
842
+ exports.CompletionServiceClient = CompletionServiceClient;
843
+ //# sourceMappingURL=completion_service_client.js.map