@google-cloud/discoveryengine 0.1.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 (32) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/LICENSE +202 -0
  3. package/README.md +209 -0
  4. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +93 -0
  5. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +77 -0
  6. package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +261 -0
  7. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +265 -0
  8. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +182 -0
  9. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +453 -0
  10. package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +122 -0
  11. package/build/protos/protos.d.ts +10120 -0
  12. package/build/protos/protos.js +26118 -0
  13. package/build/protos/protos.json +2682 -0
  14. package/build/src/index.d.ts +17 -0
  15. package/build/src/index.js +37 -0
  16. package/build/src/index.js.map +1 -0
  17. package/build/src/v1beta/document_service_client.d.ts +684 -0
  18. package/build/src/v1beta/document_service_client.js +830 -0
  19. package/build/src/v1beta/document_service_client.js.map +1 -0
  20. package/build/src/v1beta/document_service_client_config.json +77 -0
  21. package/build/src/v1beta/index.d.ts +3 -0
  22. package/build/src/v1beta/index.js +27 -0
  23. package/build/src/v1beta/index.js.map +1 -0
  24. package/build/src/v1beta/recommendation_service_client.d.ts +307 -0
  25. package/build/src/v1beta/recommendation_service_client.js +407 -0
  26. package/build/src/v1beta/recommendation_service_client.js.map +1 -0
  27. package/build/src/v1beta/recommendation_service_client_config.json +43 -0
  28. package/build/src/v1beta/user_event_service_client.d.ts +445 -0
  29. package/build/src/v1beta/user_event_service_client.js +628 -0
  30. package/build/src/v1beta/user_event_service_client.js.map +1 -0
  31. package/build/src/v1beta/user_event_service_client_config.json +62 -0
  32. package/package.json +66 -0
