@google-cloud/discoveryengine 1.0.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (94) hide show
  1. package/CHANGELOG.md +20 -0
  2. package/README.md +33 -1
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +30 -2
  4. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +15 -2
  5. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +114 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +303 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/document.proto +8 -5
  8. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +4 -3
  9. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +27 -23
  10. package/build/protos/google/cloud/discoveryengine/v1/schema.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +428 -20
  12. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +48 -39
  13. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +2 -2
  14. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +155 -0
  15. package/build/protos/google/cloud/discoveryengine/v1alpha/completion_service.proto +134 -0
  16. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +138 -0
  17. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +306 -0
  18. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +121 -0
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/document_service.proto +318 -0
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/import_config.proto +343 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/purge_config.proto +159 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/recommendation_service.proto +221 -0
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/schema.proto +312 -0
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/schema_service.proto +260 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +851 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +152 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event.proto +475 -0
  28. package/build/protos/google/cloud/discoveryengine/v1alpha/user_event_service.proto +154 -0
  29. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +6 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +9 -2
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +25 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +115 -3
  33. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -0
  34. package/build/protos/protos.d.ts +22864 -6680
  35. package/build/protos/protos.js +57205 -16191
  36. package/build/protos/protos.json +5548 -1224
  37. package/build/src/index.d.ts +6 -1
  38. package/build/src/index.js +7 -1
  39. package/build/src/v1/completion_service_client.d.ts +156 -6
  40. package/build/src/v1/completion_service_client.js +188 -4
  41. package/build/src/v1/conversational_search_service_client.d.ts +947 -0
  42. package/build/src/v1/conversational_search_service_client.js +1205 -0
  43. package/build/src/v1/conversational_search_service_client_config.json +68 -0
  44. package/build/src/v1/document_service_client.d.ts +165 -18
  45. package/build/src/v1/document_service_client.js +215 -11
  46. package/build/src/v1/index.d.ts +1 -0
  47. package/build/src/v1/index.js +3 -1
  48. package/build/src/v1/schema_service_client.d.ts +148 -4
  49. package/build/src/v1/schema_service_client.js +207 -5
  50. package/build/src/v1/search_service_client.d.ts +238 -28
  51. package/build/src/v1/search_service_client.js +248 -20
  52. package/build/src/v1/user_event_service_client.d.ts +153 -9
  53. package/build/src/v1/user_event_service_client.js +207 -5
  54. package/build/src/v1alpha/completion_service_client.d.ts +603 -0
  55. package/build/src/v1alpha/completion_service_client.js +843 -0
  56. package/build/src/v1alpha/completion_service_client_config.json +43 -0
  57. package/build/src/v1alpha/conversational_search_service_client.d.ts +998 -0
  58. package/build/src/v1alpha/conversational_search_service_client.js +1275 -0
  59. package/build/src/v1alpha/conversational_search_service_client_config.json +68 -0
  60. package/build/src/v1alpha/document_service_client.d.ts +1140 -0
  61. package/build/src/v1alpha/document_service_client.js +1393 -0
  62. package/build/src/v1alpha/document_service_client_config.json +82 -0
  63. package/build/src/v1alpha/index.d.ts +8 -0
  64. package/build/src/v1alpha/index.js +37 -0
  65. package/build/src/v1alpha/recommendation_service_client.d.ts +735 -0
  66. package/build/src/v1alpha/recommendation_service_client.js +938 -0
  67. package/build/src/v1alpha/recommendation_service_client_config.json +43 -0
  68. package/build/src/v1alpha/schema_service_client.d.ts +935 -0
  69. package/build/src/v1alpha/schema_service_client.js +1327 -0
  70. package/build/src/v1alpha/schema_service_client_config.json +63 -0
  71. package/build/src/v1alpha/search_service_client.d.ts +1208 -0
  72. package/build/src/v1alpha/search_service_client.js +1432 -0
  73. package/build/src/v1alpha/search_service_client_config.json +43 -0
  74. package/build/src/v1alpha/site_search_engine_service_client.d.ts +704 -0
  75. package/build/src/v1alpha/site_search_engine_service_client.js +1087 -0
  76. package/build/src/v1alpha/site_search_engine_service_client_config.json +30 -0
  77. package/build/src/v1alpha/user_event_service_client.d.ts +853 -0
  78. package/build/src/v1alpha/user_event_service_client.js +1174 -0
  79. package/build/src/v1alpha/user_event_service_client_config.json +67 -0
  80. package/build/src/v1beta/completion_service_client.d.ts +55 -4
  81. package/build/src/v1beta/completion_service_client.js +60 -4
  82. package/build/src/v1beta/conversational_search_service_client.d.ts +75 -4
  83. package/build/src/v1beta/conversational_search_service_client.js +60 -4
  84. package/build/src/v1beta/document_service_client.d.ts +55 -4
  85. package/build/src/v1beta/document_service_client.js +61 -5
  86. package/build/src/v1beta/recommendation_service_client.d.ts +55 -4
  87. package/build/src/v1beta/recommendation_service_client.js +60 -4
  88. package/build/src/v1beta/schema_service_client.d.ts +55 -4
  89. package/build/src/v1beta/schema_service_client.js +61 -5
  90. package/build/src/v1beta/search_service_client.d.ts +142 -4
  91. package/build/src/v1beta/search_service_client.js +118 -4
  92. package/build/src/v1beta/user_event_service_client.d.ts +55 -4
  93. package/build/src/v1beta/user_event_service_client.js +61 -5
  94. package/package.json +5 -5
