@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,1966 @@
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.DataStoreServiceClient = void 0;
21
+ const jsonProtos = require("../../protos/protos.json");
22
+ /**
23
+ * Client JSON configuration object, loaded from
24
+ * `src/v1beta/data_store_service_client_config.json`.
25
+ * This file defines retry strategy and timeouts for all API methods in this library.
26
+ */
27
+ const gapicConfig = require("./data_store_service_client_config.json");
28
+ const version = require('../../../package.json').version;
29
+ /**
30
+ * Service for managing
31
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} configuration.
32
+ * @class
33
+ * @memberof v1beta
34
+ */
35
+ class DataStoreServiceClient {
36
+ /**
37
+ * Construct an instance of DataStoreServiceClient.
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 DataStoreServiceClient({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
+ listDataStores: new this._gaxModule.PageDescriptor('pageToken', 'nextPageToken', 'dataStores'),
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 createDataStoreResponse = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.DataStore');
274
+ const createDataStoreMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.CreateDataStoreMetadata');
275
+ const deleteDataStoreResponse = protoFilesRoot.lookup('.google.protobuf.Empty');
276
+ const deleteDataStoreMetadata = protoFilesRoot.lookup('.google.cloud.discoveryengine.v1beta.DeleteDataStoreMetadata');
277
+ this.descriptors.longrunning = {
278
+ createDataStore: new this._gaxModule.LongrunningDescriptor(this.operationsClient, createDataStoreResponse.decode.bind(createDataStoreResponse), createDataStoreMetadata.decode.bind(createDataStoreMetadata)),
279
+ deleteDataStore: new this._gaxModule.LongrunningDescriptor(this.operationsClient, deleteDataStoreResponse.decode.bind(deleteDataStoreResponse), deleteDataStoreMetadata.decode.bind(deleteDataStoreMetadata)),
280
+ };
281
+ // Put together the default options sent with requests.
282
+ this._defaults = this._gaxGrpc.constructSettings('google.cloud.discoveryengine.v1beta.DataStoreService', 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.dataStoreServiceStub) {
304
+ return this.dataStoreServiceStub;
305
+ }
306
+ // Put together the "service stub" for
307
+ // google.cloud.discoveryengine.v1beta.DataStoreService.
308
+ this.dataStoreServiceStub = this._gaxGrpc.createStub(this._opts.fallback
309
+ ? this._protos.lookupService('google.cloud.discoveryengine.v1beta.DataStoreService')
310
+ : // eslint-disable-next-line @typescript-eslint/no-explicit-any
311
+ this._protos.google.cloud.discoveryengine.v1beta
312
+ .DataStoreService, 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 dataStoreServiceStubMethods = [
316
+ 'createDataStore',
317
+ 'getDataStore',
318
+ 'listDataStores',
319
+ 'deleteDataStore',
320
+ 'updateDataStore',
321
+ ];
322
+ for (const methodName of dataStoreServiceStubMethods) {
323
+ const callPromise = this.dataStoreServiceStub.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.dataStoreServiceStub;
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
+ getDataStore(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
+ name: (_a = request.name) !== null && _a !== void 0 ? _a : '',
417
+ });
418
+ this.initialize();
419
+ return this.innerApiCalls.getDataStore(request, options, callback);
420
+ }
421
+ updateDataStore(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
+ 'data_store.name': (_a = request.dataStore.name) !== null && _a !== void 0 ? _a : '',
438
+ });
439
+ this.initialize();
440
+ return this.innerApiCalls.updateDataStore(request, options, callback);
441
+ }
442
+ createDataStore(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.createDataStore(request, options, callback);
462
+ }
463
+ /**
464
+ * Check the status of the long running operation returned by `createDataStore()`.
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/data_store_service.create_data_store.js</caption>
472
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_CreateDataStore_async
473
+ */
474
+ async checkCreateDataStoreProgress(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.createDataStore, this._gaxModule.createDefaultBackoffSettings());
478
+ return decodeOperation;
479
+ }
480
+ deleteDataStore(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.deleteDataStore(request, options, callback);
500
+ }
501
+ /**
502
+ * Check the status of the long running operation returned by `deleteDataStore()`.
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/data_store_service.delete_data_store.js</caption>
510
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_DeleteDataStore_async
511
+ */
512
+ async checkDeleteDataStoreProgress(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.deleteDataStore, this._gaxModule.createDefaultBackoffSettings());
516
+ return decodeOperation;
517
+ }
518
+ listDataStores(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.listDataStores(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 branch resource name, such as
545
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
546
+ *
547
+ * If the caller does not have permission to list
548
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
549
+ * location, regardless of whether or not this data store exists, a
550
+ * PERMISSION_DENIED error is returned.
551
+ * @param {number} request.pageSize
552
+ * Maximum number of
553
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
554
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
555
+ * 50 will be coerced to 50.
556
+ *
557
+ * If this field is negative, an INVALID_ARGUMENT is returned.
558
+ * @param {string} request.pageToken
559
+ * A page token
560
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
561
+ * received from a previous
562
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
563
+ * call. Provide this to retrieve the subsequent page.
564
+ *
565
+ * When paginating, all other parameters provided to
566
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
567
+ * must match the call that provided the page token. Otherwise, an
568
+ * INVALID_ARGUMENT error is returned.
569
+ * @param {string} request.filter
570
+ * Filter by solution type. For example: filter =
571
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
572
+ * @param {object} [options]
573
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
574
+ * @returns {Stream}
575
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore} on 'data' event.
576
+ * The client library will perform auto-pagination by default: it will call the API as many
577
+ * times as needed. Note that it can affect your quota.
578
+ * We recommend using `listDataStoresAsync()`
579
+ * method described below for async iteration which you can stop as needed.
580
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
581
+ * for more details and examples.
582
+ */
583
+ listDataStoresStream(request, options) {
584
+ var _a;
585
+ request = request || {};
586
+ options = options || {};
587
+ options.otherArgs = options.otherArgs || {};
588
+ options.otherArgs.headers = options.otherArgs.headers || {};
589
+ options.otherArgs.headers['x-goog-request-params'] =
590
+ this._gaxModule.routingHeader.fromParams({
591
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
592
+ });
593
+ const defaultCallSettings = this._defaults['listDataStores'];
594
+ const callSettings = defaultCallSettings.merge(options);
595
+ this.initialize();
596
+ return this.descriptors.page.listDataStores.createStream(this.innerApiCalls.listDataStores, request, callSettings);
597
+ }
598
+ /**
599
+ * Equivalent to `listDataStores`, but returns an iterable object.
600
+ *
601
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
602
+ * @param {Object} request
603
+ * The request object that will be sent.
604
+ * @param {string} request.parent
605
+ * Required. The parent branch resource name, such as
606
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
607
+ *
608
+ * If the caller does not have permission to list
609
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s under this
610
+ * location, regardless of whether or not this data store exists, a
611
+ * PERMISSION_DENIED error is returned.
612
+ * @param {number} request.pageSize
613
+ * Maximum number of
614
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}s to return. If
615
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
616
+ * 50 will be coerced to 50.
617
+ *
618
+ * If this field is negative, an INVALID_ARGUMENT is returned.
619
+ * @param {string} request.pageToken
620
+ * A page token
621
+ * {@link protos.google.cloud.discoveryengine.v1beta.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
622
+ * received from a previous
623
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
624
+ * call. Provide this to retrieve the subsequent page.
625
+ *
626
+ * When paginating, all other parameters provided to
627
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
628
+ * must match the call that provided the page token. Otherwise, an
629
+ * INVALID_ARGUMENT error is returned.
630
+ * @param {string} request.filter
631
+ * Filter by solution type. For example: filter =
632
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
633
+ * @param {object} [options]
634
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
635
+ * @returns {Object}
636
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
637
+ * When you iterate the returned iterable, each element will be an object representing
638
+ * {@link protos.google.cloud.discoveryengine.v1beta.DataStore|DataStore}. The API will be called under the hood as needed, once per the page,
639
+ * so you can stop the iteration when you don't need more results.
640
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
641
+ * for more details and examples.
642
+ * @example <caption>include:samples/generated/v1beta/data_store_service.list_data_stores.js</caption>
643
+ * region_tag:discoveryengine_v1beta_generated_DataStoreService_ListDataStores_async
644
+ */
645
+ listDataStoresAsync(request, options) {
646
+ var _a;
647
+ request = request || {};
648
+ options = options || {};
649
+ options.otherArgs = options.otherArgs || {};
650
+ options.otherArgs.headers = options.otherArgs.headers || {};
651
+ options.otherArgs.headers['x-goog-request-params'] =
652
+ this._gaxModule.routingHeader.fromParams({
653
+ parent: (_a = request.parent) !== null && _a !== void 0 ? _a : '',
654
+ });
655
+ const defaultCallSettings = this._defaults['listDataStores'];
656
+ const callSettings = defaultCallSettings.merge(options);
657
+ this.initialize();
658
+ return this.descriptors.page.listDataStores.asyncIterate(this.innerApiCalls['listDataStores'], request, callSettings);
659
+ }
660
+ /**
661
+ * Gets information about a location.
662
+ *
663
+ * @param {Object} request
664
+ * The request object that will be sent.
665
+ * @param {string} request.name
666
+ * Resource name for the location.
667
+ * @param {object} [options]
668
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
669
+ * @returns {Promise} - The promise which resolves to an array.
670
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
671
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
672
+ * for more details and examples.
673
+ * @example
674
+ * ```
675
+ * const [response] = await client.getLocation(request);
676
+ * ```
677
+ */
678
+ getLocation(request, options, callback) {
679
+ return this.locationsClient.getLocation(request, options, callback);
680
+ }
681
+ /**
682
+ * Lists information about the supported locations for this service. Returns an iterable object.
683
+ *
684
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
685
+ * @param {Object} request
686
+ * The request object that will be sent.
687
+ * @param {string} request.name
688
+ * The resource that owns the locations collection, if applicable.
689
+ * @param {string} request.filter
690
+ * The standard list filter.
691
+ * @param {number} request.pageSize
692
+ * The standard list page size.
693
+ * @param {string} request.pageToken
694
+ * The standard list page token.
695
+ * @param {object} [options]
696
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
697
+ * @returns {Object}
698
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
699
+ * When you iterate the returned iterable, each element will be an object representing
700
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
701
+ * so you can stop the iteration when you don't need more results.
702
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
703
+ * for more details and examples.
704
+ * @example
705
+ * ```
706
+ * const iterable = client.listLocationsAsync(request);
707
+ * for await (const response of iterable) {
708
+ * // process response
709
+ * }
710
+ * ```
711
+ */
712
+ listLocationsAsync(request, options) {
713
+ return this.locationsClient.listLocationsAsync(request, options);
714
+ }
715
+ /**
716
+ * Gets the latest state of a long-running operation. Clients can use this
717
+ * method to poll the operation result at intervals as recommended by the API
718
+ * service.
719
+ *
720
+ * @param {Object} request - The request object that will be sent.
721
+ * @param {string} request.name - The name of the operation resource.
722
+ * @param {Object=} options
723
+ * Optional parameters. You can override the default settings for this call,
724
+ * e.g, timeout, retries, paginations, etc. See {@link
725
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
726
+ * for the details.
727
+ * @param {function(?Error, ?Object)=} callback
728
+ * The function which will be called with the result of the API call.
729
+ *
730
+ * The second parameter to the callback is an object representing
731
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
732
+ * @return {Promise} - The promise which resolves to an array.
733
+ * The first element of the array is an object representing
734
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
735
+ * The promise has a method named "cancel" which cancels the ongoing API call.
736
+ *
737
+ * @example
738
+ * ```
739
+ * const client = longrunning.operationsClient();
740
+ * const name = '';
741
+ * const [response] = await client.getOperation({name});
742
+ * // doThingsWith(response)
743
+ * ```
744
+ */
745
+ getOperation(request, options, callback) {
746
+ return this.operationsClient.getOperation(request, options, callback);
747
+ }
748
+ /**
749
+ * Lists operations that match the specified filter in the request. If the
750
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
751
+ *
752
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
753
+ *
754
+ * @param {Object} request - The request object that will be sent.
755
+ * @param {string} request.name - The name of the operation collection.
756
+ * @param {string} request.filter - The standard list filter.
757
+ * @param {number=} request.pageSize -
758
+ * The maximum number of resources contained in the underlying API
759
+ * response. If page streaming is performed per-resource, this
760
+ * parameter does not affect the return value. If page streaming is
761
+ * performed per-page, this determines the maximum number of
762
+ * resources in a page.
763
+ * @param {Object=} options
764
+ * Optional parameters. You can override the default settings for this call,
765
+ * e.g, timeout, retries, paginations, etc. See {@link
766
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
767
+ * details.
768
+ * @returns {Object}
769
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
770
+ *
771
+ * @example
772
+ * ```
773
+ * const client = longrunning.operationsClient();
774
+ * for await (const response of client.listOperationsAsync(request));
775
+ * // doThingsWith(response)
776
+ * ```
777
+ */
778
+ listOperationsAsync(request, options) {
779
+ return this.operationsClient.listOperationsAsync(request, options);
780
+ }
781
+ /**
782
+ * Starts asynchronous cancellation on a long-running operation. The server
783
+ * makes a best effort to cancel the operation, but success is not
784
+ * guaranteed. If the server doesn't support this method, it returns
785
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
786
+ * {@link Operations.GetOperation} or
787
+ * other methods to check whether the cancellation succeeded or whether the
788
+ * operation completed despite cancellation. On successful cancellation,
789
+ * the operation is not deleted; instead, it becomes an operation with
790
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
791
+ * 1, corresponding to `Code.CANCELLED`.
792
+ *
793
+ * @param {Object} request - The request object that will be sent.
794
+ * @param {string} request.name - The name of the operation resource to be cancelled.
795
+ * @param {Object=} options
796
+ * Optional parameters. You can override the default settings for this call,
797
+ * e.g, timeout, retries, paginations, etc. See {@link
798
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
799
+ * details.
800
+ * @param {function(?Error)=} callback
801
+ * The function which will be called with the result of the API call.
802
+ * @return {Promise} - The promise which resolves when API call finishes.
803
+ * The promise has a method named "cancel" which cancels the ongoing API
804
+ * call.
805
+ *
806
+ * @example
807
+ * ```
808
+ * const client = longrunning.operationsClient();
809
+ * await client.cancelOperation({name: ''});
810
+ * ```
811
+ */
812
+ cancelOperation(request, options, callback) {
813
+ return this.operationsClient.cancelOperation(request, options, callback);
814
+ }
815
+ /**
816
+ * Deletes a long-running operation. This method indicates that the client is
817
+ * no longer interested in the operation result. It does not cancel the
818
+ * operation. If the server doesn't support this method, it returns
819
+ * `google.rpc.Code.UNIMPLEMENTED`.
820
+ *
821
+ * @param {Object} request - The request object that will be sent.
822
+ * @param {string} request.name - The name of the operation resource to be deleted.
823
+ * @param {Object=} options
824
+ * Optional parameters. You can override the default settings for this call,
825
+ * e.g, timeout, retries, paginations, etc. See {@link
826
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
827
+ * for the details.
828
+ * @param {function(?Error)=} callback
829
+ * The function which will be called with the result of the API call.
830
+ * @return {Promise} - The promise which resolves when API call finishes.
831
+ * The promise has a method named "cancel" which cancels the ongoing API
832
+ * call.
833
+ *
834
+ * @example
835
+ * ```
836
+ * const client = longrunning.operationsClient();
837
+ * await client.deleteOperation({name: ''});
838
+ * ```
839
+ */
840
+ deleteOperation(request, options, callback) {
841
+ return this.operationsClient.deleteOperation(request, options, callback);
842
+ }
843
+ // --------------------
844
+ // -- Path templates --
845
+ // --------------------
846
+ /**
847
+ * Return a fully-qualified collection resource name string.
848
+ *
849
+ * @param {string} project
850
+ * @param {string} location
851
+ * @param {string} collection
852
+ * @returns {string} Resource name string.
853
+ */
854
+ collectionPath(project, location, collection) {
855
+ return this.pathTemplates.collectionPathTemplate.render({
856
+ project: project,
857
+ location: location,
858
+ collection: collection,
859
+ });
860
+ }
861
+ /**
862
+ * Parse the project from Collection resource.
863
+ *
864
+ * @param {string} collectionName
865
+ * A fully-qualified path representing Collection resource.
866
+ * @returns {string} A string representing the project.
867
+ */
868
+ matchProjectFromCollectionName(collectionName) {
869
+ return this.pathTemplates.collectionPathTemplate.match(collectionName)
870
+ .project;
871
+ }
872
+ /**
873
+ * Parse the location from Collection resource.
874
+ *
875
+ * @param {string} collectionName
876
+ * A fully-qualified path representing Collection resource.
877
+ * @returns {string} A string representing the location.
878
+ */
879
+ matchLocationFromCollectionName(collectionName) {
880
+ return this.pathTemplates.collectionPathTemplate.match(collectionName)
881
+ .location;
882
+ }
883
+ /**
884
+ * Parse the collection from Collection resource.
885
+ *
886
+ * @param {string} collectionName
887
+ * A fully-qualified path representing Collection resource.
888
+ * @returns {string} A string representing the collection.
889
+ */
890
+ matchCollectionFromCollectionName(collectionName) {
891
+ return this.pathTemplates.collectionPathTemplate.match(collectionName)
892
+ .collection;
893
+ }
894
+ /**
895
+ * Return a fully-qualified engine resource name string.
896
+ *
897
+ * @param {string} project
898
+ * @param {string} location
899
+ * @param {string} collection
900
+ * @param {string} engine
901
+ * @returns {string} Resource name string.
902
+ */
903
+ enginePath(project, location, collection, engine) {
904
+ return this.pathTemplates.enginePathTemplate.render({
905
+ project: project,
906
+ location: location,
907
+ collection: collection,
908
+ engine: engine,
909
+ });
910
+ }
911
+ /**
912
+ * Parse the project from Engine resource.
913
+ *
914
+ * @param {string} engineName
915
+ * A fully-qualified path representing Engine resource.
916
+ * @returns {string} A string representing the project.
917
+ */
918
+ matchProjectFromEngineName(engineName) {
919
+ return this.pathTemplates.enginePathTemplate.match(engineName).project;
920
+ }
921
+ /**
922
+ * Parse the location from Engine resource.
923
+ *
924
+ * @param {string} engineName
925
+ * A fully-qualified path representing Engine resource.
926
+ * @returns {string} A string representing the location.
927
+ */
928
+ matchLocationFromEngineName(engineName) {
929
+ return this.pathTemplates.enginePathTemplate.match(engineName).location;
930
+ }
931
+ /**
932
+ * Parse the collection from Engine resource.
933
+ *
934
+ * @param {string} engineName
935
+ * A fully-qualified path representing Engine resource.
936
+ * @returns {string} A string representing the collection.
937
+ */
938
+ matchCollectionFromEngineName(engineName) {
939
+ return this.pathTemplates.enginePathTemplate.match(engineName).collection;
940
+ }
941
+ /**
942
+ * Parse the engine from Engine resource.
943
+ *
944
+ * @param {string} engineName
945
+ * A fully-qualified path representing Engine resource.
946
+ * @returns {string} A string representing the engine.
947
+ */
948
+ matchEngineFromEngineName(engineName) {
949
+ return this.pathTemplates.enginePathTemplate.match(engineName).engine;
950
+ }
951
+ /**
952
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
953
+ *
954
+ * @param {string} project
955
+ * @param {string} location
956
+ * @param {string} collection
957
+ * @param {string} data_store
958
+ * @returns {string} Resource name string.
959
+ */
960
+ projectLocationCollectionDataStorePath(project, location, collection, dataStore) {
961
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.render({
962
+ project: project,
963
+ location: location,
964
+ collection: collection,
965
+ data_store: dataStore,
966
+ });
967
+ }
968
+ /**
969
+ * Parse the project from ProjectLocationCollectionDataStore resource.
970
+ *
971
+ * @param {string} projectLocationCollectionDataStoreName
972
+ * A fully-qualified path representing project_location_collection_data_store resource.
973
+ * @returns {string} A string representing the project.
974
+ */
975
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
976
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).project;
977
+ }
978
+ /**
979
+ * Parse the location from ProjectLocationCollectionDataStore resource.
980
+ *
981
+ * @param {string} projectLocationCollectionDataStoreName
982
+ * A fully-qualified path representing project_location_collection_data_store resource.
983
+ * @returns {string} A string representing the location.
984
+ */
985
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
986
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).location;
987
+ }
988
+ /**
989
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
990
+ *
991
+ * @param {string} projectLocationCollectionDataStoreName
992
+ * A fully-qualified path representing project_location_collection_data_store resource.
993
+ * @returns {string} A string representing the collection.
994
+ */
995
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
996
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).collection;
997
+ }
998
+ /**
999
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
1000
+ *
1001
+ * @param {string} projectLocationCollectionDataStoreName
1002
+ * A fully-qualified path representing project_location_collection_data_store resource.
1003
+ * @returns {string} A string representing the data_store.
1004
+ */
1005
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName) {
1006
+ return this.pathTemplates.projectLocationCollectionDataStorePathTemplate.match(projectLocationCollectionDataStoreName).data_store;
1007
+ }
1008
+ /**
1009
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
1010
+ *
1011
+ * @param {string} project
1012
+ * @param {string} location
1013
+ * @param {string} collection
1014
+ * @param {string} data_store
1015
+ * @param {string} branch
1016
+ * @param {string} document
1017
+ * @returns {string} Resource name string.
1018
+ */
1019
+ projectLocationCollectionDataStoreBranchDocumentPath(project, location, collection, dataStore, branch, document) {
1020
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.render({
1021
+ project: project,
1022
+ location: location,
1023
+ collection: collection,
1024
+ data_store: dataStore,
1025
+ branch: branch,
1026
+ document: document,
1027
+ });
1028
+ }
1029
+ /**
1030
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
1031
+ *
1032
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1033
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1034
+ * @returns {string} A string representing the project.
1035
+ */
1036
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1037
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).project;
1038
+ }
1039
+ /**
1040
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
1041
+ *
1042
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1043
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1044
+ * @returns {string} A string representing the location.
1045
+ */
1046
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1047
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).location;
1048
+ }
1049
+ /**
1050
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
1051
+ *
1052
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1053
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1054
+ * @returns {string} A string representing the collection.
1055
+ */
1056
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1057
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).collection;
1058
+ }
1059
+ /**
1060
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
1061
+ *
1062
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1063
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1064
+ * @returns {string} A string representing the data_store.
1065
+ */
1066
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1067
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).data_store;
1068
+ }
1069
+ /**
1070
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
1071
+ *
1072
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1073
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1074
+ * @returns {string} A string representing the branch.
1075
+ */
1076
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1077
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).branch;
1078
+ }
1079
+ /**
1080
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
1081
+ *
1082
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
1083
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
1084
+ * @returns {string} A string representing the document.
1085
+ */
1086
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName) {
1087
+ return this.pathTemplates.projectLocationCollectionDataStoreBranchDocumentPathTemplate.match(projectLocationCollectionDataStoreBranchDocumentName).document;
1088
+ }
1089
+ /**
1090
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
1091
+ *
1092
+ * @param {string} project
1093
+ * @param {string} location
1094
+ * @param {string} collection
1095
+ * @param {string} data_store
1096
+ * @param {string} conversation
1097
+ * @returns {string} Resource name string.
1098
+ */
1099
+ projectLocationCollectionDataStoreConversationPath(project, location, collection, dataStore, conversation) {
1100
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.render({
1101
+ project: project,
1102
+ location: location,
1103
+ collection: collection,
1104
+ data_store: dataStore,
1105
+ conversation: conversation,
1106
+ });
1107
+ }
1108
+ /**
1109
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
1110
+ *
1111
+ * @param {string} projectLocationCollectionDataStoreConversationName
1112
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1113
+ * @returns {string} A string representing the project.
1114
+ */
1115
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1116
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).project;
1117
+ }
1118
+ /**
1119
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
1120
+ *
1121
+ * @param {string} projectLocationCollectionDataStoreConversationName
1122
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1123
+ * @returns {string} A string representing the location.
1124
+ */
1125
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1126
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).location;
1127
+ }
1128
+ /**
1129
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
1130
+ *
1131
+ * @param {string} projectLocationCollectionDataStoreConversationName
1132
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1133
+ * @returns {string} A string representing the collection.
1134
+ */
1135
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1136
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).collection;
1137
+ }
1138
+ /**
1139
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
1140
+ *
1141
+ * @param {string} projectLocationCollectionDataStoreConversationName
1142
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1143
+ * @returns {string} A string representing the data_store.
1144
+ */
1145
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1146
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).data_store;
1147
+ }
1148
+ /**
1149
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
1150
+ *
1151
+ * @param {string} projectLocationCollectionDataStoreConversationName
1152
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
1153
+ * @returns {string} A string representing the conversation.
1154
+ */
1155
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName) {
1156
+ return this.pathTemplates.projectLocationCollectionDataStoreConversationPathTemplate.match(projectLocationCollectionDataStoreConversationName).conversation;
1157
+ }
1158
+ /**
1159
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
1160
+ *
1161
+ * @param {string} project
1162
+ * @param {string} location
1163
+ * @param {string} collection
1164
+ * @param {string} data_store
1165
+ * @param {string} schema
1166
+ * @returns {string} Resource name string.
1167
+ */
1168
+ projectLocationCollectionDataStoreSchemaPath(project, location, collection, dataStore, schema) {
1169
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.render({
1170
+ project: project,
1171
+ location: location,
1172
+ collection: collection,
1173
+ data_store: dataStore,
1174
+ schema: schema,
1175
+ });
1176
+ }
1177
+ /**
1178
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
1179
+ *
1180
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1181
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1182
+ * @returns {string} A string representing the project.
1183
+ */
1184
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1185
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).project;
1186
+ }
1187
+ /**
1188
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
1189
+ *
1190
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1191
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1192
+ * @returns {string} A string representing the location.
1193
+ */
1194
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1195
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).location;
1196
+ }
1197
+ /**
1198
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
1199
+ *
1200
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1201
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1202
+ * @returns {string} A string representing the collection.
1203
+ */
1204
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1205
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).collection;
1206
+ }
1207
+ /**
1208
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
1209
+ *
1210
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1211
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1212
+ * @returns {string} A string representing the data_store.
1213
+ */
1214
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1215
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).data_store;
1216
+ }
1217
+ /**
1218
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
1219
+ *
1220
+ * @param {string} projectLocationCollectionDataStoreSchemaName
1221
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
1222
+ * @returns {string} A string representing the schema.
1223
+ */
1224
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName) {
1225
+ return this.pathTemplates.projectLocationCollectionDataStoreSchemaPathTemplate.match(projectLocationCollectionDataStoreSchemaName).schema;
1226
+ }
1227
+ /**
1228
+ * Return a fully-qualified projectLocationCollectionDataStoreServingConfig resource name string.
1229
+ *
1230
+ * @param {string} project
1231
+ * @param {string} location
1232
+ * @param {string} collection
1233
+ * @param {string} data_store
1234
+ * @param {string} serving_config
1235
+ * @returns {string} Resource name string.
1236
+ */
1237
+ projectLocationCollectionDataStoreServingConfigPath(project, location, collection, dataStore, servingConfig) {
1238
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.render({
1239
+ project: project,
1240
+ location: location,
1241
+ collection: collection,
1242
+ data_store: dataStore,
1243
+ serving_config: servingConfig,
1244
+ });
1245
+ }
1246
+ /**
1247
+ * Parse the project from ProjectLocationCollectionDataStoreServingConfig resource.
1248
+ *
1249
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1250
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1251
+ * @returns {string} A string representing the project.
1252
+ */
1253
+ matchProjectFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1254
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).project;
1255
+ }
1256
+ /**
1257
+ * Parse the location from ProjectLocationCollectionDataStoreServingConfig resource.
1258
+ *
1259
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1260
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1261
+ * @returns {string} A string representing the location.
1262
+ */
1263
+ matchLocationFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1264
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).location;
1265
+ }
1266
+ /**
1267
+ * Parse the collection from ProjectLocationCollectionDataStoreServingConfig resource.
1268
+ *
1269
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1270
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1271
+ * @returns {string} A string representing the collection.
1272
+ */
1273
+ matchCollectionFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1274
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).collection;
1275
+ }
1276
+ /**
1277
+ * Parse the data_store from ProjectLocationCollectionDataStoreServingConfig resource.
1278
+ *
1279
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1280
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1281
+ * @returns {string} A string representing the data_store.
1282
+ */
1283
+ matchDataStoreFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1284
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).data_store;
1285
+ }
1286
+ /**
1287
+ * Parse the serving_config from ProjectLocationCollectionDataStoreServingConfig resource.
1288
+ *
1289
+ * @param {string} projectLocationCollectionDataStoreServingConfigName
1290
+ * A fully-qualified path representing project_location_collection_data_store_serving_config resource.
1291
+ * @returns {string} A string representing the serving_config.
1292
+ */
1293
+ matchServingConfigFromProjectLocationCollectionDataStoreServingConfigName(projectLocationCollectionDataStoreServingConfigName) {
1294
+ return this.pathTemplates.projectLocationCollectionDataStoreServingConfigPathTemplate.match(projectLocationCollectionDataStoreServingConfigName).serving_config;
1295
+ }
1296
+ /**
1297
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
1298
+ *
1299
+ * @param {string} project
1300
+ * @param {string} location
1301
+ * @param {string} collection
1302
+ * @param {string} data_store
1303
+ * @returns {string} Resource name string.
1304
+ */
1305
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project, location, collection, dataStore) {
1306
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.render({
1307
+ project: project,
1308
+ location: location,
1309
+ collection: collection,
1310
+ data_store: dataStore,
1311
+ });
1312
+ }
1313
+ /**
1314
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1315
+ *
1316
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1317
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1318
+ * @returns {string} A string representing the project.
1319
+ */
1320
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1321
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).project;
1322
+ }
1323
+ /**
1324
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1325
+ *
1326
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1327
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1328
+ * @returns {string} A string representing the location.
1329
+ */
1330
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1331
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).location;
1332
+ }
1333
+ /**
1334
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1335
+ *
1336
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1337
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1338
+ * @returns {string} A string representing the collection.
1339
+ */
1340
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1341
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).collection;
1342
+ }
1343
+ /**
1344
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
1345
+ *
1346
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
1347
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
1348
+ * @returns {string} A string representing the data_store.
1349
+ */
1350
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName) {
1351
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEnginePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineName).data_store;
1352
+ }
1353
+ /**
1354
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
1355
+ *
1356
+ * @param {string} project
1357
+ * @param {string} location
1358
+ * @param {string} collection
1359
+ * @param {string} data_store
1360
+ * @param {string} target_site
1361
+ * @returns {string} Resource name string.
1362
+ */
1363
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project, location, collection, dataStore, targetSite) {
1364
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1365
+ project: project,
1366
+ location: location,
1367
+ collection: collection,
1368
+ data_store: dataStore,
1369
+ target_site: targetSite,
1370
+ });
1371
+ }
1372
+ /**
1373
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1374
+ *
1375
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1376
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1377
+ * @returns {string} A string representing the project.
1378
+ */
1379
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1380
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).project;
1381
+ }
1382
+ /**
1383
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1384
+ *
1385
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1386
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1387
+ * @returns {string} A string representing the location.
1388
+ */
1389
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1390
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).location;
1391
+ }
1392
+ /**
1393
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1394
+ *
1395
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1396
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1397
+ * @returns {string} A string representing the collection.
1398
+ */
1399
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1400
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).collection;
1401
+ }
1402
+ /**
1403
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1404
+ *
1405
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1406
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1407
+ * @returns {string} A string representing the data_store.
1408
+ */
1409
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1410
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).data_store;
1411
+ }
1412
+ /**
1413
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
1414
+ *
1415
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
1416
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
1417
+ * @returns {string} A string representing the target_site.
1418
+ */
1419
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName) {
1420
+ return this.pathTemplates.projectLocationCollectionDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName).target_site;
1421
+ }
1422
+ /**
1423
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
1424
+ *
1425
+ * @param {string} project
1426
+ * @param {string} location
1427
+ * @param {string} collection
1428
+ * @param {string} engine
1429
+ * @param {string} conversation
1430
+ * @returns {string} Resource name string.
1431
+ */
1432
+ projectLocationCollectionEngineConversationPath(project, location, collection, engine, conversation) {
1433
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.render({
1434
+ project: project,
1435
+ location: location,
1436
+ collection: collection,
1437
+ engine: engine,
1438
+ conversation: conversation,
1439
+ });
1440
+ }
1441
+ /**
1442
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
1443
+ *
1444
+ * @param {string} projectLocationCollectionEngineConversationName
1445
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1446
+ * @returns {string} A string representing the project.
1447
+ */
1448
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1449
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).project;
1450
+ }
1451
+ /**
1452
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
1453
+ *
1454
+ * @param {string} projectLocationCollectionEngineConversationName
1455
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1456
+ * @returns {string} A string representing the location.
1457
+ */
1458
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1459
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).location;
1460
+ }
1461
+ /**
1462
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
1463
+ *
1464
+ * @param {string} projectLocationCollectionEngineConversationName
1465
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1466
+ * @returns {string} A string representing the collection.
1467
+ */
1468
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1469
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).collection;
1470
+ }
1471
+ /**
1472
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
1473
+ *
1474
+ * @param {string} projectLocationCollectionEngineConversationName
1475
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1476
+ * @returns {string} A string representing the engine.
1477
+ */
1478
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1479
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).engine;
1480
+ }
1481
+ /**
1482
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
1483
+ *
1484
+ * @param {string} projectLocationCollectionEngineConversationName
1485
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
1486
+ * @returns {string} A string representing the conversation.
1487
+ */
1488
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName) {
1489
+ return this.pathTemplates.projectLocationCollectionEngineConversationPathTemplate.match(projectLocationCollectionEngineConversationName).conversation;
1490
+ }
1491
+ /**
1492
+ * Return a fully-qualified projectLocationCollectionEngineServingConfig resource name string.
1493
+ *
1494
+ * @param {string} project
1495
+ * @param {string} location
1496
+ * @param {string} collection
1497
+ * @param {string} engine
1498
+ * @param {string} serving_config
1499
+ * @returns {string} Resource name string.
1500
+ */
1501
+ projectLocationCollectionEngineServingConfigPath(project, location, collection, engine, servingConfig) {
1502
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.render({
1503
+ project: project,
1504
+ location: location,
1505
+ collection: collection,
1506
+ engine: engine,
1507
+ serving_config: servingConfig,
1508
+ });
1509
+ }
1510
+ /**
1511
+ * Parse the project from ProjectLocationCollectionEngineServingConfig resource.
1512
+ *
1513
+ * @param {string} projectLocationCollectionEngineServingConfigName
1514
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1515
+ * @returns {string} A string representing the project.
1516
+ */
1517
+ matchProjectFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1518
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).project;
1519
+ }
1520
+ /**
1521
+ * Parse the location from ProjectLocationCollectionEngineServingConfig resource.
1522
+ *
1523
+ * @param {string} projectLocationCollectionEngineServingConfigName
1524
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1525
+ * @returns {string} A string representing the location.
1526
+ */
1527
+ matchLocationFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1528
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).location;
1529
+ }
1530
+ /**
1531
+ * Parse the collection from ProjectLocationCollectionEngineServingConfig resource.
1532
+ *
1533
+ * @param {string} projectLocationCollectionEngineServingConfigName
1534
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1535
+ * @returns {string} A string representing the collection.
1536
+ */
1537
+ matchCollectionFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1538
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).collection;
1539
+ }
1540
+ /**
1541
+ * Parse the engine from ProjectLocationCollectionEngineServingConfig resource.
1542
+ *
1543
+ * @param {string} projectLocationCollectionEngineServingConfigName
1544
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1545
+ * @returns {string} A string representing the engine.
1546
+ */
1547
+ matchEngineFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1548
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).engine;
1549
+ }
1550
+ /**
1551
+ * Parse the serving_config from ProjectLocationCollectionEngineServingConfig resource.
1552
+ *
1553
+ * @param {string} projectLocationCollectionEngineServingConfigName
1554
+ * A fully-qualified path representing project_location_collection_engine_serving_config resource.
1555
+ * @returns {string} A string representing the serving_config.
1556
+ */
1557
+ matchServingConfigFromProjectLocationCollectionEngineServingConfigName(projectLocationCollectionEngineServingConfigName) {
1558
+ return this.pathTemplates.projectLocationCollectionEngineServingConfigPathTemplate.match(projectLocationCollectionEngineServingConfigName).serving_config;
1559
+ }
1560
+ /**
1561
+ * Return a fully-qualified projectLocationDataStore resource name string.
1562
+ *
1563
+ * @param {string} project
1564
+ * @param {string} location
1565
+ * @param {string} data_store
1566
+ * @returns {string} Resource name string.
1567
+ */
1568
+ projectLocationDataStorePath(project, location, dataStore) {
1569
+ return this.pathTemplates.projectLocationDataStorePathTemplate.render({
1570
+ project: project,
1571
+ location: location,
1572
+ data_store: dataStore,
1573
+ });
1574
+ }
1575
+ /**
1576
+ * Parse the project from ProjectLocationDataStore resource.
1577
+ *
1578
+ * @param {string} projectLocationDataStoreName
1579
+ * A fully-qualified path representing project_location_data_store resource.
1580
+ * @returns {string} A string representing the project.
1581
+ */
1582
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1583
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).project;
1584
+ }
1585
+ /**
1586
+ * Parse the location from ProjectLocationDataStore resource.
1587
+ *
1588
+ * @param {string} projectLocationDataStoreName
1589
+ * A fully-qualified path representing project_location_data_store resource.
1590
+ * @returns {string} A string representing the location.
1591
+ */
1592
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1593
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).location;
1594
+ }
1595
+ /**
1596
+ * Parse the data_store from ProjectLocationDataStore resource.
1597
+ *
1598
+ * @param {string} projectLocationDataStoreName
1599
+ * A fully-qualified path representing project_location_data_store resource.
1600
+ * @returns {string} A string representing the data_store.
1601
+ */
1602
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName) {
1603
+ return this.pathTemplates.projectLocationDataStorePathTemplate.match(projectLocationDataStoreName).data_store;
1604
+ }
1605
+ /**
1606
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
1607
+ *
1608
+ * @param {string} project
1609
+ * @param {string} location
1610
+ * @param {string} data_store
1611
+ * @param {string} branch
1612
+ * @param {string} document
1613
+ * @returns {string} Resource name string.
1614
+ */
1615
+ projectLocationDataStoreBranchDocumentPath(project, location, dataStore, branch, document) {
1616
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.render({
1617
+ project: project,
1618
+ location: location,
1619
+ data_store: dataStore,
1620
+ branch: branch,
1621
+ document: document,
1622
+ });
1623
+ }
1624
+ /**
1625
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
1626
+ *
1627
+ * @param {string} projectLocationDataStoreBranchDocumentName
1628
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1629
+ * @returns {string} A string representing the project.
1630
+ */
1631
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1632
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).project;
1633
+ }
1634
+ /**
1635
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
1636
+ *
1637
+ * @param {string} projectLocationDataStoreBranchDocumentName
1638
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1639
+ * @returns {string} A string representing the location.
1640
+ */
1641
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1642
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).location;
1643
+ }
1644
+ /**
1645
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
1646
+ *
1647
+ * @param {string} projectLocationDataStoreBranchDocumentName
1648
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1649
+ * @returns {string} A string representing the data_store.
1650
+ */
1651
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1652
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).data_store;
1653
+ }
1654
+ /**
1655
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
1656
+ *
1657
+ * @param {string} projectLocationDataStoreBranchDocumentName
1658
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1659
+ * @returns {string} A string representing the branch.
1660
+ */
1661
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1662
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).branch;
1663
+ }
1664
+ /**
1665
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
1666
+ *
1667
+ * @param {string} projectLocationDataStoreBranchDocumentName
1668
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
1669
+ * @returns {string} A string representing the document.
1670
+ */
1671
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName) {
1672
+ return this.pathTemplates.projectLocationDataStoreBranchDocumentPathTemplate.match(projectLocationDataStoreBranchDocumentName).document;
1673
+ }
1674
+ /**
1675
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
1676
+ *
1677
+ * @param {string} project
1678
+ * @param {string} location
1679
+ * @param {string} data_store
1680
+ * @param {string} conversation
1681
+ * @returns {string} Resource name string.
1682
+ */
1683
+ projectLocationDataStoreConversationPath(project, location, dataStore, conversation) {
1684
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.render({
1685
+ project: project,
1686
+ location: location,
1687
+ data_store: dataStore,
1688
+ conversation: conversation,
1689
+ });
1690
+ }
1691
+ /**
1692
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1693
+ *
1694
+ * @param {string} projectLocationDataStoreConversationName
1695
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1696
+ * @returns {string} A string representing the project.
1697
+ */
1698
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1699
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).project;
1700
+ }
1701
+ /**
1702
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1703
+ *
1704
+ * @param {string} projectLocationDataStoreConversationName
1705
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1706
+ * @returns {string} A string representing the location.
1707
+ */
1708
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1709
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).location;
1710
+ }
1711
+ /**
1712
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1713
+ *
1714
+ * @param {string} projectLocationDataStoreConversationName
1715
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1716
+ * @returns {string} A string representing the data_store.
1717
+ */
1718
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1719
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).data_store;
1720
+ }
1721
+ /**
1722
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1723
+ *
1724
+ * @param {string} projectLocationDataStoreConversationName
1725
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1726
+ * @returns {string} A string representing the conversation.
1727
+ */
1728
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName) {
1729
+ return this.pathTemplates.projectLocationDataStoreConversationPathTemplate.match(projectLocationDataStoreConversationName).conversation;
1730
+ }
1731
+ /**
1732
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1733
+ *
1734
+ * @param {string} project
1735
+ * @param {string} location
1736
+ * @param {string} data_store
1737
+ * @param {string} schema
1738
+ * @returns {string} Resource name string.
1739
+ */
1740
+ projectLocationDataStoreSchemaPath(project, location, dataStore, schema) {
1741
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.render({
1742
+ project: project,
1743
+ location: location,
1744
+ data_store: dataStore,
1745
+ schema: schema,
1746
+ });
1747
+ }
1748
+ /**
1749
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1750
+ *
1751
+ * @param {string} projectLocationDataStoreSchemaName
1752
+ * A fully-qualified path representing project_location_data_store_schema resource.
1753
+ * @returns {string} A string representing the project.
1754
+ */
1755
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1756
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).project;
1757
+ }
1758
+ /**
1759
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1760
+ *
1761
+ * @param {string} projectLocationDataStoreSchemaName
1762
+ * A fully-qualified path representing project_location_data_store_schema resource.
1763
+ * @returns {string} A string representing the location.
1764
+ */
1765
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1766
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).location;
1767
+ }
1768
+ /**
1769
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1770
+ *
1771
+ * @param {string} projectLocationDataStoreSchemaName
1772
+ * A fully-qualified path representing project_location_data_store_schema resource.
1773
+ * @returns {string} A string representing the data_store.
1774
+ */
1775
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1776
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).data_store;
1777
+ }
1778
+ /**
1779
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1780
+ *
1781
+ * @param {string} projectLocationDataStoreSchemaName
1782
+ * A fully-qualified path representing project_location_data_store_schema resource.
1783
+ * @returns {string} A string representing the schema.
1784
+ */
1785
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName) {
1786
+ return this.pathTemplates.projectLocationDataStoreSchemaPathTemplate.match(projectLocationDataStoreSchemaName).schema;
1787
+ }
1788
+ /**
1789
+ * Return a fully-qualified projectLocationDataStoreServingConfig resource name string.
1790
+ *
1791
+ * @param {string} project
1792
+ * @param {string} location
1793
+ * @param {string} data_store
1794
+ * @param {string} serving_config
1795
+ * @returns {string} Resource name string.
1796
+ */
1797
+ projectLocationDataStoreServingConfigPath(project, location, dataStore, servingConfig) {
1798
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.render({
1799
+ project: project,
1800
+ location: location,
1801
+ data_store: dataStore,
1802
+ serving_config: servingConfig,
1803
+ });
1804
+ }
1805
+ /**
1806
+ * Parse the project from ProjectLocationDataStoreServingConfig resource.
1807
+ *
1808
+ * @param {string} projectLocationDataStoreServingConfigName
1809
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1810
+ * @returns {string} A string representing the project.
1811
+ */
1812
+ matchProjectFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1813
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).project;
1814
+ }
1815
+ /**
1816
+ * Parse the location from ProjectLocationDataStoreServingConfig resource.
1817
+ *
1818
+ * @param {string} projectLocationDataStoreServingConfigName
1819
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1820
+ * @returns {string} A string representing the location.
1821
+ */
1822
+ matchLocationFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1823
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).location;
1824
+ }
1825
+ /**
1826
+ * Parse the data_store from ProjectLocationDataStoreServingConfig resource.
1827
+ *
1828
+ * @param {string} projectLocationDataStoreServingConfigName
1829
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1830
+ * @returns {string} A string representing the data_store.
1831
+ */
1832
+ matchDataStoreFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1833
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).data_store;
1834
+ }
1835
+ /**
1836
+ * Parse the serving_config from ProjectLocationDataStoreServingConfig resource.
1837
+ *
1838
+ * @param {string} projectLocationDataStoreServingConfigName
1839
+ * A fully-qualified path representing project_location_data_store_serving_config resource.
1840
+ * @returns {string} A string representing the serving_config.
1841
+ */
1842
+ matchServingConfigFromProjectLocationDataStoreServingConfigName(projectLocationDataStoreServingConfigName) {
1843
+ return this.pathTemplates.projectLocationDataStoreServingConfigPathTemplate.match(projectLocationDataStoreServingConfigName).serving_config;
1844
+ }
1845
+ /**
1846
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
1847
+ *
1848
+ * @param {string} project
1849
+ * @param {string} location
1850
+ * @param {string} data_store
1851
+ * @returns {string} Resource name string.
1852
+ */
1853
+ projectLocationDataStoreSiteSearchEnginePath(project, location, dataStore) {
1854
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.render({
1855
+ project: project,
1856
+ location: location,
1857
+ data_store: dataStore,
1858
+ });
1859
+ }
1860
+ /**
1861
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
1862
+ *
1863
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1864
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1865
+ * @returns {string} A string representing the project.
1866
+ */
1867
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1868
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).project;
1869
+ }
1870
+ /**
1871
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
1872
+ *
1873
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1874
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1875
+ * @returns {string} A string representing the location.
1876
+ */
1877
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1878
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).location;
1879
+ }
1880
+ /**
1881
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
1882
+ *
1883
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
1884
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
1885
+ * @returns {string} A string representing the data_store.
1886
+ */
1887
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName) {
1888
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEnginePathTemplate.match(projectLocationDataStoreSiteSearchEngineName).data_store;
1889
+ }
1890
+ /**
1891
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
1892
+ *
1893
+ * @param {string} project
1894
+ * @param {string} location
1895
+ * @param {string} data_store
1896
+ * @param {string} target_site
1897
+ * @returns {string} Resource name string.
1898
+ */
1899
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project, location, dataStore, targetSite) {
1900
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.render({
1901
+ project: project,
1902
+ location: location,
1903
+ data_store: dataStore,
1904
+ target_site: targetSite,
1905
+ });
1906
+ }
1907
+ /**
1908
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1909
+ *
1910
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1911
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1912
+ * @returns {string} A string representing the project.
1913
+ */
1914
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1915
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).project;
1916
+ }
1917
+ /**
1918
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1919
+ *
1920
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1921
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1922
+ * @returns {string} A string representing the location.
1923
+ */
1924
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1925
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).location;
1926
+ }
1927
+ /**
1928
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1929
+ *
1930
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1931
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1932
+ * @returns {string} A string representing the data_store.
1933
+ */
1934
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1935
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).data_store;
1936
+ }
1937
+ /**
1938
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
1939
+ *
1940
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
1941
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
1942
+ * @returns {string} A string representing the target_site.
1943
+ */
1944
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName) {
1945
+ return this.pathTemplates.projectLocationDataStoreSiteSearchEngineTargetSitePathTemplate.match(projectLocationDataStoreSiteSearchEngineTargetSiteName).target_site;
1946
+ }
1947
+ /**
1948
+ * Terminate the gRPC channel and close the client.
1949
+ *
1950
+ * The client will no longer be usable and all future behavior is undefined.
1951
+ * @returns {Promise} A promise that resolves when the client is closed.
1952
+ */
1953
+ close() {
1954
+ if (this.dataStoreServiceStub && !this._terminated) {
1955
+ return this.dataStoreServiceStub.then(stub => {
1956
+ this._terminated = true;
1957
+ stub.close();
1958
+ this.locationsClient.close();
1959
+ this.operationsClient.close();
1960
+ });
1961
+ }
1962
+ return Promise.resolve();
1963
+ }
1964
+ }
1965
+ exports.DataStoreServiceClient = DataStoreServiceClient;
1966
+ //# sourceMappingURL=data_store_service_client.js.map