@google-cloud/discoveryengine 0.6.0 → 0.7.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 (44) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +38 -22
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +100 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +116 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/document.proto +118 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +313 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +334 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +86 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/schema.proto +58 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +256 -0
  11. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +289 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +458 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +133 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +54 -0
  15. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +29 -4
  16. package/build/protos/protos.d.ts +6589 -0
  17. package/build/protos/protos.js +16050 -1
  18. package/build/protos/protos.json +1807 -0
  19. package/build/src/index.d.ts +18 -19
  20. package/build/src/index.js +9 -9
  21. package/build/src/v1/completion_service_client.d.ts +455 -0
  22. package/build/src/v1/completion_service_client.js +659 -0
  23. package/build/src/v1/completion_service_client_config.json +43 -0
  24. package/build/src/v1/document_service_client.d.ts +995 -0
  25. package/build/src/v1/document_service_client.js +1191 -0
  26. package/build/src/v1/document_service_client_config.json +82 -0
  27. package/build/src/v1/index.d.ts +5 -0
  28. package/build/src/v1/index.js +31 -0
  29. package/build/src/v1/schema_service_client.d.ts +795 -0
  30. package/build/src/v1/schema_service_client.js +1129 -0
  31. package/build/src/v1/schema_service_client_config.json +63 -0
  32. package/build/src/v1/search_service_client.d.ts +857 -0
  33. package/build/src/v1/search_service_client.js +1073 -0
  34. package/build/src/v1/search_service_client_config.json +43 -0
  35. package/build/src/v1/user_event_service_client.d.ts +638 -0
  36. package/build/src/v1/user_event_service_client.js +933 -0
  37. package/build/src/v1/user_event_service_client_config.json +62 -0
  38. package/build/src/v1beta/document_service_client.d.ts +52 -0
  39. package/build/src/v1beta/document_service_client.js +6 -0
  40. package/build/src/v1beta/schema_service_client.js +6 -0
  41. package/build/src/v1beta/search_service_client.d.ts +78 -12
  42. package/build/src/v1beta/search_service_client.js +52 -8
  43. package/build/src/v1beta/user_event_service_client.js +6 -0
  44. package/package.json +2 -2
@@ -1,25 +1,24 @@
1
+ import * as v1 from './v1';
1
2
  import * as v1beta from './v1beta';
2
- declare const CompletionServiceClient: typeof v1beta.CompletionServiceClient;
3
- type CompletionServiceClient = v1beta.CompletionServiceClient;
4
- declare const DocumentServiceClient: typeof v1beta.DocumentServiceClient;
5
- type DocumentServiceClient = v1beta.DocumentServiceClient;
6
- declare const RecommendationServiceClient: typeof v1beta.RecommendationServiceClient;
7
- type RecommendationServiceClient = v1beta.RecommendationServiceClient;
8
- declare const SchemaServiceClient: typeof v1beta.SchemaServiceClient;
9
- type SchemaServiceClient = v1beta.SchemaServiceClient;
10
- declare const SearchServiceClient: typeof v1beta.SearchServiceClient;
11
- type SearchServiceClient = v1beta.SearchServiceClient;
12
- declare const UserEventServiceClient: typeof v1beta.UserEventServiceClient;
13
- type UserEventServiceClient = v1beta.UserEventServiceClient;
14
- export { v1beta, CompletionServiceClient, DocumentServiceClient, RecommendationServiceClient, SchemaServiceClient, SearchServiceClient, UserEventServiceClient, };
3
+ declare const CompletionServiceClient: typeof v1.CompletionServiceClient;
4
+ type CompletionServiceClient = v1.CompletionServiceClient;
5
+ declare const DocumentServiceClient: typeof v1.DocumentServiceClient;
6
+ type DocumentServiceClient = v1.DocumentServiceClient;
7
+ declare const SchemaServiceClient: typeof v1.SchemaServiceClient;
8
+ type SchemaServiceClient = v1.SchemaServiceClient;
9
+ declare const SearchServiceClient: typeof v1.SearchServiceClient;
10
+ type SearchServiceClient = v1.SearchServiceClient;
11
+ declare const UserEventServiceClient: typeof v1.UserEventServiceClient;
12
+ type UserEventServiceClient = v1.UserEventServiceClient;
13
+ export { v1, v1beta, CompletionServiceClient, DocumentServiceClient, SchemaServiceClient, SearchServiceClient, UserEventServiceClient, };
15
14
  declare const _default: {
15
+ v1: typeof v1;
16
16
  v1beta: typeof v1beta;
17
- CompletionServiceClient: typeof v1beta.CompletionServiceClient;
18
- DocumentServiceClient: typeof v1beta.DocumentServiceClient;
19
- RecommendationServiceClient: typeof v1beta.RecommendationServiceClient;
20
- SchemaServiceClient: typeof v1beta.SchemaServiceClient;
21
- SearchServiceClient: typeof v1beta.SearchServiceClient;
22
- UserEventServiceClient: typeof v1beta.UserEventServiceClient;
17
+ CompletionServiceClient: typeof v1.CompletionServiceClient;
18
+ DocumentServiceClient: typeof v1.DocumentServiceClient;
19
+ SchemaServiceClient: typeof v1.SchemaServiceClient;
20
+ SearchServiceClient: typeof v1.SearchServiceClient;
21
+ UserEventServiceClient: typeof v1.UserEventServiceClient;
23
22
  };
