@google-cloud/discoveryengine 1.2.0 → 1.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (37) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/README.md +13 -0
  3. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +39 -4
  4. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store.proto +98 -0
  5. package/build/protos/google/cloud/discoveryengine/v1alpha/data_store_service.proto +307 -0
  6. package/build/protos/google/cloud/discoveryengine/v1alpha/engine.proto +370 -0
  7. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +336 -0
  8. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +9 -3
  9. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +26 -3
  10. package/build/protos/protos.d.ts +5578 -1800
  11. package/build/protos/protos.js +14034 -5272
  12. package/build/protos/protos.json +1337 -340
  13. package/build/src/v1alpha/completion_service_client.d.ts +42 -0
  14. package/build/src/v1alpha/completion_service_client.js +58 -0
  15. package/build/src/v1alpha/conversational_search_service_client.d.ts +42 -0
  16. package/build/src/v1alpha/conversational_search_service_client.js +58 -0
  17. package/build/src/v1alpha/data_store_service_client.d.ts +1060 -0
  18. package/build/src/v1alpha/data_store_service_client.js +1431 -0
  19. package/build/src/v1alpha/data_store_service_client_config.json +46 -0
  20. package/build/src/v1alpha/document_service_client.d.ts +117 -0
  21. package/build/src/v1alpha/document_service_client.js +162 -0
  22. package/build/src/v1alpha/engine_service_client.d.ts +1079 -0
  23. package/build/src/v1alpha/engine_service_client.js +1481 -0
  24. package/build/src/v1alpha/engine_service_client_config.json +58 -0
  25. package/build/src/v1alpha/index.d.ts +2 -0
  26. package/build/src/v1alpha/index.js +5 -1
  27. package/build/src/v1alpha/recommendation_service_client.d.ts +126 -3
  28. package/build/src/v1alpha/recommendation_service_client.js +162 -0
  29. package/build/src/v1alpha/schema_service_client.d.ts +42 -0
  30. package/build/src/v1alpha/schema_service_client.js +58 -0
  31. package/build/src/v1alpha/search_service_client.d.ts +195 -9
  32. package/build/src/v1alpha/search_service_client.js +214 -6
  33. package/build/src/v1alpha/site_search_engine_service_client.d.ts +117 -0
  34. package/build/src/v1alpha/site_search_engine_service_client.js +162 -0
  35. package/build/src/v1alpha/user_event_service_client.d.ts +42 -0
  36. package/build/src/v1alpha/user_event_service_client.js +58 -0
  37. package/package.json +3 -3
