@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,1079 @@
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 {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}
8
+ * configuration.
9
+ * @class
10
+ * @memberof v1alpha
11
+ */
12
+ export declare class EngineServiceClient {
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
+ engineServiceStub?: Promise<{
32
+ [name: string]: Function;
33
+ }>;
34
+ /**
35
+ * Construct an instance of EngineServiceClient.
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 EngineServiceClient({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
+ * Updates an {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}
114
+ *
115
+ * @param {Object} request
116
+ * The request object that will be sent.
117
+ * @param {google.cloud.discoveryengine.v1alpha.Engine} request.engine
118
+ * Required. The {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} to
119
+ * update.
120
+ *
121
+ * If the caller does not have permission to update the
122
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}, regardless of
123
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
124
+ *
125
+ * If the {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} to update does
126
+ * not exist, a NOT_FOUND error is returned.
127
+ * @param {google.protobuf.FieldMask} request.updateMask
128
+ * Indicates which fields in the provided
129
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} to update.
130
+ *
131
+ * If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
132
+ * is returned.
133
+ * @param {object} [options]
134
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
135
+ * @returns {Promise} - The promise which resolves to an array.
136
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
137
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
138
+ * for more details and examples.
139
+ * @example <caption>include:samples/generated/v1alpha/engine_service.update_engine.js</caption>
140
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_UpdateEngine_async
141
+ */
142
+ updateEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest, options?: CallOptions): Promise<[
143
+ protos.google.cloud.discoveryengine.v1alpha.IEngine,
144
+ (protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest | undefined),
145
+ {} | undefined
146
+ ]>;
147
+ updateEngine(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest | null | undefined, {} | null | undefined>): void;
148
+ updateEngine(request: protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IUpdateEngineRequest | null | undefined, {} | null | undefined>): void;
149
+ /**
150
+ * Gets a {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
151
+ *
152
+ * @param {Object} request
153
+ * The request object that will be sent.
154
+ * @param {string} request.name
155
+ * Required. Full resource name of
156
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}, such as
157
+ * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
158
+ * @param {object} [options]
159
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
160
+ * @returns {Promise} - The promise which resolves to an array.
161
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
162
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
163
+ * for more details and examples.
164
+ * @example <caption>include:samples/generated/v1alpha/engine_service.get_engine.js</caption>
165
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_GetEngine_async
166
+ */
167
+ getEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest, options?: CallOptions): Promise<[
168
+ protos.google.cloud.discoveryengine.v1alpha.IEngine,
169
+ protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest | undefined,
170
+ {} | undefined
171
+ ]>;
172
+ getEngine(request: protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest | null | undefined, {} | null | undefined>): void;
173
+ getEngine(request: protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IGetEngineRequest | null | undefined, {} | null | undefined>): void;
174
+ /**
175
+ * Pauses the training of an existing engine. Only applicable if
176
+ * {@link protos.|solution_type} is
177
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION|SOLUTION_TYPE_RECOMMENDATION}.
178
+ *
179
+ * @param {Object} request
180
+ * The request object that will be sent.
181
+ * @param {string} request.name
182
+ * Required. The name of the engine to pause.
183
+ * Format:
184
+ * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
185
+ * @param {object} [options]
186
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
187
+ * @returns {Promise} - The promise which resolves to an array.
188
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
189
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
190
+ * for more details and examples.
191
+ * @example <caption>include:samples/generated/v1alpha/engine_service.pause_engine.js</caption>
192
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_PauseEngine_async
193
+ */
194
+ pauseEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest, options?: CallOptions): Promise<[
195
+ protos.google.cloud.discoveryengine.v1alpha.IEngine,
196
+ (protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest | undefined),
197
+ {} | undefined
198
+ ]>;
199
+ pauseEngine(request: protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest | null | undefined, {} | null | undefined>): void;
200
+ pauseEngine(request: protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IPauseEngineRequest | null | undefined, {} | null | undefined>): void;
201
+ /**
202
+ * Resumes the training of an existing engine. Only applicable if
203
+ * {@link protos.|solution_type} is
204
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION|SOLUTION_TYPE_RECOMMENDATION}.
205
+ *
206
+ * @param {Object} request
207
+ * The request object that will be sent.
208
+ * @param {string} request.name
209
+ * Required. The name of the engine to resume.
210
+ * Format:
211
+ * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
212
+ * @param {object} [options]
213
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
214
+ * @returns {Promise} - The promise which resolves to an array.
215
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
216
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
217
+ * for more details and examples.
218
+ * @example <caption>include:samples/generated/v1alpha/engine_service.resume_engine.js</caption>
219
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_ResumeEngine_async
220
+ */
221
+ resumeEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest, options?: CallOptions): Promise<[
222
+ protos.google.cloud.discoveryengine.v1alpha.IEngine,
223
+ (protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest | undefined),
224
+ {} | undefined
225
+ ]>;
226
+ resumeEngine(request: protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest | null | undefined, {} | null | undefined>): void;
227
+ resumeEngine(request: protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.IResumeEngineRequest | null | undefined, {} | null | undefined>): void;
228
+ /**
229
+ * Creates a {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
230
+ *
231
+ * @param {Object} request
232
+ * The request object that will be sent.
233
+ * @param {string} request.parent
234
+ * Required. The parent resource name, such as
235
+ * `projects/{project}/locations/{location}/collections/{collection}`.
236
+ * @param {google.cloud.discoveryengine.v1alpha.Engine} request.engine
237
+ * Required. The {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} to
238
+ * create.
239
+ * @param {string} request.engineId
240
+ * Required. The ID to use for the
241
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}, which will become
242
+ * the final component of the
243
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}'s resource name.
244
+ *
245
+ * This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
246
+ * standard with a length limit of 63 characters. Otherwise, an
247
+ * INVALID_ARGUMENT error is returned.
248
+ * @param {object} [options]
249
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
250
+ * @returns {Promise} - The promise which resolves to an array.
251
+ * The first element of the array is an object representing
252
+ * a long running operation. Its `promise()` method returns a promise
253
+ * you can `await` for.
254
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
255
+ * for more details and examples.
256
+ * @example <caption>include:samples/generated/v1alpha/engine_service.create_engine.js</caption>
257
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_CreateEngine_async
258
+ */
259
+ createEngine(request?: protos.google.cloud.discoveryengine.v1alpha.ICreateEngineRequest, options?: CallOptions): Promise<[
260
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>,
261
+ protos.google.longrunning.IOperation | undefined,
262
+ {} | undefined
263
+ ]>;
264
+ createEngine(request: protos.google.cloud.discoveryengine.v1alpha.ICreateEngineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
265
+ createEngine(request: protos.google.cloud.discoveryengine.v1alpha.ICreateEngineRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.IEngine, protos.google.cloud.discoveryengine.v1alpha.ICreateEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
266
+ /**
267
+ * Check the status of the long running operation returned by `createEngine()`.
268
+ * @param {String} name
269
+ * The operation name that will be passed.
270
+ * @returns {Promise} - The promise which resolves to an object.
271
+ * The decoded operation object has result and metadata field to get information from.
272
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
273
+ * for more details and examples.
274
+ * @example <caption>include:samples/generated/v1alpha/engine_service.create_engine.js</caption>
275
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_CreateEngine_async
276
+ */
277
+ checkCreateEngineProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.Engine, protos.google.cloud.discoveryengine.v1alpha.CreateEngineMetadata>>;
278
+ /**
279
+ * Deletes a {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
280
+ *
281
+ * @param {Object} request
282
+ * The request object that will be sent.
283
+ * @param {string} request.name
284
+ * Required. Full resource name of
285
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}, such as
286
+ * `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
287
+ *
288
+ * If the caller does not have permission to delete the
289
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}, regardless of
290
+ * whether or not it exists, a PERMISSION_DENIED error is returned.
291
+ *
292
+ * If the {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} to delete does
293
+ * not exist, a NOT_FOUND error is returned.
294
+ * @param {object} [options]
295
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
296
+ * @returns {Promise} - The promise which resolves to an array.
297
+ * The first element of the array is an object representing
298
+ * a long running operation. Its `promise()` method returns a promise
299
+ * you can `await` for.
300
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
301
+ * for more details and examples.
302
+ * @example <caption>include:samples/generated/v1alpha/engine_service.delete_engine.js</caption>
303
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_DeleteEngine_async
304
+ */
305
+ deleteEngine(request?: protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineRequest, options?: CallOptions): Promise<[
306
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>,
307
+ protos.google.longrunning.IOperation | undefined,
308
+ {} | undefined
309
+ ]>;
310
+ deleteEngine(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
311
+ deleteEngine(request: protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1alpha.IDeleteEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
312
+ /**
313
+ * Check the status of the long running operation returned by `deleteEngine()`.
314
+ * @param {String} name
315
+ * The operation name that will be passed.
316
+ * @returns {Promise} - The promise which resolves to an object.
317
+ * The decoded operation object has result and metadata field to get information from.
318
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
319
+ * for more details and examples.
320
+ * @example <caption>include:samples/generated/v1alpha/engine_service.delete_engine.js</caption>
321
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_DeleteEngine_async
322
+ */
323
+ checkDeleteEngineProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.discoveryengine.v1alpha.DeleteEngineMetadata>>;
324
+ /**
325
+ * Tunes an existing engine. Only applicable if {@link protos.|solution_type} is
326
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SolutionType.SOLUTION_TYPE_RECOMMENDATION|SOLUTION_TYPE_RECOMMENDATION}.
327
+ *
328
+ * @param {Object} request
329
+ * The request object that will be sent.
330
+ * @param {string} request.name
331
+ * Required. The resource name of the engine to tune.
332
+ * Format:
333
+ * `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`
334
+ * @param {object} [options]
335
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
336
+ * @returns {Promise} - The promise which resolves to an array.
337
+ * The first element of the array is an object representing
338
+ * a long running operation. Its `promise()` method returns a promise
339
+ * you can `await` for.
340
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
341
+ * for more details and examples.
342
+ * @example <caption>include:samples/generated/v1alpha/engine_service.tune_engine.js</caption>
343
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_TuneEngine_async
344
+ */
345
+ tuneEngine(request?: protos.google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, options?: CallOptions): Promise<[
346
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>,
347
+ protos.google.longrunning.IOperation | undefined,
348
+ {} | undefined
349
+ ]>;
350
+ tuneEngine(request: protos.google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
351
+ tuneEngine(request: protos.google.cloud.discoveryengine.v1alpha.ITuneEngineRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.ITuneEngineMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
352
+ /**
353
+ * Check the status of the long running operation returned by `tuneEngine()`.
354
+ * @param {String} name
355
+ * The operation name that will be passed.
356
+ * @returns {Promise} - The promise which resolves to an object.
357
+ * The decoded operation object has result and metadata field to get information from.
358
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
359
+ * for more details and examples.
360
+ * @example <caption>include:samples/generated/v1alpha/engine_service.tune_engine.js</caption>
361
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_TuneEngine_async
362
+ */
363
+ checkTuneEngineProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TuneEngineResponse, protos.google.cloud.discoveryengine.v1alpha.TuneEngineMetadata>>;
364
+ /**
365
+ * Lists all the {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}s
366
+ * associated with the project.
367
+ *
368
+ * @param {Object} request
369
+ * The request object that will be sent.
370
+ * @param {string} request.parent
371
+ * Required. The parent resource name, such as
372
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
373
+ * @param {number} [request.pageSize]
374
+ * Optional. Not supported.
375
+ * @param {string} [request.pageToken]
376
+ * Optional. Not supported.
377
+ * @param {string} [request.filter]
378
+ * Optional. Filter by solution type. For example:
379
+ * solution_type=SOLUTION_TYPE_SEARCH
380
+ * @param {object} [options]
381
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
382
+ * @returns {Promise} - The promise which resolves to an array.
383
+ * The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}.
384
+ * The client library will perform auto-pagination by default: it will call the API as many
385
+ * times as needed and will merge results from all the pages into this array.
386
+ * Note that it can affect your quota.
387
+ * We recommend using `listEnginesAsync()`
388
+ * method described below for async iteration which you can stop as needed.
389
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
390
+ * for more details and examples.
391
+ */
392
+ listEngines(request?: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options?: CallOptions): Promise<[
393
+ protos.google.cloud.discoveryengine.v1alpha.IEngine[],
394
+ protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest | null,
395
+ protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse
396
+ ]>;
397
+ listEngines(request: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IEngine>): void;
398
+ listEngines(request: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, callback: PaginationCallback<protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, protos.google.cloud.discoveryengine.v1alpha.IListEnginesResponse | null | undefined, protos.google.cloud.discoveryengine.v1alpha.IEngine>): void;
399
+ /**
400
+ * Equivalent to `method.name.toCamelCase()`, but returns a NodeJS Stream object.
401
+ * @param {Object} request
402
+ * The request object that will be sent.
403
+ * @param {string} request.parent
404
+ * Required. The parent resource name, such as
405
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
406
+ * @param {number} [request.pageSize]
407
+ * Optional. Not supported.
408
+ * @param {string} [request.pageToken]
409
+ * Optional. Not supported.
410
+ * @param {string} [request.filter]
411
+ * Optional. Filter by solution type. For example:
412
+ * solution_type=SOLUTION_TYPE_SEARCH
413
+ * @param {object} [options]
414
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
415
+ * @returns {Stream}
416
+ * An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine} on 'data' event.
417
+ * The client library will perform auto-pagination by default: it will call the API as many
418
+ * times as needed. Note that it can affect your quota.
419
+ * We recommend using `listEnginesAsync()`
420
+ * method described below for async iteration which you can stop as needed.
421
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
422
+ * for more details and examples.
423
+ */
424
+ listEnginesStream(request?: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options?: CallOptions): Transform;
425
+ /**
426
+ * Equivalent to `listEngines`, but returns an iterable object.
427
+ *
428
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
429
+ * @param {Object} request
430
+ * The request object that will be sent.
431
+ * @param {string} request.parent
432
+ * Required. The parent resource name, such as
433
+ * `projects/{project}/locations/{location}/collections/{collection_id}`.
434
+ * @param {number} [request.pageSize]
435
+ * Optional. Not supported.
436
+ * @param {string} [request.pageToken]
437
+ * Optional. Not supported.
438
+ * @param {string} [request.filter]
439
+ * Optional. Filter by solution type. For example:
440
+ * solution_type=SOLUTION_TYPE_SEARCH
441
+ * @param {object} [options]
442
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
443
+ * @returns {Object}
444
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
445
+ * When you iterate the returned iterable, each element will be an object representing
446
+ * {@link protos.google.cloud.discoveryengine.v1alpha.Engine|Engine}. The API will be called under the hood as needed, once per the page,
447
+ * so you can stop the iteration when you don't need more results.
448
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
449
+ * for more details and examples.
450
+ * @example <caption>include:samples/generated/v1alpha/engine_service.list_engines.js</caption>
451
+ * region_tag:discoveryengine_v1alpha_generated_EngineService_ListEngines_async
452
+ */
453
+ listEnginesAsync(request?: protos.google.cloud.discoveryengine.v1alpha.IListEnginesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1alpha.IEngine>;
454
+ /**
455
+ * Gets information about a location.
456
+ *
457
+ * @param {Object} request
458
+ * The request object that will be sent.
459
+ * @param {string} request.name
460
+ * Resource name for the location.
461
+ * @param {object} [options]
462
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
463
+ * @returns {Promise} - The promise which resolves to an array.
464
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
465
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
466
+ * for more details and examples.
467
+ * @example
468
+ * ```
469
+ * const [response] = await client.getLocation(request);
470
+ * ```
471
+ */
472
+ 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>;
473
+ /**
474
+ * Lists information about the supported locations for this service. Returns an iterable object.
475
+ *
476
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
477
+ * @param {Object} request
478
+ * The request object that will be sent.
479
+ * @param {string} request.name
480
+ * The resource that owns the locations collection, if applicable.
481
+ * @param {string} request.filter
482
+ * The standard list filter.
483
+ * @param {number} request.pageSize
484
+ * The standard list page size.
485
+ * @param {string} request.pageToken
486
+ * The standard list page token.
487
+ * @param {object} [options]
488
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
489
+ * @returns {Object}
490
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
491
+ * When you iterate the returned iterable, each element will be an object representing
492
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
493
+ * so you can stop the iteration when you don't need more results.
494
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
495
+ * for more details and examples.
496
+ * @example
497
+ * ```
498
+ * const iterable = client.listLocationsAsync(request);
499
+ * for await (const response of iterable) {
500
+ * // process response
501
+ * }
502
+ * ```
503
+ */
504
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
505
+ /**
506
+ * Gets the latest state of a long-running operation. Clients can use this
507
+ * method to poll the operation result at intervals as recommended by the API
508
+ * service.
509
+ *
510
+ * @param {Object} request - The request object that will be sent.
511
+ * @param {string} request.name - The name of the operation resource.
512
+ * @param {Object=} options
513
+ * Optional parameters. You can override the default settings for this call,
514
+ * e.g, timeout, retries, paginations, etc. See {@link
515
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
516
+ * for the details.
517
+ * @param {function(?Error, ?Object)=} callback
518
+ * The function which will be called with the result of the API call.
519
+ *
520
+ * The second parameter to the callback is an object representing
521
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
522
+ * @return {Promise} - The promise which resolves to an array.
523
+ * The first element of the array is an object representing
524
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
525
+ * The promise has a method named "cancel" which cancels the ongoing API call.
526
+ *
527
+ * @example
528
+ * ```
529
+ * const client = longrunning.operationsClient();
530
+ * const name = '';
531
+ * const [response] = await client.getOperation({name});
532
+ * // doThingsWith(response)
533
+ * ```
534
+ */
535
+ 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]>;
536
+ /**
537
+ * Lists operations that match the specified filter in the request. If the
538
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
539
+ *
540
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
541
+ *
542
+ * @param {Object} request - The request object that will be sent.
543
+ * @param {string} request.name - The name of the operation collection.
544
+ * @param {string} request.filter - The standard list filter.
545
+ * @param {number=} request.pageSize -
546
+ * The maximum number of resources contained in the underlying API
547
+ * response. If page streaming is performed per-resource, this
548
+ * parameter does not affect the return value. If page streaming is
549
+ * performed per-page, this determines the maximum number of
550
+ * resources in a page.
551
+ * @param {Object=} options
552
+ * Optional parameters. You can override the default settings for this call,
553
+ * e.g, timeout, retries, paginations, etc. See {@link
554
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
555
+ * details.
556
+ * @returns {Object}
557
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
558
+ *
559
+ * @example
560
+ * ```
561
+ * const client = longrunning.operationsClient();
562
+ * for await (const response of client.listOperationsAsync(request));
563
+ * // doThingsWith(response)
564
+ * ```
565
+ */
566
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
567
+ /**
568
+ * Starts asynchronous cancellation on a long-running operation. The server
569
+ * makes a best effort to cancel the operation, but success is not
570
+ * guaranteed. If the server doesn't support this method, it returns
571
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
572
+ * {@link Operations.GetOperation} or
573
+ * other methods to check whether the cancellation succeeded or whether the
574
+ * operation completed despite cancellation. On successful cancellation,
575
+ * the operation is not deleted; instead, it becomes an operation with
576
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
577
+ * 1, corresponding to `Code.CANCELLED`.
578
+ *
579
+ * @param {Object} request - The request object that will be sent.
580
+ * @param {string} request.name - The name of the operation resource to be cancelled.
581
+ * @param {Object=} options
582
+ * Optional parameters. You can override the default settings for this call,
583
+ * e.g, timeout, retries, paginations, etc. See {@link
584
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
585
+ * details.
586
+ * @param {function(?Error)=} callback
587
+ * The function which will be called with the result of the API call.
588
+ * @return {Promise} - The promise which resolves when API call finishes.
589
+ * The promise has a method named "cancel" which cancels the ongoing API
590
+ * call.
591
+ *
592
+ * @example
593
+ * ```
594
+ * const client = longrunning.operationsClient();
595
+ * await client.cancelOperation({name: ''});
596
+ * ```
597
+ */
598
+ 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>;
599
+ /**
600
+ * Deletes a long-running operation. This method indicates that the client is
601
+ * no longer interested in the operation result. It does not cancel the
602
+ * operation. If the server doesn't support this method, it returns
603
+ * `google.rpc.Code.UNIMPLEMENTED`.
604
+ *
605
+ * @param {Object} request - The request object that will be sent.
606
+ * @param {string} request.name - The name of the operation resource to be deleted.
607
+ * @param {Object=} options
608
+ * Optional parameters. You can override the default settings for this call,
609
+ * e.g, timeout, retries, paginations, etc. See {@link
610
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
611
+ * for the details.
612
+ * @param {function(?Error)=} callback
613
+ * The function which will be called with the result of the API call.
614
+ * @return {Promise} - The promise which resolves when API call finishes.
615
+ * The promise has a method named "cancel" which cancels the ongoing API
616
+ * call.
617
+ *
618
+ * @example
619
+ * ```
620
+ * const client = longrunning.operationsClient();
621
+ * await client.deleteOperation({name: ''});
622
+ * ```
623
+ */
624
+ 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>;
625
+ /**
626
+ * Return a fully-qualified collection resource name string.
627
+ *
628
+ * @param {string} project
629
+ * @param {string} location
630
+ * @param {string} collection
631
+ * @returns {string} Resource name string.
632
+ */
633
+ collectionPath(project: string, location: string, collection: string): string;
634
+ /**
635
+ * Parse the project from Collection resource.
636
+ *
637
+ * @param {string} collectionName
638
+ * A fully-qualified path representing Collection resource.
639
+ * @returns {string} A string representing the project.
640
+ */
641
+ matchProjectFromCollectionName(collectionName: string): string | number;
642
+ /**
643
+ * Parse the location from Collection resource.
644
+ *
645
+ * @param {string} collectionName
646
+ * A fully-qualified path representing Collection resource.
647
+ * @returns {string} A string representing the location.
648
+ */
649
+ matchLocationFromCollectionName(collectionName: string): string | number;
650
+ /**
651
+ * Parse the collection from Collection resource.
652
+ *
653
+ * @param {string} collectionName
654
+ * A fully-qualified path representing Collection resource.
655
+ * @returns {string} A string representing the collection.
656
+ */
657
+ matchCollectionFromCollectionName(collectionName: string): string | number;
658
+ /**
659
+ * Return a fully-qualified engine resource name string.
660
+ *
661
+ * @param {string} project
662
+ * @param {string} location
663
+ * @param {string} collection
664
+ * @param {string} engine
665
+ * @returns {string} Resource name string.
666
+ */
667
+ enginePath(project: string, location: string, collection: string, engine: string): string;
668
+ /**
669
+ * Parse the project from Engine resource.
670
+ *
671
+ * @param {string} engineName
672
+ * A fully-qualified path representing Engine resource.
673
+ * @returns {string} A string representing the project.
674
+ */
675
+ matchProjectFromEngineName(engineName: string): string | number;
676
+ /**
677
+ * Parse the location from Engine resource.
678
+ *
679
+ * @param {string} engineName
680
+ * A fully-qualified path representing Engine resource.
681
+ * @returns {string} A string representing the location.
682
+ */
683
+ matchLocationFromEngineName(engineName: string): string | number;
684
+ /**
685
+ * Parse the collection from Engine resource.
686
+ *
687
+ * @param {string} engineName
688
+ * A fully-qualified path representing Engine resource.
689
+ * @returns {string} A string representing the collection.
690
+ */
691
+ matchCollectionFromEngineName(engineName: string): string | number;
692
+ /**
693
+ * Parse the engine from Engine resource.
694
+ *
695
+ * @param {string} engineName
696
+ * A fully-qualified path representing Engine resource.
697
+ * @returns {string} A string representing the engine.
698
+ */
699
+ matchEngineFromEngineName(engineName: string): string | number;
700
+ /**
701
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
702
+ *
703
+ * @param {string} project
704
+ * @param {string} location
705
+ * @param {string} collection
706
+ * @param {string} data_store
707
+ * @returns {string} Resource name string.
708
+ */
709
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
710
+ /**
711
+ * Parse the project from ProjectLocationCollectionDataStore resource.
712
+ *
713
+ * @param {string} projectLocationCollectionDataStoreName
714
+ * A fully-qualified path representing project_location_collection_data_store resource.
715
+ * @returns {string} A string representing the project.
716
+ */
717
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
718
+ /**
719
+ * Parse the location from ProjectLocationCollectionDataStore resource.
720
+ *
721
+ * @param {string} projectLocationCollectionDataStoreName
722
+ * A fully-qualified path representing project_location_collection_data_store resource.
723
+ * @returns {string} A string representing the location.
724
+ */
725
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
726
+ /**
727
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
728
+ *
729
+ * @param {string} projectLocationCollectionDataStoreName
730
+ * A fully-qualified path representing project_location_collection_data_store resource.
731
+ * @returns {string} A string representing the collection.
732
+ */
733
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
734
+ /**
735
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
736
+ *
737
+ * @param {string} projectLocationCollectionDataStoreName
738
+ * A fully-qualified path representing project_location_collection_data_store resource.
739
+ * @returns {string} A string representing the data_store.
740
+ */
741
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
742
+ /**
743
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
744
+ *
745
+ * @param {string} project
746
+ * @param {string} location
747
+ * @param {string} collection
748
+ * @param {string} data_store
749
+ * @param {string} branch
750
+ * @param {string} document
751
+ * @returns {string} Resource name string.
752
+ */
753
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
754
+ /**
755
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
756
+ *
757
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
758
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
759
+ * @returns {string} A string representing the project.
760
+ */
761
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
762
+ /**
763
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
764
+ *
765
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
766
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
767
+ * @returns {string} A string representing the location.
768
+ */
769
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
770
+ /**
771
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
772
+ *
773
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
774
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
775
+ * @returns {string} A string representing the collection.
776
+ */
777
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
778
+ /**
779
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
780
+ *
781
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
782
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
783
+ * @returns {string} A string representing the data_store.
784
+ */
785
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
786
+ /**
787
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
788
+ *
789
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
790
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
791
+ * @returns {string} A string representing the branch.
792
+ */
793
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
794
+ /**
795
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
796
+ *
797
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
798
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
799
+ * @returns {string} A string representing the document.
800
+ */
801
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
802
+ /**
803
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
804
+ *
805
+ * @param {string} project
806
+ * @param {string} location
807
+ * @param {string} collection
808
+ * @param {string} data_store
809
+ * @param {string} conversation
810
+ * @returns {string} Resource name string.
811
+ */
812
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
813
+ /**
814
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
815
+ *
816
+ * @param {string} projectLocationCollectionDataStoreConversationName
817
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
818
+ * @returns {string} A string representing the project.
819
+ */
820
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
821
+ /**
822
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
823
+ *
824
+ * @param {string} projectLocationCollectionDataStoreConversationName
825
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
826
+ * @returns {string} A string representing the location.
827
+ */
828
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
829
+ /**
830
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
831
+ *
832
+ * @param {string} projectLocationCollectionDataStoreConversationName
833
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
834
+ * @returns {string} A string representing the collection.
835
+ */
836
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
837
+ /**
838
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
839
+ *
840
+ * @param {string} projectLocationCollectionDataStoreConversationName
841
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
842
+ * @returns {string} A string representing the data_store.
843
+ */
844
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
845
+ /**
846
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
847
+ *
848
+ * @param {string} projectLocationCollectionDataStoreConversationName
849
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
850
+ * @returns {string} A string representing the conversation.
851
+ */
852
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
853
+ /**
854
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
855
+ *
856
+ * @param {string} project
857
+ * @param {string} location
858
+ * @param {string} collection
859
+ * @param {string} data_store
860
+ * @param {string} schema
861
+ * @returns {string} Resource name string.
862
+ */
863
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
864
+ /**
865
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
866
+ *
867
+ * @param {string} projectLocationCollectionDataStoreSchemaName
868
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
869
+ * @returns {string} A string representing the project.
870
+ */
871
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
872
+ /**
873
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
874
+ *
875
+ * @param {string} projectLocationCollectionDataStoreSchemaName
876
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
877
+ * @returns {string} A string representing the location.
878
+ */
879
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
880
+ /**
881
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
882
+ *
883
+ * @param {string} projectLocationCollectionDataStoreSchemaName
884
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
885
+ * @returns {string} A string representing the collection.
886
+ */
887
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
888
+ /**
889
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
890
+ *
891
+ * @param {string} projectLocationCollectionDataStoreSchemaName
892
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
893
+ * @returns {string} A string representing the data_store.
894
+ */
895
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
896
+ /**
897
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
898
+ *
899
+ * @param {string} projectLocationCollectionDataStoreSchemaName
900
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
901
+ * @returns {string} A string representing the schema.
902
+ */
903
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
904
+ /**
905
+ * Return a fully-qualified projectLocationDataStore resource name string.
906
+ *
907
+ * @param {string} project
908
+ * @param {string} location
909
+ * @param {string} data_store
910
+ * @returns {string} Resource name string.
911
+ */
912
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
913
+ /**
914
+ * Parse the project from ProjectLocationDataStore resource.
915
+ *
916
+ * @param {string} projectLocationDataStoreName
917
+ * A fully-qualified path representing project_location_data_store resource.
918
+ * @returns {string} A string representing the project.
919
+ */
920
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
921
+ /**
922
+ * Parse the location from ProjectLocationDataStore resource.
923
+ *
924
+ * @param {string} projectLocationDataStoreName
925
+ * A fully-qualified path representing project_location_data_store resource.
926
+ * @returns {string} A string representing the location.
927
+ */
928
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
929
+ /**
930
+ * Parse the data_store from ProjectLocationDataStore resource.
931
+ *
932
+ * @param {string} projectLocationDataStoreName
933
+ * A fully-qualified path representing project_location_data_store resource.
934
+ * @returns {string} A string representing the data_store.
935
+ */
936
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
937
+ /**
938
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
939
+ *
940
+ * @param {string} project
941
+ * @param {string} location
942
+ * @param {string} data_store
943
+ * @param {string} branch
944
+ * @param {string} document
945
+ * @returns {string} Resource name string.
946
+ */
947
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
948
+ /**
949
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
950
+ *
951
+ * @param {string} projectLocationDataStoreBranchDocumentName
952
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
953
+ * @returns {string} A string representing the project.
954
+ */
955
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
956
+ /**
957
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
958
+ *
959
+ * @param {string} projectLocationDataStoreBranchDocumentName
960
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
961
+ * @returns {string} A string representing the location.
962
+ */
963
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
964
+ /**
965
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
966
+ *
967
+ * @param {string} projectLocationDataStoreBranchDocumentName
968
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
969
+ * @returns {string} A string representing the data_store.
970
+ */
971
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
972
+ /**
973
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
974
+ *
975
+ * @param {string} projectLocationDataStoreBranchDocumentName
976
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
977
+ * @returns {string} A string representing the branch.
978
+ */
979
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
980
+ /**
981
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
982
+ *
983
+ * @param {string} projectLocationDataStoreBranchDocumentName
984
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
985
+ * @returns {string} A string representing the document.
986
+ */
987
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
988
+ /**
989
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
990
+ *
991
+ * @param {string} project
992
+ * @param {string} location
993
+ * @param {string} data_store
994
+ * @param {string} conversation
995
+ * @returns {string} Resource name string.
996
+ */
997
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
998
+ /**
999
+ * Parse the project from ProjectLocationDataStoreConversation resource.
1000
+ *
1001
+ * @param {string} projectLocationDataStoreConversationName
1002
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1003
+ * @returns {string} A string representing the project.
1004
+ */
1005
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1006
+ /**
1007
+ * Parse the location from ProjectLocationDataStoreConversation resource.
1008
+ *
1009
+ * @param {string} projectLocationDataStoreConversationName
1010
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1011
+ * @returns {string} A string representing the location.
1012
+ */
1013
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1014
+ /**
1015
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
1016
+ *
1017
+ * @param {string} projectLocationDataStoreConversationName
1018
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1019
+ * @returns {string} A string representing the data_store.
1020
+ */
1021
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1022
+ /**
1023
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
1024
+ *
1025
+ * @param {string} projectLocationDataStoreConversationName
1026
+ * A fully-qualified path representing project_location_data_store_conversation resource.
1027
+ * @returns {string} A string representing the conversation.
1028
+ */
1029
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
1030
+ /**
1031
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
1032
+ *
1033
+ * @param {string} project
1034
+ * @param {string} location
1035
+ * @param {string} data_store
1036
+ * @param {string} schema
1037
+ * @returns {string} Resource name string.
1038
+ */
1039
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
1040
+ /**
1041
+ * Parse the project from ProjectLocationDataStoreSchema resource.
1042
+ *
1043
+ * @param {string} projectLocationDataStoreSchemaName
1044
+ * A fully-qualified path representing project_location_data_store_schema resource.
1045
+ * @returns {string} A string representing the project.
1046
+ */
1047
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1048
+ /**
1049
+ * Parse the location from ProjectLocationDataStoreSchema resource.
1050
+ *
1051
+ * @param {string} projectLocationDataStoreSchemaName
1052
+ * A fully-qualified path representing project_location_data_store_schema resource.
1053
+ * @returns {string} A string representing the location.
1054
+ */
1055
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1056
+ /**
1057
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
1058
+ *
1059
+ * @param {string} projectLocationDataStoreSchemaName
1060
+ * A fully-qualified path representing project_location_data_store_schema resource.
1061
+ * @returns {string} A string representing the data_store.
1062
+ */
1063
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1064
+ /**
1065
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
1066
+ *
1067
+ * @param {string} projectLocationDataStoreSchemaName
1068
+ * A fully-qualified path representing project_location_data_store_schema resource.
1069
+ * @returns {string} A string representing the schema.
1070
+ */
1071
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
1072
+ /**
1073
+ * Terminate the gRPC channel and close the client.
1074
+ *
1075
+ * The client will no longer be usable and all future behavior is undefined.
1076
+ * @returns {Promise} A promise that resolves when the client is closed.
1077
+ */
1078
+ close(): Promise<void>;
1079
+ }