24
23
  export default _default;
25
24
  import * as protos from '../protos/protos';
@@ -17,26 +17,26 @@
17
17
  // ** https://github.com/googleapis/synthtool **
18
18
  // ** All changes to this file may be overwritten. **
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.protos = exports.UserEventServiceClient = exports.SearchServiceClient = exports.SchemaServiceClient = exports.RecommendationServiceClient = exports.DocumentServiceClient = exports.CompletionServiceClient = exports.v1beta = void 0;
20
+ exports.protos = exports.UserEventServiceClient = exports.SearchServiceClient = exports.SchemaServiceClient = exports.DocumentServiceClient = exports.CompletionServiceClient = exports.v1beta = exports.v1 = void 0;
21
+ const v1 = require("./v1");
22
+ exports.v1 = v1;
21
23
  const v1beta = require("./v1beta");
22
24
  exports.v1beta = v1beta;
23
- const CompletionServiceClient = v1beta.CompletionServiceClient;
25
+ const CompletionServiceClient = v1.CompletionServiceClient;
24
26
  exports.CompletionServiceClient = CompletionServiceClient;
25
- const DocumentServiceClient = v1beta.DocumentServiceClient;
27
+ const DocumentServiceClient = v1.DocumentServiceClient;
26
28
  exports.DocumentServiceClient = DocumentServiceClient;
27
- const RecommendationServiceClient = v1beta.RecommendationServiceClient;
28
- exports.RecommendationServiceClient = RecommendationServiceClient;
29
- const SchemaServiceClient = v1beta.SchemaServiceClient;
29
+ const SchemaServiceClient = v1.SchemaServiceClient;
30
30
  exports.SchemaServiceClient = SchemaServiceClient;
31
- const SearchServiceClient = v1beta.SearchServiceClient;
31
+ const SearchServiceClient = v1.SearchServiceClient;
32
32
  exports.SearchServiceClient = SearchServiceClient;
33
- const UserEventServiceClient = v1beta.UserEventServiceClient;
33
+ const UserEventServiceClient = v1.UserEventServiceClient;
34
34
  exports.UserEventServiceClient = UserEventServiceClient;