@@ -0,0 +1,603 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LocationsClient, LocationProtos } from 'google-gax';
3
+ import * as protos from '../../protos/protos';
4
+ /**
5
+ * Service for Auto-Completion.
6
+ * @class
7
+ * @memberof v1alpha
8
+ */
9
+ export declare class CompletionServiceClient {
10
+ private _terminated;
11
+ private _opts;
12
+ private _providedCustomServicePath;
13
+ private _gaxModule;
14
+ private _gaxGrpc;
15
+ private _protos;
16
+ private _defaults;
17
+ auth: gax.GoogleAuth;
18
+ descriptors: Descriptors;
19
+ warn: (code: string, message: string, warnType?: string) => void;
20
+ innerApiCalls: {
21
+ [name: string]: Function;
22
+ };
23
+ locationsClient: LocationsClient;
24
+ pathTemplates: {
25
+ [name: string]: gax.PathTemplate;
26
+ };
27
+ completionServiceStub?: Promise<{
28
+ [name: string]: Function;
29
+ }>;
30
+ /**
31
+ * Construct an instance of CompletionServiceClient.
32
+ *
33
+ * @param {object} [options] - The configuration object.
34
+ * The options accepted by the constructor are described in detail
35
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
36
+ * The common options are:
37
+ * @param {object} [options.credentials] - Credentials object.
38
+ * @param {string} [options.credentials.client_email]
39
+ * @param {string} [options.credentials.private_key]
40
+ * @param {string} [options.email] - Account email address. Required when
41
+ * using a .pem or .p12 keyFilename.
42
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
43
+ * .p12 key downloaded from the Google Developers Console. If you provide
44
+ * a path to a JSON file, the projectId option below is not necessary.
45
+ * NOTE: .pem and .p12 require you to specify options.email as well.
46
+ * @param {number} [options.port] - The port on which to connect to
47
+ * the remote host.
48
+ * @param {string} [options.projectId] - The project ID from the Google
49
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
50
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
51
+ * app is running in an environment which supports
52
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
53
+ * your project ID will be detected automatically.
54
+ * @param {string} [options.apiEndpoint] - The domain name of the
55
+ * API remote host.
56
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
57
+ * Follows the structure of {@link gapicConfig}.
58
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
59
+ * For more information, please check the
60
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
61
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
62
+ * need to avoid loading the default gRPC version and want to use the fallback
63
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
64
+ * ```
65
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
66
+ * const client = new CompletionServiceClient({fallback: true}, gax);
67
+ * ```
68
+ */
69
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
70
+ /**
71
+ * Initialize the client.
72
+ * Performs asynchronous operations (such as authentication) and prepares the client.
73
+ * This function will be called automatically when any class method is called for the
74
+ * first time, but if you need to initialize it before calling an actual method,
75
+ * feel free to call initialize() directly.
76
+ *
77
+ * You can await on this method if you want to make sure the client is initialized.
78
+ *
79
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
80
+ */
81
+ initialize(): Promise<{
82
+ [name: string]: Function;
83
+ }>;
84
+ /**
85
+ * The DNS address for this API service.
86
+ * @returns {string} The DNS address for this service.
87
+ */
88
+ static get servicePath(): string;
89
+ /**
90
+ * The DNS address for this API service - same as servicePath(),
91
+ * exists for compatibility reasons.
92
+ * @returns {string} The DNS address for this service.
93
+ */
94
+ static get apiEndpoint(): string;
95
+ /**
96
+ * The port for this API service.
97
+ * @returns {number} The default port for this service.
98
+ */
99
+ static get port(): number;
100
+ /**
101
+ * The scopes needed to make gRPC calls for every method defined
102
+ * in this service.
103
+ * @returns {string[]} List of default scopes.
104
+ */
105
+ static get scopes(): string[];
106
+ getProjectId(): Promise<string>;
107
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
108
+ /**
109
+ * Completes the specified user input with keyword suggestions.
110
+ *
111
+ * @param {Object} request
112
+ * The request object that will be sent.
113
+ * @param {string} request.dataStore
114
+ * Required. The parent data store resource name for which the completion is
115
+ * performed, such as
116
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
117
+ * @param {string} request.query
118
+ * Required. The typeahead input used to fetch suggestions. Maximum length is
119
+ * 128 characters.
120
+ * @param {string} request.queryModel
121
+ * Selects data model of query suggestions for serving. Currently supported
122
+ * values:
123
+ *
124
+ * * `document` - Using suggestions generated from user-imported documents.
125
+ * * `search-history` - Using suggestions generated from the past history of
126
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchService.Search|SearchService.Search}
127
+ * API calls. Do not use it when there is no traffic for Search API.
128
+ * * `user-event` - Using suggestions generated from user-imported search
129
+ * events.
130
+ * * `document-completable` - Using suggestions taken directly from
131
+ * user-imported document fields marked as completable.
132
+ *
133
+ * Default values:
134
+ *
135
+ * * `document` is the default model for regular dataStores.
136
+ * * `search-history` is the default model for site search dataStores.
137
+ * @param {string} request.userPseudoId
138
+ * A unique identifier for tracking visitors. For example, this could be
139
+ * implemented with an HTTP cookie, which should be able to uniquely identify
140
+ * a visitor on a single device. This unique identifier should not change if
141
+ * the visitor logs in or out of the website.
142
+ *
143
+ * This field should NOT have a fixed value such as `unknown_visitor`.
144
+ *
145
+ * This should be the same identifier as
146
+ * {@link protos.google.cloud.discoveryengine.v1alpha.UserEvent.user_pseudo_id|UserEvent.user_pseudo_id}
147
+ * and
148
+ * {@link protos.google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id|SearchRequest.user_pseudo_id}.
149
+ *
150
+ * The field must be a UTF-8 encoded string with a length limit of 128
151
+ * characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
152
+ * @param {boolean} request.includeTailSuggestions
153
+ * Indicates if tail suggestions should be returned if there are no
154
+ * suggestions that match the full query. Even if set to true, if there are
155
+ * suggestions that match the full query, those are returned and no
156
+ * tail suggestions are returned.
157
+ * @param {object} [options]
158
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
159
+ * @returns {Promise} - The promise which resolves to an array.
160
+ * The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1alpha.CompleteQueryResponse|CompleteQueryResponse}.
161
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
162
+ * for more details and examples.
163
+ * @example <caption>include:samples/generated/v1alpha/completion_service.complete_query.js</caption>
164
+ * region_tag:discoveryengine_v1alpha_generated_CompletionService_CompleteQuery_async
165
+ */
166
+ completeQuery(request?: protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryRequest, options?: CallOptions): Promise<[
167
+ protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryResponse,
168
+ (protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryRequest | undefined),
169
+ {} | undefined
170
+ ]>;
171
+ completeQuery(request: protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryResponse, protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
172
+ completeQuery(request: protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryRequest, callback: Callback<protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryResponse, protos.google.cloud.discoveryengine.v1alpha.ICompleteQueryRequest | null | undefined, {} | null | undefined>): void;
173
+ /**
174
+ * Gets information about a location.
175
+ *
176
+ * @param {Object} request
177
+ * The request object that will be sent.
178
+ * @param {string} request.name
179
+ * Resource name for the location.
180
+ * @param {object} [options]
181
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
182
+ * @returns {Promise} - The promise which resolves to an array.
183
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
184
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
185
+ * for more details and examples.
186
+ * @example
187
+ * ```
188
+ * const [response] = await client.getLocation(request);
189
+ * ```
190
+ */
191
+ 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>;
192
+ /**
193
+ * Lists information about the supported locations for this service. Returns an iterable object.
194
+ *
195
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
196
+ * @param {Object} request
197
+ * The request object that will be sent.
198
+ * @param {string} request.name
199
+ * The resource that owns the locations collection, if applicable.
200
+ * @param {string} request.filter
201
+ * The standard list filter.
202
+ * @param {number} request.pageSize
203
+ * The standard list page size.
204
+ * @param {string} request.pageToken
205
+ * The standard list page token.
206
+ * @param {object} [options]
207
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
208
+ * @returns {Object}
209
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
210
+ * When you iterate the returned iterable, each element will be an object representing
211
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
212
+ * so you can stop the iteration when you don't need more results.
213
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
214
+ * for more details and examples.
215
+ * @example
216
+ * ```
217
+ * const iterable = client.listLocationsAsync(request);
218
+ * for await (const response of iterable) {
219
+ * // process response
220
+ * }
221
+ * ```
222
+ */
223
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
224
+ /**
225
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
226
+ *
227
+ * @param {string} project
228
+ * @param {string} location
229
+ * @param {string} collection
230
+ * @param {string} data_store
231
+ * @returns {string} Resource name string.
232
+ */
233
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
234
+ /**
235
+ * Parse the project from ProjectLocationCollectionDataStore resource.
236
+ *
237
+ * @param {string} projectLocationCollectionDataStoreName
238
+ * A fully-qualified path representing project_location_collection_data_store resource.
239
+ * @returns {string} A string representing the project.
240
+ */
241
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
242
+ /**
243
+ * Parse the location from ProjectLocationCollectionDataStore resource.
244
+ *
245
+ * @param {string} projectLocationCollectionDataStoreName
246
+ * A fully-qualified path representing project_location_collection_data_store resource.
247
+ * @returns {string} A string representing the location.
248
+ */
249
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
250
+ /**
251
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
252
+ *
253
+ * @param {string} projectLocationCollectionDataStoreName
254
+ * A fully-qualified path representing project_location_collection_data_store resource.
255
+ * @returns {string} A string representing the collection.
256
+ */
257
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
258
+ /**
259
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
260
+ *
261
+ * @param {string} projectLocationCollectionDataStoreName
262
+ * A fully-qualified path representing project_location_collection_data_store resource.
263
+ * @returns {string} A string representing the data_store.
264
+ */
265
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
266
+ /**
267
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
268
+ *
269
+ * @param {string} project
270
+ * @param {string} location
271
+ * @param {string} collection
272
+ * @param {string} data_store
273
+ * @param {string} branch
274
+ * @param {string} document
275
+ * @returns {string} Resource name string.
276
+ */
277
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
278
+ /**
279
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
280
+ *
281
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
282
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
283
+ * @returns {string} A string representing the project.
284
+ */
285
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
286
+ /**
287
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
288
+ *
289
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
290
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
291
+ * @returns {string} A string representing the location.
292
+ */
293
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
294
+ /**
295
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
296
+ *
297
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
298
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
299
+ * @returns {string} A string representing the collection.
300
+ */
301
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
302
+ /**
303
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
304
+ *
305
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
306
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
307
+ * @returns {string} A string representing the data_store.
308
+ */
309
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
310
+ /**
311
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
312
+ *
313
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
314
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
315
+ * @returns {string} A string representing the branch.
316
+ */
317
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
318
+ /**
319
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
320
+ *
321
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
322
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
323
+ * @returns {string} A string representing the document.
324
+ */
325
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
326
+ /**
327
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
328
+ *
329
+ * @param {string} project
330
+ * @param {string} location
331
+ * @param {string} collection
332
+ * @param {string} data_store
333
+ * @param {string} conversation
334
+ * @returns {string} Resource name string.
335
+ */
336
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
337
+ /**
338
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
339
+ *
340
+ * @param {string} projectLocationCollectionDataStoreConversationName
341
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
342
+ * @returns {string} A string representing the project.
343
+ */
344
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
345
+ /**
346
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
347
+ *
348
+ * @param {string} projectLocationCollectionDataStoreConversationName
349
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
350
+ * @returns {string} A string representing the location.
351
+ */
352
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
353
+ /**
354
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
355
+ *
356
+ * @param {string} projectLocationCollectionDataStoreConversationName
357
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
358
+ * @returns {string} A string representing the collection.
359
+ */
360
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
361
+ /**
362
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
363
+ *
364
+ * @param {string} projectLocationCollectionDataStoreConversationName
365
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
366
+ * @returns {string} A string representing the data_store.
367
+ */
368
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
369
+ /**
370
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
371
+ *
372
+ * @param {string} projectLocationCollectionDataStoreConversationName
373
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
374
+ * @returns {string} A string representing the conversation.
375
+ */
376
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
377
+ /**
378
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
379
+ *
380
+ * @param {string} project
381
+ * @param {string} location
382
+ * @param {string} collection
383
+ * @param {string} data_store
384
+ * @param {string} schema
385
+ * @returns {string} Resource name string.
386
+ */
387
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
388
+ /**
389
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
390
+ *
391
+ * @param {string} projectLocationCollectionDataStoreSchemaName
392
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
393
+ * @returns {string} A string representing the project.
394
+ */
395
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
396
+ /**
397
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
398
+ *
399
+ * @param {string} projectLocationCollectionDataStoreSchemaName
400
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
401
+ * @returns {string} A string representing the location.
402
+ */
403
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
404
+ /**
405
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
406
+ *
407
+ * @param {string} projectLocationCollectionDataStoreSchemaName
408
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
409
+ * @returns {string} A string representing the collection.
410
+ */
411
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
412
+ /**
413
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
414
+ *
415
+ * @param {string} projectLocationCollectionDataStoreSchemaName
416
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
417
+ * @returns {string} A string representing the data_store.
418
+ */
419
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
420
+ /**
421
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
422
+ *
423
+ * @param {string} projectLocationCollectionDataStoreSchemaName
424
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
425
+ * @returns {string} A string representing the schema.
426
+ */
427
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
428
+ /**
429
+ * Return a fully-qualified projectLocationDataStore resource name string.
430
+ *
431
+ * @param {string} project
432
+ * @param {string} location
433
+ * @param {string} data_store
434
+ * @returns {string} Resource name string.
435
+ */
436
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
437
+ /**
438
+ * Parse the project from ProjectLocationDataStore resource.
439
+ *
440
+ * @param {string} projectLocationDataStoreName
441
+ * A fully-qualified path representing project_location_data_store resource.
442
+ * @returns {string} A string representing the project.
443
+ */
444
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
445
+ /**
446
+ * Parse the location from ProjectLocationDataStore resource.
447
+ *
448
+ * @param {string} projectLocationDataStoreName
449
+ * A fully-qualified path representing project_location_data_store resource.
450
+ * @returns {string} A string representing the location.
451
+ */
452
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
453
+ /**
454
+ * Parse the data_store from ProjectLocationDataStore resource.
455
+ *
456
+ * @param {string} projectLocationDataStoreName
457
+ * A fully-qualified path representing project_location_data_store resource.
458
+ * @returns {string} A string representing the data_store.
459
+ */
460
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
461
+ /**
462
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
463
+ *
464
+ * @param {string} project
465
+ * @param {string} location
466
+ * @param {string} data_store
467
+ * @param {string} branch
468
+ * @param {string} document
469
+ * @returns {string} Resource name string.
470
+ */
471
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
472
+ /**
473
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
474
+ *
475
+ * @param {string} projectLocationDataStoreBranchDocumentName
476
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
477
+ * @returns {string} A string representing the project.
478
+ */
479
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
480
+ /**
481
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
482
+ *
483
+ * @param {string} projectLocationDataStoreBranchDocumentName
484
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
485
+ * @returns {string} A string representing the location.
486
+ */
487
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
488
+ /**
489
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
490
+ *
491
+ * @param {string} projectLocationDataStoreBranchDocumentName
492
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
493
+ * @returns {string} A string representing the data_store.
494
+ */
495
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
496
+ /**
497
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
498
+ *
499
+ * @param {string} projectLocationDataStoreBranchDocumentName
500
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
501
+ * @returns {string} A string representing the branch.
502
+ */
503
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
504
+ /**
505
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
506
+ *
507
+ * @param {string} projectLocationDataStoreBranchDocumentName
508
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
509
+ * @returns {string} A string representing the document.
510
+ */
511
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
512
+ /**
513
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
514
+ *
515
+ * @param {string} project
516
+ * @param {string} location
517
+ * @param {string} data_store
518
+ * @param {string} conversation
519
+ * @returns {string} Resource name string.
520
+ */
521
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
522
+ /**
523
+ * Parse the project from ProjectLocationDataStoreConversation resource.
524
+ *
525
+ * @param {string} projectLocationDataStoreConversationName
526
+ * A fully-qualified path representing project_location_data_store_conversation resource.
527
+ * @returns {string} A string representing the project.
528
+ */
529
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
530
+ /**
531
+ * Parse the location from ProjectLocationDataStoreConversation resource.
532
+ *
533
+ * @param {string} projectLocationDataStoreConversationName
534
+ * A fully-qualified path representing project_location_data_store_conversation resource.
535
+ * @returns {string} A string representing the location.
536
+ */
537
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
538
+ /**
539
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
540
+ *
541
+ * @param {string} projectLocationDataStoreConversationName
542
+ * A fully-qualified path representing project_location_data_store_conversation resource.
543
+ * @returns {string} A string representing the data_store.
544
+ */
545
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
546
+ /**
547
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
548
+ *
549
+ * @param {string} projectLocationDataStoreConversationName
550
+ * A fully-qualified path representing project_location_data_store_conversation resource.
551
+ * @returns {string} A string representing the conversation.
552
+ */
553
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
554
+ /**
555
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
556
+ *
557
+ * @param {string} project
558
+ * @param {string} location
559
+ * @param {string} data_store
560
+ * @param {string} schema
561
+ * @returns {string} Resource name string.
562
+ */
563
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
564
+ /**
565
+ * Parse the project from ProjectLocationDataStoreSchema resource.
566
+ *
567
+ * @param {string} projectLocationDataStoreSchemaName
568
+ * A fully-qualified path representing project_location_data_store_schema resource.
569
+ * @returns {string} A string representing the project.
570
+ */
571
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
572
+ /**
573
+ * Parse the location from ProjectLocationDataStoreSchema resource.
574
+ *
575
+ * @param {string} projectLocationDataStoreSchemaName
576
+ * A fully-qualified path representing project_location_data_store_schema resource.
577
+ * @returns {string} A string representing the location.
578
+ */
579
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
580
+ /**
581
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
582
+ *
583
+ * @param {string} projectLocationDataStoreSchemaName
584
+ * A fully-qualified path representing project_location_data_store_schema resource.
585
+ * @returns {string} A string representing the data_store.
586
+ */
587
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
588
+ /**
589
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
590
+ *
591
+ * @param {string} projectLocationDataStoreSchemaName
592
+ * A fully-qualified path representing project_location_data_store_schema resource.
593
+ * @returns {string} A string representing the schema.
594
+ */
595
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
596
+ /**
597
+ * Terminate the gRPC channel and close the client.
598
+ *
599
+ * The client will no longer be usable and all future behavior is undefined.
600
+ * @returns {Promise} A promise that resolves when the client is closed.
601
+ */
602
+ close(): Promise<void>;
603
+ }