@@ -0,0 +1,445 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation } from 'google-gax';
3
+ import * as protos from '../../protos/protos';
4
+ /**
5
+ * Service for ingesting end user actions on a website to Discovery Engine API.
6
+ * @class
7
+ * @memberof v1beta
8
+ */
9
+ export declare class UserEventServiceClient {
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
+ operationsClient: gax.OperationsClient;
27
+ userEventServiceStub?: Promise<{
28
+ [name: string]: Function;
29
+ }>;
30
+ /**
31
+ * Construct an instance of UserEventServiceClient.
32
+ *
33
+ * @param {object} [options] - The configuration object.
34
+ * The options accepted by the constructor are described in detail
35
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
36
+ * The common options are:
37
+ * @param {object} [options.credentials] - Credentials object.
38
+ * @param {string} [options.credentials.client_email]
39
+ * @param {string} [options.credentials.private_key]
40
+ * @param {string} [options.email] - Account email address. Required when
41
+ * using a .pem or .p12 keyFilename.
42
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
43
+ * .p12 key downloaded from the Google Developers Console. If you provide
44
+ * a path to a JSON file, the projectId option below is not necessary.
45
+ * NOTE: .pem and .p12 require you to specify options.email as well.
46
+ * @param {number} [options.port] - The port on which to connect to
47
+ * the remote host.
48
+ * @param {string} [options.projectId] - The project ID from the Google
49
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
50
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
51
+ * app is running in an environment which supports
52
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
53
+ * your project ID will be detected automatically.
54
+ * @param {string} [options.apiEndpoint] - The domain name of the
55
+ * API remote host.
56
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
57
+ * Follows the structure of {@link gapicConfig}.
58
+ * @param {boolean | "rest"} [options.fallback] - Use HTTP fallback mode.
59
+ * Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
60
+ * For more information, please check the
61
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
62
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
63
+ * need to avoid loading the default gRPC version and want to use the fallback
64
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
65
+ * ```
66
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
67
+ * const client = new UserEventServiceClient({fallback: 'rest'}, gax);
68
+ * ```
69
+ */
70
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
71
+ /**
72
+ * Initialize the client.
73
+ * Performs asynchronous operations (such as authentication) and prepares the client.
74
+ * This function will be called automatically when any class method is called for the
75
+ * first time, but if you need to initialize it before calling an actual method,
76
+ * feel free to call initialize() directly.
77
+ *
78
+ * You can await on this method if you want to make sure the client is initialized.
79
+ *
80
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
81
+ */
82
+ initialize(): Promise<{
83
+ [name: string]: Function;
84
+ }>;
85
+ /**
86
+ * The DNS address for this API service.
87
+ * @returns {string} The DNS address for this service.
88
+ */
89
+ static get servicePath(): string;
90
+ /**
91
+ * The DNS address for this API service - same as servicePath(),
92
+ * exists for compatibility reasons.
93
+ * @returns {string} The DNS address for this service.
94
+ */
95
+ static get apiEndpoint(): string;
96
+ /**
97
+ * The port for this API service.
98
+ * @returns {number} The default port for this service.
99
+ */
100
+ static get port(): number;
101
+ /**
102
+ * The scopes needed to make gRPC calls for every method defined
103
+ * in this service.
104
+ * @returns {string[]} List of default scopes.
105
+ */
106
+ static get scopes(): string[];
107
+ getProjectId(): Promise<string>;
108
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
109
+ /**
110
+ * Writes a single user event.
111
+ *
112
+ * @param {Object} request
113
+ * The request object that will be sent.
114
+ * @param {string} request.parent
115
+ * Required. The parent DataStore resource name, such as
116
+ * `projects/{project}/locations/{location}/dataStores/{data_store}`.
117
+ * @param {google.cloud.discoveryengine.v1beta.UserEvent} request.userEvent
118
+ * Required. User event to write.
119
+ * @param {object} [options]
120
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
121
+ * @returns {Promise} - The promise which resolves to an array.
122
+ * The first element of the array is an object representing [UserEvent]{@link google.cloud.discoveryengine.v1beta.UserEvent}.
123
+ * Please see the
124
+ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
125
+ * for more details and examples.
126
+ * @example <caption>include:samples/generated/v1beta/user_event_service.write_user_event.js</caption>
127
+ * region_tag:discoveryengine_v1beta_generated_UserEventService_WriteUserEvent_async
128
+ */
129
+ writeUserEvent(request?: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, options?: CallOptions): Promise<[
130
+ protos.google.cloud.discoveryengine.v1beta.IUserEvent,
131
+ (protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest | undefined),
132
+ {} | undefined
133
+ ]>;
134
+ writeUserEvent(request: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IUserEvent, protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
135
+ writeUserEvent(request: protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest, callback: Callback<protos.google.cloud.discoveryengine.v1beta.IUserEvent, protos.google.cloud.discoveryengine.v1beta.IWriteUserEventRequest | null | undefined, {} | null | undefined>): void;
136
+ /**
137
+ * Writes a single user event from the browser. This uses a GET request to
138
+ * due to browser restriction of POST-ing to a 3rd party domain.
139
+ *
140
+ * This method is used only by the Discovery Engine API JavaScript pixel and
141
+ * Google Tag Manager. Users should not call this method directly.
142
+ *
143
+ * @param {Object} request
144
+ * The request object that will be sent.
145
+ * @param {string} request.parent
146
+ * Required. The parent DataStore resource name, such as
147
+ * `projects/{project}/locations/{location}/dataStores/{data_store}`.
148
+ * @param {string} request.userEvent
149
+ * Required. URL encoded UserEvent proto with a length limit of 2,000,000
150
+ * characters.
151
+ * @param {string} request.uri
152
+ * The URL including cgi-parameters but excluding the hash fragment with a
153
+ * length limit of 5,000 characters. This is often more useful than the
154
+ * referer URL, because many browsers only send the domain for 3rd party
155
+ * requests.
156
+ * @param {number} request.ets
157
+ * The event timestamp in milliseconds. This prevents browser caching of
158
+ * otherwise identical get requests. The name is abbreviated to reduce the
159
+ * payload bytes.
160
+ * @param {object} [options]
161
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
162
+ * @returns {Promise} - The promise which resolves to an array.
163
+ * The first element of the array is an object representing [HttpBody]{@link google.api.HttpBody}.
164
+ * Please see the
165
+ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
166
+ * for more details and examples.
167
+ * @example <caption>include:samples/generated/v1beta/user_event_service.collect_user_event.js</caption>
168
+ * region_tag:discoveryengine_v1beta_generated_UserEventService_CollectUserEvent_async
169
+ */
170
+ collectUserEvent(request?: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, options?: CallOptions): Promise<[
171
+ protos.google.api.IHttpBody,
172
+ (protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | undefined),
173
+ {} | undefined
174
+ ]>;
175
+ collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, options: CallOptions, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
176
+ collectUserEvent(request: protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest, callback: Callback<protos.google.api.IHttpBody, protos.google.cloud.discoveryengine.v1beta.ICollectUserEventRequest | null | undefined, {} | null | undefined>): void;
177
+ /**
178
+ * Bulk import of User events. Request processing might be
179
+ * synchronous. Events that already exist are skipped.
180
+ * Use this method for backfilling historical user events.
181
+ *
182
+ * Operation.response is of type ImportResponse. Note that it is
183
+ * possible for a subset of the items to be successfully inserted.
184
+ * Operation.metadata is of type ImportMetadata.
185
+ *
186
+ * @param {Object} request
187
+ * The request object that will be sent.
188
+ * @param {google.cloud.discoveryengine.v1beta.ImportUserEventsRequest.InlineSource} request.inlineSource
189
+ * Required. The Inline source for the input content for UserEvents.
190
+ * @param {google.cloud.discoveryengine.v1beta.GcsSource} request.gcsSource
191
+ * Required. Google Cloud Storage location for the input content.
192
+ * @param {google.cloud.discoveryengine.v1beta.BigQuerySource} request.bigquerySource
193
+ * Required. BigQuery input source.
194
+ * @param {string} request.parent
195
+ * Required. Parent DataStore resource name, of the form
196
+ * `projects/{project}/locations/{location}/dataStores/{data_store}`
197
+ * @param {google.cloud.discoveryengine.v1beta.ImportErrorConfig} request.errorConfig
198
+ * The desired location of errors incurred during the Import. Cannot be set
199
+ * for inline user event imports.
200
+ * @param {object} [options]
201
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
202
+ * @returns {Promise} - The promise which resolves to an array.
203
+ * The first element of the array is an object representing
204
+ * a long running operation. Its `promise()` method returns a promise
205
+ * you can `await` for.
206
+ * Please see the
207
+ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
208
+ * for more details and examples.
209
+ * @example <caption>include:samples/generated/v1beta/user_event_service.import_user_events.js</caption>
210
+ * region_tag:discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async
211
+ */
212
+ importUserEvents(request?: protos.google.cloud.discoveryengine.v1beta.IImportUserEventsRequest, options?: CallOptions): Promise<[
213
+ LROperation<protos.google.cloud.discoveryengine.v1beta.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IImportUserEventsMetadata>,
214
+ protos.google.longrunning.IOperation | undefined,
215
+ {} | undefined
216
+ ]>;
217
+ importUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IImportUserEventsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
218
+ importUserEvents(request: protos.google.cloud.discoveryengine.v1beta.IImportUserEventsRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1beta.IImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.IImportUserEventsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
219
+ /**
220
+ * Check the status of the long running operation returned by `importUserEvents()`.
221
+ * @param {String} name
222
+ * The operation name that will be passed.
223
+ * @returns {Promise} - The promise which resolves to an object.
224
+ * The decoded operation object has result and metadata field to get information from.
225
+ * Please see the
226
+ * [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
227
+ * for more details and examples.
228
+ * @example <caption>include:samples/generated/v1beta/user_event_service.import_user_events.js</caption>
229
+ * region_tag:discoveryengine_v1beta_generated_UserEventService_ImportUserEvents_async
230
+ */
231
+ checkImportUserEventsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1beta.ImportUserEventsResponse, protos.google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata>>;
232
+ /**
233
+ * Gets the latest state of a long-running operation. Clients can use this
234
+ * method to poll the operation result at intervals as recommended by the API
235
+ * service.
236
+ *
237
+ * @param {Object} request - The request object that will be sent.
238
+ * @param {string} request.name - The name of the operation resource.
239
+ * @param {Object=} options
240
+ * Optional parameters. You can override the default settings for this call,
241
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
242
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
243
+ * details.
244
+ * @param {function(?Error, ?Object)=} callback
245
+ * The function which will be called with the result of the API call.
246
+ *
247
+ * The second parameter to the callback is an object representing
248
+ * [google.longrunning.Operation]{@link
249
+ * external:"google.longrunning.Operation"}.
250
+ * @return {Promise} - The promise which resolves to an array.
251
+ * The first element of the array is an object representing
252
+ * [google.longrunning.Operation]{@link
253
+ * external:"google.longrunning.Operation"}. The promise has a method named
254
+ * "cancel" which cancels the ongoing API call.
255
+ *
256
+ * @example
257
+ * ```
258
+ * const client = longrunning.operationsClient();
259
+ * const name = '';
260
+ * const [response] = await client.getOperation({name});
261
+ * // doThingsWith(response)
262
+ * ```
263
+ */
264
+ getOperation(request: protos.google.longrunning.GetOperationRequest, options?: gax.CallOptions | Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.longrunning.Operation, protos.google.longrunning.GetOperationRequest, {} | null | undefined>): Promise<[protos.google.longrunning.Operation]>;
265
+ /**
266
+ * Lists operations that match the specified filter in the request. If the
267
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
268
+ *
269
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
270
+ *
271
+ * @param {Object} request - The request object that will be sent.
272
+ * @param {string} request.name - The name of the operation collection.
273
+ * @param {string} request.filter - The standard list filter.
274
+ * @param {number=} request.pageSize -
275
+ * The maximum number of resources contained in the underlying API
276
+ * response. If page streaming is performed per-resource, this
277
+ * parameter does not affect the return value. If page streaming is
278
+ * performed per-page, this determines the maximum number of
279
+ * resources in a page.
280
+ * @param {Object=} options
281
+ * Optional parameters. You can override the default settings for this call,
282
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
283
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
284
+ * details.
285
+ * @returns {Object}
286
+ * An iterable Object that conforms to @link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols.
287
+ *
288
+ * @example
289
+ * ```
290
+ * const client = longrunning.operationsClient();
291
+ * for await (const response of client.listOperationsAsync(request));
292
+ * // doThingsWith(response)
293
+ * ```
294
+ */
295
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
296
+ /**
297
+ * Starts asynchronous cancellation on a long-running operation. The server
298
+ * makes a best effort to cancel the operation, but success is not
299
+ * guaranteed. If the server doesn't support this method, it returns
300
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
301
+ * {@link Operations.GetOperation} or
302
+ * other methods to check whether the cancellation succeeded or whether the
303
+ * operation completed despite cancellation. On successful cancellation,
304
+ * the operation is not deleted; instead, it becomes an operation with
305
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
306
+ * 1, corresponding to `Code.CANCELLED`.
307
+ *
308
+ * @param {Object} request - The request object that will be sent.
309
+ * @param {string} request.name - The name of the operation resource to be cancelled.
310
+ * @param {Object=} options
311
+ * Optional parameters. You can override the default settings for this call,
312
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
313
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
314
+ * details.
315
+ * @param {function(?Error)=} callback
316
+ * The function which will be called with the result of the API call.
317
+ * @return {Promise} - The promise which resolves when API call finishes.
318
+ * The promise has a method named "cancel" which cancels the ongoing API
319
+ * call.
320
+ *
321
+ * @example
322
+ * ```
323
+ * const client = longrunning.operationsClient();
324
+ * await client.cancelOperation({name: ''});
325
+ * ```
326
+ */
327
+ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.CancelOperationRequest, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
328
+ /**
329
+ * Deletes a long-running operation. This method indicates that the client is
330
+ * no longer interested in the operation result. It does not cancel the
331
+ * operation. If the server doesn't support this method, it returns
332
+ * `google.rpc.Code.UNIMPLEMENTED`.
333
+ *
334
+ * @param {Object} request - The request object that will be sent.
335
+ * @param {string} request.name - The name of the operation resource to be deleted.
336
+ * @param {Object=} options
337
+ * Optional parameters. You can override the default settings for this call,
338
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
339
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
340
+ * details.
341
+ * @param {function(?Error)=} callback
342
+ * The function which will be called with the result of the API call.
343
+ * @return {Promise} - The promise which resolves when API call finishes.
344
+ * The promise has a method named "cancel" which cancels the ongoing API
345
+ * call.
346
+ *
347
+ * @example
348
+ * ```
349
+ * const client = longrunning.operationsClient();
350
+ * await client.deleteOperation({name: ''});
351
+ * ```
352
+ */
353
+ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, options?: gax.CallOptions | Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>, callback?: Callback<protos.google.protobuf.Empty, protos.google.longrunning.DeleteOperationRequest, {} | null | undefined>): Promise<protos.google.protobuf.Empty>;
354
+ /**
355
+ * Return a fully-qualified dataStore resource name string.
356
+ *
357
+ * @param {string} project
358
+ * @param {string} location
359
+ * @param {string} data_store
360
+ * @returns {string} Resource name string.
361
+ */
362
+ dataStorePath(project: string, location: string, dataStore: string): string;
363
+ /**
364
+ * Parse the project from DataStore resource.
365
+ *
366
+ * @param {string} dataStoreName
367
+ * A fully-qualified path representing DataStore resource.
368
+ * @returns {string} A string representing the project.
369
+ */
370
+ matchProjectFromDataStoreName(dataStoreName: string): string | number;
371
+ /**
372
+ * Parse the location from DataStore resource.
373
+ *
374
+ * @param {string} dataStoreName
375
+ * A fully-qualified path representing DataStore resource.
376
+ * @returns {string} A string representing the location.
377
+ */
378
+ matchLocationFromDataStoreName(dataStoreName: string): string | number;
379
+ /**
380
+ * Parse the data_store from DataStore resource.
381
+ *
382
+ * @param {string} dataStoreName
383
+ * A fully-qualified path representing DataStore resource.
384
+ * @returns {string} A string representing the data_store.
385
+ */
386
+ matchDataStoreFromDataStoreName(dataStoreName: string): string | number;
387
+ /**
388
+ * Return a fully-qualified document resource name string.
389
+ *
390
+ * @param {string} project
391
+ * @param {string} location
392
+ * @param {string} data_store
393
+ * @param {string} branch
394
+ * @param {string} document
395
+ * @returns {string} Resource name string.
396
+ */
397
+ documentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
398
+ /**
399
+ * Parse the project from Document resource.
400
+ *
401
+ * @param {string} documentName
402
+ * A fully-qualified path representing Document resource.
403
+ * @returns {string} A string representing the project.
404
+ */
405
+ matchProjectFromDocumentName(documentName: string): string | number;
406
+ /**
407
+ * Parse the location from Document resource.
408
+ *
409
+ * @param {string} documentName
410
+ * A fully-qualified path representing Document resource.
411
+ * @returns {string} A string representing the location.
412
+ */
413
+ matchLocationFromDocumentName(documentName: string): string | number;
414
+ /**
415
+ * Parse the data_store from Document resource.
416
+ *
417
+ * @param {string} documentName
418
+ * A fully-qualified path representing Document resource.
419
+ * @returns {string} A string representing the data_store.
420
+ */
421
+ matchDataStoreFromDocumentName(documentName: string): string | number;
422
+ /**
423
+ * Parse the branch from Document resource.
424
+ *
425
+ * @param {string} documentName
426
+ * A fully-qualified path representing Document resource.
427
+ * @returns {string} A string representing the branch.
428
+ */
429
+ matchBranchFromDocumentName(documentName: string): string | number;
430
+ /**
431
+ * Parse the document from Document resource.
432
+ *
433
+ * @param {string} documentName
434
+ * A fully-qualified path representing Document resource.
435
+ * @returns {string} A string representing the document.
436
+ */
437
+ matchDocumentFromDocumentName(documentName: string): string | number;
438
+ /**
439
+ * Terminate the gRPC channel and close the client.
440
+ *
441
+ * The client will no longer be usable and all future behavior is undefined.
442
+ * @returns {Promise} A promise that resolves when the client is closed.
443
+ */
444
+ close(): Promise<void>;
445
+ }