35
35
  exports.default = {
36
+ v1,
36
37
  v1beta,
37
38
  CompletionServiceClient,
38
39
  DocumentServiceClient,
39
- RecommendationServiceClient,
40
40
  SchemaServiceClient,
41
41
  SearchServiceClient,
42
42
  UserEventServiceClient,
@@ -0,0 +1,455 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions } from 'google-gax';
3
+ import * as protos from '../../protos/protos';
4
+ /**
5
+ * Service for Auto-Completion.
6
+ * @class
7
+ * @memberof v1
8
+ */
9
+ export declare class CompletionServiceClient {
10
+ private _terminated;
11
+ private _opts;
12
+ private _providedCustomServicePath;
13
+ private _gaxModule;
14
+ private _gaxGrpc;
15
+ private _protos;
16
+ private _defaults;
17
+ auth: gax.GoogleAuth;
18
+ descriptors: Descriptors;
19
+ warn: (code: string, message: string, warnType?: string) => void;
20
+ innerApiCalls: {
21
+ [name: string]: Function;
22
+ };
23
+ pathTemplates: {
24
+ [name: string]: gax.PathTemplate;
25
+ };
26
+ completionServiceStub?: Promise<{
27
+ [name: string]: Function;
28
+ }>;
29
+ /**
30
+ * Construct an instance of CompletionServiceClient.
31
+ *
32
+ * @param {object} [options] - The configuration object.
33
+ * The options accepted by the constructor are described in detail
34
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
35
+ * The common options are:
36
+ * @param {object} [options.credentials] - Credentials object.
37
+ * @param {string} [options.credentials.client_email]
38
+ * @param {string} [options.credentials.private_key]
39
+ * @param {string} [options.email] - Account email address. Required when
40
+ * using a .pem or .p12 keyFilename.
41
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
42
+ * .p12 key downloaded from the Google Developers Console. If you provide
43
+ * a path to a JSON file, the projectId option below is not necessary.
44
+ * NOTE: .pem and .p12 require you to specify options.email as well.
45
+ * @param {number} [options.port] - The port on which to connect to
46
+ * the remote host.
47
+ * @param {string} [options.projectId] - The project ID from the Google
48
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
49
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
50
+ * app is running in an environment which supports
51
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
52
+ * your project ID will be detected automatically.
53
+ * @param {string} [options.apiEndpoint] - The domain name of the
54
+ * API remote host.
55
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
56
+ * Follows the structure of {@link gapicConfig}.
57
+ * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
58
+ * Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
59
+ * For more information, please check the
60
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
61
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
62
+ * need to avoid loading the default gRPC version and want to use the fallback
63
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
64
+ * ```
65
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
66
+ * const client = new CompletionServiceClient({fallback: 'rest'}, gax);
67
+ * ```
68
+ */
69
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
70
+ /**
71
+ * Initialize the client.
72
+ * Performs asynchronous operations (such as authentication) and prepares the client.
73
+ * This function will be called automatically when any class method is called for the
74
+ * first time, but if you need to initialize it before calling an actual method,
75
+ * feel free to call initialize() directly.
76
+ *
77
+ * You can await on this method if you want to make sure the client is initialized.
78
+ *
79
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
80
+ */
81
+ initialize(): Promise<{
82
+ [name: string]: Function;
83
+ }>;
84
+ /**
85
+ * The DNS address for this API service.
86
+ * @returns {string} The DNS address for this service.
87
+ */
88
+ static get servicePath(): string;
89
+ /**
90
+ * The DNS address for this API service - same as servicePath(),
91
+ * exists for compatibility reasons.
92
+ * @returns {string} The DNS address for this service.
93
+ */
94
+ static get apiEndpoint(): string;
95
+ /**
96
+ * The port for this API service.
97
+ * @returns {number} The default port for this service.
98
+ */
99
+ static get port(): number;
100
+ /**
101
+ * The scopes needed to make gRPC calls for every method defined
102
+ * in this service.
103
+ * @returns {string[]} List of default scopes.
104
+ */
105
+ static get scopes(): string[];
106
+ getProjectId(): Promise<string>;
107
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
108
+ /**
109
+ * Completes the specified user input with keyword suggestions.
110
+ *
111
+ * @param {Object} request
112
+ * The request object that will be sent.
113
+ * @param {string} request.dataStore
114
+ * Required. The parent data store resource name for which the completion is
115
+ * performed, such as
116
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
117
+ * @param {string} request.query
118
+ * Required. The typeahead input used to fetch suggestions. Maximum length is
119
+ * 128 characters.
120
+ * @param {string} request.queryModel
121
+ * Selects data model of query suggestions for serving. Currently supported
122
+ * values:
123
+ *
124
+ * * `document` - Using suggestions generated from user-imported documents.
125
+ * * `search-history` - Using suggestions generated from the past history of
126
+ * {@link google.cloud.discoveryengine.v1.SearchService.Search|SearchService.Search}
127
+ * API calls. Do not use it when there is no traffic for Search API.
128
+ * * `user-event` - Using suggestions generated from user-imported search
129
+ * events.
130
+ *
131
+ * Default values:
132
+ *
133
+ * * `document` is the default model for regular dataStores.
134
+ * * `search-history` is the default model for
135
+ * {@link google.cloud.discoveryengine.v1.IndustryVertical.SITE_SEARCH|IndustryVertical.SITE_SEARCH}
136
+ * dataStores.
137
+ * @param {string} request.userPseudoId
138
+ * A unique identifier for tracking visitors. For example, this could be
139
+ * implemented with an HTTP cookie, which should be able to uniquely identify
140
+ * a visitor on a single device. This unique identifier should not change if
141
+ * the visitor logs in or out of the website.
142
+ *
143
+ * This field should NOT have a fixed value such as `unknown_visitor`.
144
+ *
145
+ * This should be the same identifier as
146
+ * {@link google.cloud.discoveryengine.v1.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
147
+ * and
148
+ * {@link google.cloud.discoveryengine.v1.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
149
+ *
150
+ * The field must be a UTF-8 encoded string with a length limit of 128
151
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
152
+ * @param {object} [options]
153
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
154
+ * @returns {Promise} - The promise which resolves to an array.
155
+ * The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.CompleteQueryResponse | CompleteQueryResponse}.
156
+ * Please see the
157
+ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
158
+ * for more details and examples.
159
+ * @example <caption>include:samples/generated/v1/completion_service.complete_query.js</caption>
160
+ * region_tag:discoveryengine_v1_generated_CompletionService_CompleteQuery_async
161
+ */
162
+ completeQuery(request?: protos.google.cloud.discoveryengine.v1.ICompleteQueryRequest, options?: CallOptions): Promise<[
163
+ protos.google.cloud.discoveryengine.v1.ICompleteQueryResponse,
164
+ protos.google.cloud.discoveryengine.v1.ICompleteQueryRequest | undefined,
165
+ {} | undefined
166
+ ]>;
167
+ completeQuery(request: protos.google.cloud.discoveryengine.v1.ICompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.ICompleteQueryResponse, protos.google.cloud.discoveryengine.v1.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
168
+ completeQuery(request: protos.google.cloud.discoveryengine.v1.ICompleteQueryRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.ICompleteQueryResponse, protos.google.cloud.discoveryengine.v1.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
169
+ /**
170
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
171
+ *
172
+ * @param {string} project
173
+ * @param {string} location
174
+ * @param {string} collection
175
+ * @param {string} data_store
176
+ * @returns {string} Resource name string.
177
+ */
178
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
179
+ /**
180
+ * Parse the project from ProjectLocationCollectionDataStore resource.
181
+ *
182
+ * @param {string} projectLocationCollectionDataStoreName
183
+ * A fully-qualified path representing project_location_collection_data_store resource.
184
+ * @returns {string} A string representing the project.
185
+ */
186
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
187
+ /**
188
+ * Parse the location from ProjectLocationCollectionDataStore resource.
189
+ *
190
+ * @param {string} projectLocationCollectionDataStoreName
191
+ * A fully-qualified path representing project_location_collection_data_store resource.
192
+ * @returns {string} A string representing the location.
193
+ */
194
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
195
+ /**
196
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
197
+ *
198
+ * @param {string} projectLocationCollectionDataStoreName
199
+ * A fully-qualified path representing project_location_collection_data_store resource.
200
+ * @returns {string} A string representing the collection.
201
+ */
202
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
203
+ /**
204
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
205
+ *
206
+ * @param {string} projectLocationCollectionDataStoreName
207
+ * A fully-qualified path representing project_location_collection_data_store resource.
208
+ * @returns {string} A string representing the data_store.
209
+ */
210
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
211
+ /**
212
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
213
+ *
214
+ * @param {string} project
215
+ * @param {string} location
216
+ * @param {string} collection
217
+ * @param {string} data_store
218
+ * @param {string} branch
219
+ * @param {string} document
220
+ * @returns {string} Resource name string.
221
+ */
222
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
223
+ /**
224
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
225
+ *
226
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
227
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
228
+ * @returns {string} A string representing the project.
229
+ */
230
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
231
+ /**
232
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
233
+ *
234
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
235
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
236
+ * @returns {string} A string representing the location.
237
+ */
238
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
239
+ /**
240
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
241
+ *
242
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
243
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
244
+ * @returns {string} A string representing the collection.
245
+ */
246
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
247
+ /**
248
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
249
+ *
250
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
251
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
252
+ * @returns {string} A string representing the data_store.
253
+ */
254
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
255
+ /**
256
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
257
+ *
258
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
259
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
260
+ * @returns {string} A string representing the branch.
261
+ */
262
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
263
+ /**
264
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
265
+ *
266
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
267
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
268
+ * @returns {string} A string representing the document.
269
+ */
270
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
271
+ /**
272
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
273
+ *
274
+ * @param {string} project
275
+ * @param {string} location
276
+ * @param {string} collection
277
+ * @param {string} data_store
278
+ * @param {string} schema
279
+ * @returns {string} Resource name string.
280
+ */
281
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
282
+ /**
283
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
284
+ *
285
+ * @param {string} projectLocationCollectionDataStoreSchemaName
286
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
287
+ * @returns {string} A string representing the project.
288
+ */
289
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
290
+ /**
291
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
292
+ *
293
+ * @param {string} projectLocationCollectionDataStoreSchemaName
294
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
295
+ * @returns {string} A string representing the location.
296
+ */
297
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
298
+ /**
299
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
300
+ *
301
+ * @param {string} projectLocationCollectionDataStoreSchemaName
302
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
303
+ * @returns {string} A string representing the collection.
304
+ */
305
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
306
+ /**
307
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
308
+ *
309
+ * @param {string} projectLocationCollectionDataStoreSchemaName
310
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
311
+ * @returns {string} A string representing the data_store.
312
+ */
313
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
314
+ /**
315
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
316
+ *
317
+ * @param {string} projectLocationCollectionDataStoreSchemaName
318
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
319
+ * @returns {string} A string representing the schema.
320
+ */
321
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
322
+ /**
323
+ * Return a fully-qualified projectLocationDataStore resource name string.
324
+ *
325
+ * @param {string} project
326
+ * @param {string} location
327
+ * @param {string} data_store
328
+ * @returns {string} Resource name string.
329
+ */
330
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
331
+ /**
332
+ * Parse the project from ProjectLocationDataStore resource.
333
+ *
334
+ * @param {string} projectLocationDataStoreName
335
+ * A fully-qualified path representing project_location_data_store resource.
336
+ * @returns {string} A string representing the project.
337
+ */
338
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
339
+ /**
340
+ * Parse the location from ProjectLocationDataStore resource.
341
+ *
342
+ * @param {string} projectLocationDataStoreName
343
+ * A fully-qualified path representing project_location_data_store resource.
344
+ * @returns {string} A string representing the location.
345
+ */
346
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
347
+ /**
348
+ * Parse the data_store from ProjectLocationDataStore resource.
349
+ *
350
+ * @param {string} projectLocationDataStoreName
351
+ * A fully-qualified path representing project_location_data_store resource.
352
+ * @returns {string} A string representing the data_store.
353
+ */
354
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
355
+ /**
356
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
357
+ *
358
+ * @param {string} project
359
+ * @param {string} location
360
+ * @param {string} data_store
361
+ * @param {string} branch
362
+ * @param {string} document
363
+ * @returns {string} Resource name string.
364
+ */
365
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
366
+ /**
367
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
368
+ *
369
+ * @param {string} projectLocationDataStoreBranchDocumentName
370
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
371
+ * @returns {string} A string representing the project.
372
+ */
373
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
374
+ /**
375
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
376
+ *
377
+ * @param {string} projectLocationDataStoreBranchDocumentName
378
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
379
+ * @returns {string} A string representing the location.
380
+ */
381
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
382
+ /**
383
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
384
+ *
385
+ * @param {string} projectLocationDataStoreBranchDocumentName
386
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
387
+ * @returns {string} A string representing the data_store.
388
+ */
389
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
390
+ /**
391
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
392
+ *
393
+ * @param {string} projectLocationDataStoreBranchDocumentName
394
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
395
+ * @returns {string} A string representing the branch.
396
+ */
397
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
398
+ /**
399
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
400
+ *
401
+ * @param {string} projectLocationDataStoreBranchDocumentName
402
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
403
+ * @returns {string} A string representing the document.
404
+ */
405
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
406
+ /**
407
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
408
+ *
409
+ * @param {string} project
410
+ * @param {string} location
411
+ * @param {string} data_store
412
+ * @param {string} schema
413
+ * @returns {string} Resource name string.
414
+ */
415
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
416
+ /**
417
+ * Parse the project from ProjectLocationDataStoreSchema resource.
418
+ *
419
+ * @param {string} projectLocationDataStoreSchemaName
420
+ * A fully-qualified path representing project_location_data_store_schema resource.
421
+ * @returns {string} A string representing the project.
422
+ */
423
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
424
+ /**
425
+ * Parse the location from ProjectLocationDataStoreSchema resource.
426
+ *
427
+ * @param {string} projectLocationDataStoreSchemaName
428
+ * A fully-qualified path representing project_location_data_store_schema resource.
429
+ * @returns {string} A string representing the location.
430
+ */
431
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
432
+ /**
433
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
434
+ *
435
+ * @param {string} projectLocationDataStoreSchemaName
436
+ * A fully-qualified path representing project_location_data_store_schema resource.
437
+ * @returns {string} A string representing the data_store.
438
+ */
439
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
440
+ /**
441
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
442
+ *
443
+ * @param {string} projectLocationDataStoreSchemaName
444
+ * A fully-qualified path representing project_location_data_store_schema resource.
445
+ * @returns {string} A string representing the schema.
446
+ */
447
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
448
+ /**
449
+ * Terminate the gRPC channel and close the client.
450
+ *
451
+ * The client will no longer be usable and all future behavior is undefined.
452
+ * @returns {Promise} A promise that resolves when the client is closed.
453
+ */
454
+ close(): Promise<void>;
455
+ }