@@ -0,0 +1,1060 @@
1
+ /// <reference types="node" />
2
+ import type * as gax from 'google-gax';
3
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
4
+ import { Transform } from 'stream';
5
+ import * as protos from '../../protos/protos';
6
+ /**
7
+ * Service for managing
8
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore} configuration.
9
+ * @class
10
+ * @memberof v1alpha
11
+ */
12
+ export declare class DataStoreServiceClient {
13
+ private _terminated;
14
+ private _opts;
15
+ private _providedCustomServicePath;
16
+ private _gaxModule;
17
+ private _gaxGrpc;
18
+ private _protos;
19
+ private _defaults;
20
+ auth: gax.GoogleAuth;
21
+ descriptors: Descriptors;
22
+ warn: (code: string, message: string, warnType?: string) => void;
23
+ innerApiCalls: {
24
+ [name: string]: Function;
25
+ };
26
+ locationsClient: LocationsClient;
27
+ pathTemplates: {
28
+ [name: string]: gax.PathTemplate;
29
+ };
30
+ operationsClient: gax.OperationsClient;
31
+ dataStoreServiceStub?: Promise<{
32
+ [name: string]: Function;
33
+ }>;
34
+ /**
35
+ * Construct an instance of DataStoreServiceClient.
36
+ *
37
+ * @param {object} [options] - The configuration object.
38
+ * The options accepted by the constructor are described in detail
39
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
40
+ * The common options are:
41
+ * @param {object} [options.credentials] - Credentials object.
42
+ * @param {string} [options.credentials.client_email]
43
+ * @param {string} [options.credentials.private_key]
44
+ * @param {string} [options.email] - Account email address. Required when
45
+ * using a .pem or .p12 keyFilename.
46
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
47
+ * .p12 key downloaded from the Google Developers Console. If you provide
48
+ * a path to a JSON file, the projectId option below is not necessary.
49
+ * NOTE: .pem and .p12 require you to specify options.email as well.
50
+ * @param {number} [options.port] - The port on which to connect to
51
+ * the remote host.
52
+ * @param {string} [options.projectId] - The project ID from the Google
53
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
54
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
55
+ * app is running in an environment which supports
56
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
57
+ * your project ID will be detected automatically.
58
+ * @param {string} [options.apiEndpoint] - The domain name of the
59
+ * API remote host.
60
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
61
+ * Follows the structure of {@link gapicConfig}.
62
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
63
+ * For more information, please check the
64
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
65
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
66
+ * need to avoid loading the default gRPC version and want to use the fallback
67
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
68
+ * ```
69
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
70
+ * const client = new DataStoreServiceClient({fallback: true}, gax);
71
+ * ```
72
+ */
73
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
74
+ /**
75
+ * Initialize the client.
76
+ * Performs asynchronous operations (such as authentication) and prepares the client.
77
+ * This function will be called automatically when any class method is called for the
78
+ * first time, but if you need to initialize it before calling an actual method,
79
+ * feel free to call initialize() directly.
80
+ *
81
+ * You can await on this method if you want to make sure the client is initialized.
82
+ *
83
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
84
+ */
85
+ initialize(): Promise<{
86
+ [name: string]: Function;
87
+ }>;
88
+ /**
89
+ * The DNS address for this API service.
90
+ * @returns {string} The DNS address for this service.
91
+ */
92
+ static get servicePath(): string;
93
+ /**
94
+ * The DNS address for this API service - same as servicePath(),
95
+ * exists for compatibility reasons.
96
+ * @returns {string} The DNS address for this service.
97
+ */
98
+ static get apiEndpoint(): string;
99
+ /**
100
+ * The port for this API service.
101
+ * @returns {number} The default port for this service.
102
+ */
103
+ static get port(): number;
104
+ /**
105
+ * The scopes needed to make gRPC calls for every method defined
106
+ * in this service.
107
+ * @returns {string[]} List of default scopes.
108
+ */
109
+ static get scopes(): string[];
110
+ getProjectId(): Promise<string>;
111
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
112
+ /**
113
+ * Gets a {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
114
+ *
115
+ * @param {Object} request
116
+ * The request object that will be sent.
117
+ * @param {string} request.name
118
+ * Required. Full resource name of
119
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}, such as
120
+ * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
121
+ *
122
+ * If the caller does not have permission to access the
123
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}, regardless of
124
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
125
+ *
126
+ * If the requested
127
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore} does not exist,
128
+ * a NOT_FOUND error is returned.
129
+ * @param {object} [options]
130
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
131
+ * @returns {Promise} - The promise which resolves to an array.
132
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
133
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
134
+ * for more details and examples.
135
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.get_data_store.js</caption>
136
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_GetDataStore_async
137
+ */
138
+ getDataStore(request?: protos.google.cloud.discoveryengine.v1alpha.IGetDataStoreRequest, options?: CallOptions): Promise<[
139
+ protos.google.cloud.discoveryengine.v1alpha.IDataStore,
140
+ (protos.google.cloud.discoveryengine.v1alpha.IGetDataStoreRequest | undefined),
141
+ {} | undefined
142
+ ]>;
143
+ getDataStore(request: protos.google.cloud.discoveryengine.v1alpha.IGetDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.IGetDataStoreRequest | null | undefined, {} | null | undefined>): void;
144
+ getDataStore(request: protos.google.cloud.discoveryengine.v1alpha.IGetDataStoreRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.IGetDataStoreRequest | null | undefined, {} | null | undefined>): void;
145
+ /**
146
+ * Updates a {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}
147
+ *
148
+ * @param {Object} request
149
+ * The request object that will be sent.
150
+ * @param {google.cloud.discoveryengine.v1alpha.DataStore} request.dataStore
151
+ * Required. The {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}
152
+ * to update.
153
+ *
154
+ * If the caller does not have permission to update the
155
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}, regardless of
156
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
157
+ *
158
+ * If the {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore} to
159
+ * update does not exist, a NOT_FOUND error is returned.
160
+ * @param {google.protobuf.FieldMask} request.updateMask
161
+ * Indicates which fields in the provided
162
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore} to update.
163
+ *
164
+ * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
165
+ * is returned.
166
+ * @param {object} [options]
167
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
168
+ * @returns {Promise} - The promise which resolves to an array.
169
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
170
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
171
+ * for more details and examples.
172
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.update_data_store.js</caption>
173
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_UpdateDataStore_async
174
+ */
175
+ updateDataStore(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateDataStoreRequest, options?: CallOptions): Promise<[
176
+ protos.google.cloud.discoveryengine.v1alpha.IDataStore,
177
+ (protos.google.cloud.discoveryengine.v1alpha.IUpdateDataStoreRequest | undefined),
178
+ {} | undefined
179
+ ]>;
180
+ updateDataStore(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDataStoreRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.IUpdateDataStoreRequest | null | undefined, {} | null | undefined>): void;
181
+ updateDataStore(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateDataStoreRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.IUpdateDataStoreRequest | null | undefined, {} | null | undefined>): void;
182
+ /**
183
+ * Creates a {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
184
+ *
185
+ * DataStore is for storing
186
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Document|Documents}. To serve these
187
+ * documents for Search, or Recommendation use case, an
188
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} needs to be created
189
+ * separately.
190
+ *
191
+ * @param {Object} request
192
+ * The request object that will be sent.
193
+ * @param {string} request.parent
194
+ * Required. The parent resource name, such as
195
+ * `projects/{project}/locations/{location}/collections/{collection}`.
196
+ * @param {google.cloud.discoveryengine.v1alpha.DataStore} request.dataStore
197
+ * Required. The {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}
198
+ * to create.
199
+ * @param {string} request.dataStoreId
200
+ * Required. The ID to use for the
201
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}, which will
202
+ * become the final component of the
203
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}'s resource
204
+ * name.
205
+ *
206
+ * This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
207
+ * standard with a length limit of 63 characters. Otherwise, an
208
+ * INVALID_ARGUMENT error is returned.
209
+ * @param {boolean} request.createAdvancedSiteSearch
210
+ * A boolean flag indicating whether user want to directly create an advanced
211
+ * data store for site search.
212
+ * If the data store is not configured as site
213
+ * search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will
214
+ * be ignored.
215
+ * @param {object} [options]
216
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
217
+ * @returns {Promise} - The promise which resolves to an array.
218
+ * The first element of the array is an object representing
219
+ * a long running operation. Its `promise()` method returns a promise
220
+ * you can `await` for.
221
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
222
+ * for more details and examples.
223
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.create_data_store.js</caption>
224
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_CreateDataStore_async
225
+ */
226
+ createDataStore(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateDataStoreRequest, options?: CallOptions): Promise<[
227
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.ICreateDataStoreMetadata>,
228
+ protos.google.longrunning.IOperation | undefined,
229
+ {} | undefined
230
+ ]>;
231
+ createDataStore(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.ICreateDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
232
+ createDataStore(request: protos.google.cloud.discoveryengine.v1alpha.ICreateDataStoreRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IDataStore, protos.google.cloud.discoveryengine.v1alpha.ICreateDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
233
+ /**
234
+ * Check the status of the long running operation returned by `createDataStore()`.
235
+ * @param {String} name
236
+ * The operation name that will be passed.
237
+ * @returns {Promise} - The promise which resolves to an object.
238
+ * The decoded operation object has result and metadata field to get information from.
239
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
240
+ * for more details and examples.
241
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.create_data_store.js</caption>
242
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_CreateDataStore_async
243
+ */
244
+ checkCreateDataStoreProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.DataStore, protos.google.cloud.discoveryengine.v1alpha.CreateDataStoreMetadata>>;
245
+ /**
246
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
247
+ *
248
+ * @param {Object} request
249
+ * The request object that will be sent.
250
+ * @param {string} request.name
251
+ * Required. Full resource name of
252
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}, such as
253
+ * `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
254
+ *
255
+ * If the caller does not have permission to delete the
256
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}, regardless of
257
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
258
+ *
259
+ * If the {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore} to
260
+ * delete does not exist, a NOT_FOUND error is returned.
261
+ * @param {object} [options]
262
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
263
+ * @returns {Promise} - The promise which resolves to an array.
264
+ * The first element of the array is an object representing
265
+ * a long running operation. Its `promise()` method returns a promise
266
+ * you can `await` for.
267
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
268
+ * for more details and examples.
269
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.delete_data_store.js</caption>
270
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_DeleteDataStore_async
271
+ */
272
+ deleteDataStore(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteDataStoreRequest, options?: CallOptions): Promise<[
273
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDataStoreMetadata>,
274
+ protos.google.longrunning.IOperation | undefined,
275
+ {} | undefined
276
+ ]>;
277
+ deleteDataStore(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDataStoreRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
278
+ deleteDataStore(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteDataStoreRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteDataStoreMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
279
+ /**
280
+ * Check the status of the long running operation returned by `deleteDataStore()`.
281
+ * @param {String} name
282
+ * The operation name that will be passed.
283
+ * @returns {Promise} - The promise which resolves to an object.
284
+ * The decoded operation object has result and metadata field to get information from.
285
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
286
+ * for more details and examples.
287
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.delete_data_store.js</caption>
288
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_DeleteDataStore_async
289
+ */
290
+ checkDeleteDataStoreProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteDataStoreMetadata>>;
291
+ /**
292
+ * Lists all the {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}s
293
+ * associated with the project.
294
+ *
295
+ * @param {Object} request
296
+ * The request object that will be sent.
297
+ * @param {string} request.parent
298
+ * Required. The parent branch resource name, such as
299
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
300
+ *
301
+ * If the caller does not have permission to list {@link protos.|DataStores}s under this
302
+ * location, regardless of whether or not this data store exists, a
303
+ * PERMISSION_DENIED error is returned.
304
+ * @param {number} request.pageSize
305
+ * Maximum number of
306
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}s to return. If
307
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
308
+ * 50 will be coerced to 50.
309
+ *
310
+ * If this field is negative, an INVALID_ARGUMENT is returned.
311
+ * @param {string} request.pageToken
312
+ * A page token
313
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
314
+ * received from a previous
315
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
316
+ * call. Provide this to retrieve the subsequent page.
317
+ *
318
+ * When paginating, all other parameters provided to
319
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
320
+ * must match the call that provided the page token. Otherwise, an
321
+ * INVALID_ARGUMENT error is returned.
322
+ * @param {string} request.filter
323
+ * Filter by solution type. For example: filter =
324
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
325
+ * @param {object} [options]
326
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
327
+ * @returns {Promise} - The promise which resolves to an array.
328
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}.
329
+ * The client library will perform auto-pagination by default: it will call the API as many
330
+ * times as needed and will merge results from all the pages into this array.
331
+ * Note that it can affect your quota.
332
+ * We recommend using `listDataStoresAsync()`
333
+ * method described below for async iteration which you can stop as needed.
334
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
335
+ * for more details and examples.
336
+ */
337
+ listDataStores(request?: protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, options?: CallOptions): Promise<[
338
+ protos.google.cloud.discoveryengine.v1alpha.IDataStore[],
339
+ protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest | null,
340
+ protos.google.cloud.discoveryengine.v1alpha.IListDataStoresResponse
341
+ ]>;
342
+ listDataStores(request: protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, protos.google.cloud.discoveryengine.v1alpha.IListDataStoresResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IDataStore>): void;
343
+ listDataStores(request: protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, protos.google.cloud.discoveryengine.v1alpha.IListDataStoresResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IDataStore>): void;
344
+ /**
345
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
346
+ * @param {Object} request
347
+ * The request object that will be sent.
348
+ * @param {string} request.parent
349
+ * Required. The parent branch resource name, such as
350
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
351
+ *
352
+ * If the caller does not have permission to list {@link protos.|DataStores}s under this
353
+ * location, regardless of whether or not this data store exists, a
354
+ * PERMISSION_DENIED error is returned.
355
+ * @param {number} request.pageSize
356
+ * Maximum number of
357
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}s to return. If
358
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
359
+ * 50 will be coerced to 50.
360
+ *
361
+ * If this field is negative, an INVALID_ARGUMENT is returned.
362
+ * @param {string} request.pageToken
363
+ * A page token
364
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
365
+ * received from a previous
366
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
367
+ * call. Provide this to retrieve the subsequent page.
368
+ *
369
+ * When paginating, all other parameters provided to
370
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
371
+ * must match the call that provided the page token. Otherwise, an
372
+ * INVALID_ARGUMENT error is returned.
373
+ * @param {string} request.filter
374
+ * Filter by solution type. For example: filter =
375
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
376
+ * @param {object} [options]
377
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
378
+ * @returns {Stream}
379
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore} on 'data' event.
380
+ * The client library will perform auto-pagination by default: it will call the API as many
381
+ * times as needed. Note that it can affect your quota.
382
+ * We recommend using `listDataStoresAsync()`
383
+ * method described below for async iteration which you can stop as needed.
384
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
385
+ * for more details and examples.
386
+ */
387
+ listDataStoresStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, options?: CallOptions): Transform;
388
+ /**
389
+ * Equivalent to `listDataStores`, but returns an iterable object.
390
+ *
391
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
392
+ * @param {Object} request
393
+ * The request object that will be sent.
394
+ * @param {string} request.parent
395
+ * Required. The parent branch resource name, such as
396
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
397
+ *
398
+ * If the caller does not have permission to list {@link protos.|DataStores}s under this
399
+ * location, regardless of whether or not this data store exists, a
400
+ * PERMISSION_DENIED error is returned.
401
+ * @param {number} request.pageSize
402
+ * Maximum number of
403
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}s to return. If
404
+ * unspecified, defaults to 10. The maximum allowed value is 50. Values above
405
+ * 50 will be coerced to 50.
406
+ *
407
+ * If this field is negative, an INVALID_ARGUMENT is returned.
408
+ * @param {string} request.pageToken
409
+ * A page token
410
+ * {@link protos.google.cloud.discoveryengine.v1alpha.ListDataStoresResponse.next_page_token|ListDataStoresResponse.next_page_token},
411
+ * received from a previous
412
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
413
+ * call. Provide this to retrieve the subsequent page.
414
+ *
415
+ * When paginating, all other parameters provided to
416
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStoreService.ListDataStores|DataStoreService.ListDataStores}
417
+ * must match the call that provided the page token. Otherwise, an
418
+ * INVALID_ARGUMENT error is returned.
419
+ * @param {string} request.filter
420
+ * Filter by solution type. For example: filter =
421
+ * 'solution_type:SOLUTION_TYPE_SEARCH'
422
+ * @param {object} [options]
423
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
424
+ * @returns {Object}
425
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
426
+ * When you iterate the returned iterable, each element will be an object representing
427
+ * {@link protos.google.cloud.discoveryengine.v1alpha.DataStore|DataStore}. The API will be called under the hood as needed, once per the page,
428
+ * so you can stop the iteration when you don't need more results.
429
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
430
+ * for more details and examples.
431
+ * @example <caption>include:samples/generated/v1alpha/data_store_service.list_data_stores.js</caption>
432
+ * region_tag:discoveryengine_v1alpha_generated_DataStoreService_ListDataStores_async
433
+ */
434
+ listDataStoresAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListDataStoresRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IDataStore>;
435
+ /**
436
+ * Gets information about a location.
437
+ *
438
+ * @param {Object} request
439
+ * The request object that will be sent.
440
+ * @param {string} request.name
441
+ * Resource name for the location.
442
+ * @param {object} [options]
443
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
444
+ * @returns {Promise} - The promise which resolves to an array.
445
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
446
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
447
+ * for more details and examples.
448
+ * @example
449
+ * ```
450
+ * const [response] = await client.getLocation(request);
451
+ * ```
452
+ */
453
+ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>, callback?: Callback<LocationProtos.google.cloud.location.ILocation, LocationProtos.google.cloud.location.IGetLocationRequest | null | undefined, {} | null | undefined>): Promise<LocationProtos.google.cloud.location.ILocation>;
454
+ /**
455
+ * Lists information about the supported locations for this service. Returns an iterable object.
456
+ *
457
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
458
+ * @param {Object} request
459
+ * The request object that will be sent.
460
+ * @param {string} request.name
461
+ * The resource that owns the locations collection, if applicable.
462
+ * @param {string} request.filter
463
+ * The standard list filter.
464
+ * @param {number} request.pageSize
465
+ * The standard list page size.
466
+ * @param {string} request.pageToken
467
+ * The standard list page token.
468
+ * @param {object} [options]
469
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
470
+ * @returns {Object}
471
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
472
+ * When you iterate the returned iterable, each element will be an object representing
473
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
474
+ * so you can stop the iteration when you don't need more results.
475
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
476
+ * for more details and examples.
477
+ * @example
478
+ * ```
479
+ * const iterable = client.listLocationsAsync(request);
480
+ * for await (const response of iterable) {
481
+ * // process response
482
+ * }
483
+ * ```
484
+ */
485
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
486
+ /**
487
+ * Gets the latest state of a long-running operation. Clients can use this
488
+ * method to poll the operation result at intervals as recommended by the API
489
+ * service.
490
+ *
491
+ * @param {Object} request - The request object that will be sent.
492
+ * @param {string} request.name - The name of the operation resource.
493
+ * @param {Object=} options
494
+ * Optional parameters. You can override the default settings for this call,
495
+ * e.g, timeout, retries, paginations, etc. See {@link
496
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
497
+ * for the details.
498
+ * @param {function(?Error, ?Object)=} callback
499
+ * The function which will be called with the result of the API call.
500
+ *
501
+ * The second parameter to the callback is an object representing
502
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
503
+ * @return {Promise} - The promise which resolves to an array.
504
+ * The first element of the array is an object representing
505
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
506
+ * The promise has a method named "cancel" which cancels the ongoing API call.
507
+ *
508
+ * @example
509
+ * ```
510
+ * const client = longrunning.operationsClient();
511
+ * const name = '';
512
+ * const [response] = await client.getOperation({name});
513
+ * // doThingsWith(response)
514
+ * ```
515
+ */
516
+ 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]>;
517
+ /**
518
+ * Lists operations that match the specified filter in the request. If the
519
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
520
+ *
521
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
522
+ *
523
+ * @param {Object} request - The request object that will be sent.
524
+ * @param {string} request.name - The name of the operation collection.
525
+ * @param {string} request.filter - The standard list filter.
526
+ * @param {number=} request.pageSize -
527
+ * The maximum number of resources contained in the underlying API
528
+ * response. If page streaming is performed per-resource, this
529
+ * parameter does not affect the return value. If page streaming is
530
+ * performed per-page, this determines the maximum number of
531
+ * resources in a page.
532
+ * @param {Object=} options
533
+ * Optional parameters. You can override the default settings for this call,
534
+ * e.g, timeout, retries, paginations, etc. See {@link
535
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
536
+ * details.
537
+ * @returns {Object}
538
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
539
+ *
540
+ * @example
541
+ * ```
542
+ * const client = longrunning.operationsClient();
543
+ * for await (const response of client.listOperationsAsync(request));
544
+ * // doThingsWith(response)
545
+ * ```
546
+ */
547
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
548
+ /**
549
+ * Starts asynchronous cancellation on a long-running operation. The server
550
+ * makes a best effort to cancel the operation, but success is not
551
+ * guaranteed. If the server doesn't support this method, it returns
552
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
553
+ * {@link Operations.GetOperation} or
554
+ * other methods to check whether the cancellation succeeded or whether the
555
+ * operation completed despite cancellation. On successful cancellation,
556
+ * the operation is not deleted; instead, it becomes an operation with
557
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
558
+ * 1, corresponding to `Code.CANCELLED`.
559
+ *
560
+ * @param {Object} request - The request object that will be sent.
561
+ * @param {string} request.name - The name of the operation resource to be cancelled.
562
+ * @param {Object=} options
563
+ * Optional parameters. You can override the default settings for this call,
564
+ * e.g, timeout, retries, paginations, etc. See {@link
565
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
566
+ * details.
567
+ * @param {function(?Error)=} callback
568
+ * The function which will be called with the result of the API call.
569
+ * @return {Promise} - The promise which resolves when API call finishes.
570
+ * The promise has a method named "cancel" which cancels the ongoing API
571
+ * call.
572
+ *
573
+ * @example
574
+ * ```
575
+ * const client = longrunning.operationsClient();
576
+ * await client.cancelOperation({name: ''});
577
+ * ```
578
+ */
579
+ 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>;
580
+ /**
581
+ * Deletes a long-running operation. This method indicates that the client is
582
+ * no longer interested in the operation result. It does not cancel the
583
+ * operation. If the server doesn't support this method, it returns
584
+ * `google.rpc.Code.UNIMPLEMENTED`.
585
+ *
586
+ * @param {Object} request - The request object that will be sent.
587
+ * @param {string} request.name - The name of the operation resource to be deleted.
588
+ * @param {Object=} options
589
+ * Optional parameters. You can override the default settings for this call,
590
+ * e.g, timeout, retries, paginations, etc. See {@link
591
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
592
+ * for the details.
593
+ * @param {function(?Error)=} callback
594
+ * The function which will be called with the result of the API call.
595
+ * @return {Promise} - The promise which resolves when API call finishes.
596
+ * The promise has a method named "cancel" which cancels the ongoing API
597
+ * call.
598
+ *
599
+ * @example
600
+ * ```
601
+ * const client = longrunning.operationsClient();
602
+ * await client.deleteOperation({name: ''});
603
+ * ```
604
+ */
605
+ 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>;
606
+ /**
607
+ * Return a fully-qualified collection resource name string.
608
+ *
609
+ * @param {string} project
610
+ * @param {string} location
611
+ * @param {string} collection
612
+ * @returns {string} Resource name string.
613
+ */
614
+ collectionPath(project: string, location: string, collection: string): string;
615
+ /**
616
+ * Parse the project from Collection resource.
617
+ *
618
+ * @param {string} collectionName
619
+ * A fully-qualified path representing Collection resource.
620
+ * @returns {string} A string representing the project.
621
+ */
622
+ matchProjectFromCollectionName(collectionName: string): string | number;
623
+ /**
624
+ * Parse the location from Collection resource.
625
+ *
626
+ * @param {string} collectionName
627
+ * A fully-qualified path representing Collection resource.
628
+ * @returns {string} A string representing the location.
629
+ */
630
+ matchLocationFromCollectionName(collectionName: string): string | number;
631
+ /**
632
+ * Parse the collection from Collection resource.
633
+ *
634
+ * @param {string} collectionName
635
+ * A fully-qualified path representing Collection resource.
636
+ * @returns {string} A string representing the collection.
637
+ */
638
+ matchCollectionFromCollectionName(collectionName: string): string | number;
639
+ /**
640
+ * Return a fully-qualified engine resource name string.
641
+ *
642
+ * @param {string} project
643
+ * @param {string} location
644
+ * @param {string} collection
645
+ * @param {string} engine
646
+ * @returns {string} Resource name string.
647
+ */
648
+ enginePath(project: string, location: string, collection: string, engine: string): string;
649
+ /**
650
+ * Parse the project from Engine resource.
651
+ *
652
+ * @param {string} engineName
653
+ * A fully-qualified path representing Engine resource.
654
+ * @returns {string} A string representing the project.
655
+ */
656
+ matchProjectFromEngineName(engineName: string): string | number;
657
+ /**
658
+ * Parse the location from Engine resource.
659
+ *
660
+ * @param {string} engineName
661
+ * A fully-qualified path representing Engine resource.
662
+ * @returns {string} A string representing the location.
663
+ */
664
+ matchLocationFromEngineName(engineName: string): string | number;
665
+ /**
666
+ * Parse the collection from Engine resource.
667
+ *
668
+ * @param {string} engineName
669
+ * A fully-qualified path representing Engine resource.
670
+ * @returns {string} A string representing the collection.
671
+ */
672
+ matchCollectionFromEngineName(engineName: string): string | number;
673
+ /**
674
+ * Parse the engine from Engine resource.
675
+ *
676
+ * @param {string} engineName
677
+ * A fully-qualified path representing Engine resource.
678
+ * @returns {string} A string representing the engine.
679
+ */
680
+ matchEngineFromEngineName(engineName: string): string | number;
681
+ /**
682
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
683
+ *
684
+ * @param {string} project
685
+ * @param {string} location
686
+ * @param {string} collection
687
+ * @param {string} data_store
688
+ * @returns {string} Resource name string.
689
+ */
690
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
691
+ /**
692
+ * Parse the project from ProjectLocationCollectionDataStore resource.
693
+ *
694
+ * @param {string} projectLocationCollectionDataStoreName
695
+ * A fully-qualified path representing project_location_collection_data_store resource.
696
+ * @returns {string} A string representing the project.
697
+ */
698
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
699
+ /**
700
+ * Parse the location from ProjectLocationCollectionDataStore resource.
701
+ *
702
+ * @param {string} projectLocationCollectionDataStoreName
703
+ * A fully-qualified path representing project_location_collection_data_store resource.
704
+ * @returns {string} A string representing the location.
705
+ */
706
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
707
+ /**
708
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
709
+ *
710
+ * @param {string} projectLocationCollectionDataStoreName
711
+ * A fully-qualified path representing project_location_collection_data_store resource.
712
+ * @returns {string} A string representing the collection.
713
+ */
714
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
715
+ /**
716
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
717
+ *
718
+ * @param {string} projectLocationCollectionDataStoreName
719
+ * A fully-qualified path representing project_location_collection_data_store resource.
720
+ * @returns {string} A string representing the data_store.
721
+ */
722
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
723
+ /**
724
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
725
+ *
726
+ * @param {string} project
727
+ * @param {string} location
728
+ * @param {string} collection
729
+ * @param {string} data_store
730
+ * @param {string} branch
731
+ * @param {string} document
732
+ * @returns {string} Resource name string.
733
+ */
734
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
735
+ /**
736
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
737
+ *
738
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
739
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
740
+ * @returns {string} A string representing the project.
741
+ */
742
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
743
+ /**
744
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
745
+ *
746
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
747
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
748
+ * @returns {string} A string representing the location.
749
+ */
750
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
751
+ /**
752
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
753
+ *
754
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
755
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
756
+ * @returns {string} A string representing the collection.
757
+ */
758
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
759
+ /**
760
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
761
+ *
762
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
763
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
764
+ * @returns {string} A string representing the data_store.
765
+ */
766
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
767
+ /**
768
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
769
+ *
770
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
771
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
772
+ * @returns {string} A string representing the branch.
773
+ */
774
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
775
+ /**
776
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
777
+ *
778
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
779
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
780
+ * @returns {string} A string representing the document.
781
+ */
782
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
783
+ /**
784
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
785
+ *
786
+ * @param {string} project
787
+ * @param {string} location
788
+ * @param {string} collection
789
+ * @param {string} data_store
790
+ * @param {string} conversation
791
+ * @returns {string} Resource name string.
792
+ */
793
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
794
+ /**
795
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
796
+ *
797
+ * @param {string} projectLocationCollectionDataStoreConversationName
798
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
799
+ * @returns {string} A string representing the project.
800
+ */
801
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
802
+ /**
803
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
804
+ *
805
+ * @param {string} projectLocationCollectionDataStoreConversationName
806
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
807
+ * @returns {string} A string representing the location.
808
+ */
809
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
810
+ /**
811
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
812
+ *
813
+ * @param {string} projectLocationCollectionDataStoreConversationName
814
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
815
+ * @returns {string} A string representing the collection.
816
+ */
817
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
818
+ /**
819
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
820
+ *
821
+ * @param {string} projectLocationCollectionDataStoreConversationName
822
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
823
+ * @returns {string} A string representing the data_store.
824
+ */
825
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
826
+ /**
827
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
828
+ *
829
+ * @param {string} projectLocationCollectionDataStoreConversationName
830
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
831
+ * @returns {string} A string representing the conversation.
832
+ */
833
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
834
+ /**
835
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
836
+ *
837
+ * @param {string} project
838
+ * @param {string} location
839
+ * @param {string} collection
840
+ * @param {string} data_store
841
+ * @param {string} schema
842
+ * @returns {string} Resource name string.
843
+ */
844
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
845
+ /**
846
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
847
+ *
848
+ * @param {string} projectLocationCollectionDataStoreSchemaName
849
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
850
+ * @returns {string} A string representing the project.
851
+ */
852
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
853
+ /**
854
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
855
+ *
856
+ * @param {string} projectLocationCollectionDataStoreSchemaName
857
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
858
+ * @returns {string} A string representing the location.
859
+ */
860
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
861
+ /**
862
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
863
+ *
864
+ * @param {string} projectLocationCollectionDataStoreSchemaName
865
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
866
+ * @returns {string} A string representing the collection.
867
+ */
868
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
869
+ /**
870
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
871
+ *
872
+ * @param {string} projectLocationCollectionDataStoreSchemaName
873
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
874
+ * @returns {string} A string representing the data_store.
875
+ */
876
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
877
+ /**
878
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
879
+ *
880
+ * @param {string} projectLocationCollectionDataStoreSchemaName
881
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
882
+ * @returns {string} A string representing the schema.
883
+ */
884
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
885
+ /**
886
+ * Return a fully-qualified projectLocationDataStore resource name string.
887
+ *
888
+ * @param {string} project
889
+ * @param {string} location
890
+ * @param {string} data_store
891
+ * @returns {string} Resource name string.
892
+ */
893
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
894
+ /**
895
+ * Parse the project from ProjectLocationDataStore resource.
896
+ *
897
+ * @param {string} projectLocationDataStoreName
898
+ * A fully-qualified path representing project_location_data_store resource.
899
+ * @returns {string} A string representing the project.
900
+ */
901
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
902
+ /**
903
+ * Parse the location from ProjectLocationDataStore resource.
904
+ *
905
+ * @param {string} projectLocationDataStoreName
906
+ * A fully-qualified path representing project_location_data_store resource.
907
+ * @returns {string} A string representing the location.
908
+ */
909
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
910
+ /**
911
+ * Parse the data_store from ProjectLocationDataStore resource.
912
+ *
913
+ * @param {string} projectLocationDataStoreName
914
+ * A fully-qualified path representing project_location_data_store resource.
915
+ * @returns {string} A string representing the data_store.
916
+ */
917
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
918
+ /**
919
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
920
+ *
921
+ * @param {string} project
922
+ * @param {string} location
923
+ * @param {string} data_store
924
+ * @param {string} branch
925
+ * @param {string} document
926
+ * @returns {string} Resource name string.
927
+ */
928
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
929
+ /**
930
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
931
+ *
932
+ * @param {string} projectLocationDataStoreBranchDocumentName
933
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
934
+ * @returns {string} A string representing the project.
935
+ */
936
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
937
+ /**
938
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
939
+ *
940
+ * @param {string} projectLocationDataStoreBranchDocumentName
941
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
942
+ * @returns {string} A string representing the location.
943
+ */
944
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
945
+ /**
946
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
947
+ *
948
+ * @param {string} projectLocationDataStoreBranchDocumentName
949
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
950
+ * @returns {string} A string representing the data_store.
951
+ */
952
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
953
+ /**
954
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
955
+ *
956
+ * @param {string} projectLocationDataStoreBranchDocumentName
957
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
958
+ * @returns {string} A string representing the branch.
959
+ */
960
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
961
+ /**
962
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
963
+ *
964
+ * @param {string} projectLocationDataStoreBranchDocumentName
965
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
966
+ * @returns {string} A string representing the document.
967
+ */
968
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
969
+ /**
970
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
971
+ *
972
+ * @param {string} project
973
+ * @param {string} location
974
+ * @param {string} data_store
975
+ * @param {string} conversation
976
+ * @returns {string} Resource name string.
977
+ */
978
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
979
+ /**
980
+ * Parse the project from ProjectLocationDataStoreConversation resource.
981
+ *
982
+ * @param {string} projectLocationDataStoreConversationName
983
+ * A fully-qualified path representing project_location_data_store_conversation resource.
984
+ * @returns {string} A string representing the project.
985
+ */
986
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
987
+ /**
988
+ * Parse the location from ProjectLocationDataStoreConversation resource.
989
+ *
990
+ * @param {string} projectLocationDataStoreConversationName
991
+ * A fully-qualified path representing project_location_data_store_conversation resource.
992
+ * @returns {string} A string representing the location.
993
+ */
994
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
995
+ /**
996
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
997
+ *
998
+ * @param {string} projectLocationDataStoreConversationName
999
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1000
+ * @returns {string} A string representing the data_store.
1001
+ */
1002
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1003
+ /**
1004
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1005
+ *
1006
+ * @param {string} projectLocationDataStoreConversationName
1007
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1008
+ * @returns {string} A string representing the conversation.
1009
+ */
1010
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1011
+ /**
1012
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1013
+ *
1014
+ * @param {string} project
1015
+ * @param {string} location
1016
+ * @param {string} data_store
1017
+ * @param {string} schema
1018
+ * @returns {string} Resource name string.
1019
+ */
1020
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
1021
+ /**
1022
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1023
+ *
1024
+ * @param {string} projectLocationDataStoreSchemaName
1025
+ * A fully-qualified path representing project_location_data_store_schema resource.
1026
+ * @returns {string} A string representing the project.
1027
+ */
1028
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1029
+ /**
1030
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1031
+ *
1032
+ * @param {string} projectLocationDataStoreSchemaName
1033
+ * A fully-qualified path representing project_location_data_store_schema resource.
1034
+ * @returns {string} A string representing the location.
1035
+ */
1036
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1037
+ /**
1038
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1039
+ *
1040
+ * @param {string} projectLocationDataStoreSchemaName
1041
+ * A fully-qualified path representing project_location_data_store_schema resource.
1042
+ * @returns {string} A string representing the data_store.
1043
+ */
1044
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1045
+ /**
1046
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1047
+ *
1048
+ * @param {string} projectLocationDataStoreSchemaName
1049
+ * A fully-qualified path representing project_location_data_store_schema resource.
1050
+ * @returns {string} A string representing the schema.
1051
+ */
1052
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1053
+ /**
1054
+ * Terminate the gRPC channel and close the client.
1055
+ *
1056
+ * The client will no longer be usable and all future behavior is undefined.
1057
+ * @returns {Promise} A promise that resolves when the client is closed.
1058
+ */
1059
+ close(): Promise<void>;
1060
+ }