@google-cloud/discoveryengine 1.3.0 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +63 -0
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +54 -3
  4. package/build/protos/google/cloud/discoveryengine/v1/completion.proto +52 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +51 -4
  6. package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +3 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +40 -1
  8. package/build/protos/google/cloud/discoveryengine/v1/data_store.proto +98 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/data_store_service.proto +304 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/document.proto +1 -1
  11. package/build/protos/google/cloud/discoveryengine/v1/engine.proto +215 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/engine_service.proto +242 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +64 -0
  14. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +38 -0
  15. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +137 -4
  16. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine.proto +170 -0
  17. package/build/protos/google/cloud/discoveryengine/v1/site_search_engine_service.proto +691 -0
  18. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +3 -3
  19. package/build/protos/google/cloud/discoveryengine/v1alpha/common.proto +0 -5
  20. package/build/protos/google/cloud/discoveryengine/v1alpha/conversation.proto +3 -0
  21. package/build/protos/google/cloud/discoveryengine/v1alpha/conversational_search_service.proto +39 -0
  22. package/build/protos/google/cloud/discoveryengine/v1alpha/document.proto +1 -1
  23. package/build/protos/google/cloud/discoveryengine/v1alpha/engine_service.proto +1 -1
  24. package/build/protos/google/cloud/discoveryengine/v1alpha/search_service.proto +97 -0
  25. package/build/protos/google/cloud/discoveryengine/v1alpha/search_tuning_service.proto +147 -0
  26. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine.proto +164 -0
  27. package/build/protos/google/cloud/discoveryengine/v1alpha/site_search_engine_service.proto +540 -0
  28. package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +59 -8
  29. package/build/protos/google/cloud/discoveryengine/v1beta/completion.proto +52 -0
  30. package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +51 -4
  31. package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +3 -0
  32. package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +40 -1
  33. package/build/protos/google/cloud/discoveryengine/v1beta/data_store.proto +98 -0
  34. package/build/protos/google/cloud/discoveryengine/v1beta/data_store_service.proto +306 -0
  35. package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +1 -1
  36. package/build/protos/google/cloud/discoveryengine/v1beta/engine.proto +220 -0
  37. package/build/protos/google/cloud/discoveryengine/v1beta/engine_service.proto +244 -0
  38. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +64 -0
  39. package/build/protos/google/cloud/discoveryengine/v1beta/purge_config.proto +38 -0
  40. package/build/protos/google/cloud/discoveryengine/v1beta/recommendation_service.proto +26 -3
  41. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +150 -11
  42. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config.proto +264 -0
  43. package/build/protos/google/cloud/discoveryengine/v1beta/serving_config_service.proto +147 -0
  44. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine.proto +170 -0
  45. package/build/protos/google/cloud/discoveryengine/v1beta/site_search_engine_service.proto +695 -0
  46. package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +4 -3
  47. package/build/protos/protos.d.ts +42822 -21397
  48. package/build/protos/protos.js +110509 -61572
  49. package/build/protos/protos.json +11779 -6752
  50. package/build/src/index.d.ts +10 -1
  51. package/build/src/index.js +11 -2
  52. package/build/src/v1/completion_service_client.d.ts +489 -7
  53. package/build/src/v1/completion_service_client.js +716 -12
  54. package/build/src/v1/completion_service_client_config.json +10 -0
  55. package/build/src/v1/conversational_search_service_client.d.ts +341 -3
  56. package/build/src/v1/conversational_search_service_client.js +467 -10
  57. package/build/src/v1/data_store_service_client.d.ts +1286 -0
  58. package/build/src/v1/data_store_service_client.js +1768 -0
  59. package/build/src/v1/data_store_service_client_config.json +46 -0
  60. package/build/src/v1/document_service_client.d.ts +347 -2
  61. package/build/src/v1/document_service_client.js +507 -10
  62. package/build/src/v1/engine_service_client.d.ts +1211 -0
  63. package/build/src/v1/engine_service_client.js +1731 -0
  64. package/build/src/v1/engine_service_client_config.json +46 -0
  65. package/build/src/v1/index.d.ts +3 -0
  66. package/build/src/v1/index.js +8 -2
  67. package/build/src/v1/schema_service_client.d.ts +272 -2
  68. package/build/src/v1/schema_service_client.js +403 -10
  69. package/build/src/v1/search_service_client.d.ts +515 -11
  70. package/build/src/v1/search_service_client.js +649 -16
  71. package/build/src/v1/site_search_engine_service_client.d.ts +1564 -0
  72. package/build/src/v1/site_search_engine_service_client.js +2075 -0
  73. package/build/src/v1/site_search_engine_service_client_config.json +74 -0
  74. package/build/src/v1/user_event_service_client.d.ts +272 -2
  75. package/build/src/v1/user_event_service_client.js +403 -10
  76. package/build/src/v1alpha/completion_service_client.d.ts +230 -2
  77. package/build/src/v1alpha/completion_service_client.js +339 -10
  78. package/build/src/v1alpha/conversational_search_service_client.d.ts +247 -2
  79. package/build/src/v1alpha/conversational_search_service_client.js +339 -10
  80. package/build/src/v1alpha/data_store_service_client.d.ts +230 -2
  81. package/build/src/v1alpha/data_store_service_client.js +347 -12
  82. package/build/src/v1alpha/document_service_client.d.ts +230 -2
  83. package/build/src/v1alpha/document_service_client.js +347 -12
  84. package/build/src/v1alpha/engine_service_client.d.ts +231 -3
  85. package/build/src/v1alpha/engine_service_client.js +347 -12
  86. package/build/src/v1alpha/index.d.ts +1 -0
  87. package/build/src/v1alpha/index.js +4 -2
  88. package/build/src/v1alpha/recommendation_service_client.d.ts +230 -2
  89. package/build/src/v1alpha/recommendation_service_client.js +339 -10
  90. package/build/src/v1alpha/schema_service_client.d.ts +230 -2
  91. package/build/src/v1alpha/schema_service_client.js +347 -12
  92. package/build/src/v1alpha/search_service_client.d.ts +269 -2
  93. package/build/src/v1alpha/search_service_client.js +365 -10
  94. package/build/src/v1alpha/search_tuning_service_client.d.ts +977 -0
  95. package/build/src/v1alpha/search_tuning_service_client.js +1479 -0
  96. package/build/src/v1alpha/search_tuning_service_client_config.json +30 -0
  97. package/build/src/v1alpha/site_search_engine_service_client.d.ts +750 -3
  98. package/build/src/v1alpha/site_search_engine_service_client.js +838 -14
  99. package/build/src/v1alpha/site_search_engine_service_client_config.json +44 -0
  100. package/build/src/v1alpha/user_event_service_client.d.ts +230 -2
  101. package/build/src/v1alpha/user_event_service_client.js +347 -12
  102. package/build/src/v1beta/completion_service_client.d.ts +633 -7
  103. package/build/src/v1beta/completion_service_client.js +912 -12
  104. package/build/src/v1beta/completion_service_client_config.json +10 -0
  105. package/build/src/v1beta/conversational_search_service_client.d.ts +341 -3
  106. package/build/src/v1beta/conversational_search_service_client.js +467 -10
  107. package/build/src/v1beta/data_store_service_client.d.ts +1433 -0
  108. package/build/src/v1beta/data_store_service_client.js +1966 -0
  109. package/build/src/v1beta/data_store_service_client_config.json +46 -0
  110. package/build/src/v1beta/document_service_client.d.ts +491 -2
  111. package/build/src/v1beta/document_service_client.js +707 -12
  112. package/build/src/v1beta/engine_service_client.d.ts +1357 -0
  113. package/build/src/v1beta/engine_service_client.js +1928 -0
  114. package/build/src/v1beta/engine_service_client_config.json +46 -0
  115. package/build/src/v1beta/index.d.ts +4 -0
  116. package/build/src/v1beta/index.js +10 -2
  117. package/build/src/v1beta/recommendation_service_client.d.ts +420 -5
  118. package/build/src/v1beta/recommendation_service_client.js +571 -10
  119. package/build/src/v1beta/schema_service_client.d.ts +416 -2
  120. package/build/src/v1beta/schema_service_client.js +603 -12
  121. package/build/src/v1beta/search_service_client.d.ts +539 -29
  122. package/build/src/v1beta/search_service_client.js +665 -28
  123. package/build/src/v1beta/serving_config_service_client.d.ts +1102 -0
  124. package/build/src/v1beta/serving_config_service_client.js +1563 -0
  125. package/build/src/v1beta/serving_config_service_client_config.json +38 -0
  126. package/build/src/v1beta/site_search_engine_service_client.d.ts +1712 -0
  127. package/build/src/v1beta/site_search_engine_service_client.js +2271 -0
  128. package/build/src/v1beta/site_search_engine_service_client_config.json +74 -0
  129. package/build/src/v1beta/user_event_service_client.d.ts +416 -2
  130. package/build/src/v1beta/user_event_service_client.js +603 -12
  131. package/package.json +3 -3
@@ -0,0 +1,977 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, LocationsClient, LocationProtos } from 'google-gax';
3
+ import * as protos from '../../protos/protos';
4
+ /**
5
+ * Service for search tuning.
6
+ * @class
7
+ * @memberof v1alpha
8
+ */
9
+ export declare class SearchTuningServiceClient {
10
+ private _terminated;
11
+ private _opts;
12
+ private _providedCustomServicePath;
13
+ private _gaxModule;
14
+ private _gaxGrpc;
15
+ private _protos;
16
+ private _defaults;
17
+ private _universeDomain;
18
+ private _servicePath;
19
+ auth: gax.GoogleAuth;
20
+ descriptors: Descriptors;
21
+ warn: (code: string, message: string, warnType?: string) => void;
22
+ innerApiCalls: {
23
+ [name: string]: Function;
24
+ };
25
+ locationsClient: LocationsClient;
26
+ pathTemplates: {
27
+ [name: string]: gax.PathTemplate;
28
+ };
29
+ operationsClient: gax.OperationsClient;
30
+ searchTuningServiceStub?: Promise<{
31
+ [name: string]: Function;
32
+ }>;
33
+ /**
34
+ * Construct an instance of SearchTuningServiceClient.
35
+ *
36
+ * @param {object} [options] - The configuration object.
37
+ * The options accepted by the constructor are described in detail
38
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
39
+ * The common options are:
40
+ * @param {object} [options.credentials] - Credentials object.
41
+ * @param {string} [options.credentials.client_email]
42
+ * @param {string} [options.credentials.private_key]
43
+ * @param {string} [options.email] - Account email address. Required when
44
+ * using a .pem or .p12 keyFilename.
45
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
46
+ * .p12 key downloaded from the Google Developers Console. If you provide
47
+ * a path to a JSON file, the projectId option below is not necessary.
48
+ * NOTE: .pem and .p12 require you to specify options.email as well.
49
+ * @param {number} [options.port] - The port on which to connect to
50
+ * the remote host.
51
+ * @param {string} [options.projectId] - The project ID from the Google
52
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
53
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
54
+ * app is running in an environment which supports
55
+ * {@link https://developers.google.com/identity/protocols/application-default-credentials Application Default Credentials},
56
+ * your project ID will be detected automatically.
57
+ * @param {string} [options.apiEndpoint] - The domain name of the
58
+ * API remote host.
59
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
60
+ * Follows the structure of {@link gapicConfig}.
61
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
62
+ * For more information, please check the
63
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
64
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
65
+ * need to avoid loading the default gRPC version and want to use the fallback
66
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
67
+ * ```
68
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
69
+ * const client = new SearchTuningServiceClient({fallback: true}, gax);
70
+ * ```
71
+ */
72
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
73
+ /**
74
+ * Initialize the client.
75
+ * Performs asynchronous operations (such as authentication) and prepares the client.
76
+ * This function will be called automatically when any class method is called for the
77
+ * first time, but if you need to initialize it before calling an actual method,
78
+ * feel free to call initialize() directly.
79
+ *
80
+ * You can await on this method if you want to make sure the client is initialized.
81
+ *
82
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
83
+ */
84
+ initialize(): Promise<{
85
+ [name: string]: Function;
86
+ }>;
87
+ /**
88
+ * The DNS address for this API service.
89
+ * @deprecated Use the apiEndpoint method of the client instance.
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
+ * @deprecated Use the apiEndpoint method of the client instance.
96
+ * @returns {string} The DNS address for this service.
97
+ */
98
+ static get apiEndpoint(): string;
99
+ /**
100
+ * The DNS address for this API service.
101
+ * @returns {string} The DNS address for this service.
102
+ */
103
+ get apiEndpoint(): string;
104
+ get universeDomain(): string;
105
+ /**
106
+ * The port for this API service.
107
+ * @returns {number} The default port for this service.
108
+ */
109
+ static get port(): number;
110
+ /**
111
+ * The scopes needed to make gRPC calls for every method defined
112
+ * in this service.
113
+ * @returns {string[]} List of default scopes.
114
+ */
115
+ static get scopes(): string[];
116
+ getProjectId(): Promise<string>;
117
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
118
+ /**
119
+ * Trains a custom model.
120
+ *
121
+ * @param {Object} request
122
+ * The request object that will be sent.
123
+ * @param {google.cloud.discoveryengine.v1alpha.TrainCustomModelRequest.GcsTrainingInput} request.gcsTrainingInput
124
+ * Gcs training input.
125
+ * @param {string} request.dataStore
126
+ * Required. The resource name of the Data Store, such as
127
+ * `projects/* /locations/global/collections/default_collection/dataStores/default_data_store`.
128
+ * This field is used to identify the data store where to train the models.
129
+ * @param {string} request.modelType
130
+ * Model to be trained. Supported values are:
131
+ *
132
+ * * **search-tuning**: Fine tuning the search system based on data provided.
133
+ * @param {google.cloud.discoveryengine.v1alpha.ImportErrorConfig} request.errorConfig
134
+ * The desired location of errors incurred during the data ingestion and
135
+ * training.
136
+ * @param {object} [options]
137
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
138
+ * @returns {Promise} - The promise which resolves to an array.
139
+ * The first element of the array is an object representing
140
+ * a long running operation. Its `promise()` method returns a promise
141
+ * you can `await` for.
142
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
143
+ * for more details and examples.
144
+ * @example <caption>include:samples/generated/v1alpha/search_tuning_service.train_custom_model.js</caption>
145
+ * region_tag:discoveryengine_v1alpha_generated_SearchTuningService_TrainCustomModel_async
146
+ */
147
+ trainCustomModel(request?: protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelRequest, options?: CallOptions): Promise<[
148
+ LROperation<protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelResponse, protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelMetadata>,
149
+ protos.google.longrunning.IOperation | undefined,
150
+ {} | undefined
151
+ ]>;
152
+ trainCustomModel(request: protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelResponse, protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
153
+ trainCustomModel(request: protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelRequest, callback: Callback<LROperation<protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelResponse, protos.google.cloud.discoveryengine.v1alpha.ITrainCustomModelMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
154
+ /**
155
+ * Check the status of the long running operation returned by `trainCustomModel()`.
156
+ * @param {String} name
157
+ * The operation name that will be passed.
158
+ * @returns {Promise} - The promise which resolves to an object.
159
+ * The decoded operation object has result and metadata field to get information from.
160
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
161
+ * for more details and examples.
162
+ * @example <caption>include:samples/generated/v1alpha/search_tuning_service.train_custom_model.js</caption>
163
+ * region_tag:discoveryengine_v1alpha_generated_SearchTuningService_TrainCustomModel_async
164
+ */
165
+ checkTrainCustomModelProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1alpha.TrainCustomModelResponse, protos.google.cloud.discoveryengine.v1alpha.TrainCustomModelMetadata>>;
166
+ /**
167
+ * Gets information about a location.
168
+ *
169
+ * @param {Object} request
170
+ * The request object that will be sent.
171
+ * @param {string} request.name
172
+ * Resource name for the location.
173
+ * @param {object} [options]
174
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
175
+ * @returns {Promise} - The promise which resolves to an array.
176
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
177
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
178
+ * for more details and examples.
179
+ * @example
180
+ * ```
181
+ * const [response] = await client.getLocation(request);
182
+ * ```
183
+ */
184
+ 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>;
185
+ /**
186
+ * Lists information about the supported locations for this service. Returns an iterable object.
187
+ *
188
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
189
+ * @param {Object} request
190
+ * The request object that will be sent.
191
+ * @param {string} request.name
192
+ * The resource that owns the locations collection, if applicable.
193
+ * @param {string} request.filter
194
+ * The standard list filter.
195
+ * @param {number} request.pageSize
196
+ * The standard list page size.
197
+ * @param {string} request.pageToken
198
+ * The standard list page token.
199
+ * @param {object} [options]
200
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
201
+ * @returns {Object}
202
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
203
+ * When you iterate the returned iterable, each element will be an object representing
204
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
205
+ * so you can stop the iteration when you don't need more results.
206
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
207
+ * for more details and examples.
208
+ * @example
209
+ * ```
210
+ * const iterable = client.listLocationsAsync(request);
211
+ * for await (const response of iterable) {
212
+ * // process response
213
+ * }
214
+ * ```
215
+ */
216
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
217
+ /**
218
+ * Gets the latest state of a long-running operation. Clients can use this
219
+ * method to poll the operation result at intervals as recommended by the API
220
+ * service.
221
+ *
222
+ * @param {Object} request - The request object that will be sent.
223
+ * @param {string} request.name - The name of the operation resource.
224
+ * @param {Object=} options
225
+ * Optional parameters. You can override the default settings for this call,
226
+ * e.g, timeout, retries, paginations, etc. See {@link
227
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
228
+ * for the details.
229
+ * @param {function(?Error, ?Object)=} callback
230
+ * The function which will be called with the result of the API call.
231
+ *
232
+ * The second parameter to the callback is an object representing
233
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
234
+ * @return {Promise} - The promise which resolves to an array.
235
+ * The first element of the array is an object representing
236
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
237
+ * The promise has a method named "cancel" which cancels the ongoing API call.
238
+ *
239
+ * @example
240
+ * ```
241
+ * const client = longrunning.operationsClient();
242
+ * const name = '';
243
+ * const [response] = await client.getOperation({name});
244
+ * // doThingsWith(response)
245
+ * ```
246
+ */
247
+ 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]>;
248
+ /**
249
+ * Lists operations that match the specified filter in the request. If the
250
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
251
+ *
252
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
253
+ *
254
+ * @param {Object} request - The request object that will be sent.
255
+ * @param {string} request.name - The name of the operation collection.
256
+ * @param {string} request.filter - The standard list filter.
257
+ * @param {number=} request.pageSize -
258
+ * The maximum number of resources contained in the underlying API
259
+ * response. If page streaming is performed per-resource, this
260
+ * parameter does not affect the return value. If page streaming is
261
+ * performed per-page, this determines the maximum number of
262
+ * resources in a page.
263
+ * @param {Object=} options
264
+ * Optional parameters. You can override the default settings for this call,
265
+ * e.g, timeout, retries, paginations, etc. See {@link
266
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
267
+ * details.
268
+ * @returns {Object}
269
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
270
+ *
271
+ * @example
272
+ * ```
273
+ * const client = longrunning.operationsClient();
274
+ * for await (const response of client.listOperationsAsync(request));
275
+ * // doThingsWith(response)
276
+ * ```
277
+ */
278
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.ListOperationsResponse>;
279
+ /**
280
+ * Starts asynchronous cancellation on a long-running operation. The server
281
+ * makes a best effort to cancel the operation, but success is not
282
+ * guaranteed. If the server doesn't support this method, it returns
283
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
284
+ * {@link Operations.GetOperation} or
285
+ * other methods to check whether the cancellation succeeded or whether the
286
+ * operation completed despite cancellation. On successful cancellation,
287
+ * the operation is not deleted; instead, it becomes an operation with
288
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
289
+ * 1, corresponding to `Code.CANCELLED`.
290
+ *
291
+ * @param {Object} request - The request object that will be sent.
292
+ * @param {string} request.name - The name of the operation resource to be cancelled.
293
+ * @param {Object=} options
294
+ * Optional parameters. You can override the default settings for this call,
295
+ * e.g, timeout, retries, paginations, etc. See {@link
296
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
297
+ * details.
298
+ * @param {function(?Error)=} callback
299
+ * The function which will be called with the result of the API call.
300
+ * @return {Promise} - The promise which resolves when API call finishes.
301
+ * The promise has a method named "cancel" which cancels the ongoing API
302
+ * call.
303
+ *
304
+ * @example
305
+ * ```
306
+ * const client = longrunning.operationsClient();
307
+ * await client.cancelOperation({name: ''});
308
+ * ```
309
+ */
310
+ 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>;
311
+ /**
312
+ * Deletes a long-running operation. This method indicates that the client is
313
+ * no longer interested in the operation result. It does not cancel the
314
+ * operation. If the server doesn't support this method, it returns
315
+ * `google.rpc.Code.UNIMPLEMENTED`.
316
+ *
317
+ * @param {Object} request - The request object that will be sent.
318
+ * @param {string} request.name - The name of the operation resource to be deleted.
319
+ * @param {Object=} options
320
+ * Optional parameters. You can override the default settings for this call,
321
+ * e.g, timeout, retries, paginations, etc. See {@link
322
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
323
+ * for the details.
324
+ * @param {function(?Error)=} callback
325
+ * The function which will be called with the result of the API call.
326
+ * @return {Promise} - The promise which resolves when API call finishes.
327
+ * The promise has a method named "cancel" which cancels the ongoing API
328
+ * call.
329
+ *
330
+ * @example
331
+ * ```
332
+ * const client = longrunning.operationsClient();
333
+ * await client.deleteOperation({name: ''});
334
+ * ```
335
+ */
336
+ 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>;
337
+ /**
338
+ * Return a fully-qualified engine resource name string.
339
+ *
340
+ * @param {string} project
341
+ * @param {string} location
342
+ * @param {string} collection
343
+ * @param {string} engine
344
+ * @returns {string} Resource name string.
345
+ */
346
+ enginePath(project: string, location: string, collection: string, engine: string): string;
347
+ /**
348
+ * Parse the project from Engine resource.
349
+ *
350
+ * @param {string} engineName
351
+ * A fully-qualified path representing Engine resource.
352
+ * @returns {string} A string representing the project.
353
+ */
354
+ matchProjectFromEngineName(engineName: string): string | number;
355
+ /**
356
+ * Parse the location from Engine resource.
357
+ *
358
+ * @param {string} engineName
359
+ * A fully-qualified path representing Engine resource.
360
+ * @returns {string} A string representing the location.
361
+ */
362
+ matchLocationFromEngineName(engineName: string): string | number;
363
+ /**
364
+ * Parse the collection from Engine resource.
365
+ *
366
+ * @param {string} engineName
367
+ * A fully-qualified path representing Engine resource.
368
+ * @returns {string} A string representing the collection.
369
+ */
370
+ matchCollectionFromEngineName(engineName: string): string | number;
371
+ /**
372
+ * Parse the engine from Engine resource.
373
+ *
374
+ * @param {string} engineName
375
+ * A fully-qualified path representing Engine resource.
376
+ * @returns {string} A string representing the engine.
377
+ */
378
+ matchEngineFromEngineName(engineName: string): string | number;
379
+ /**
380
+ * Return a fully-qualified projectLocationCollectionDataStore resource name string.
381
+ *
382
+ * @param {string} project
383
+ * @param {string} location
384
+ * @param {string} collection
385
+ * @param {string} data_store
386
+ * @returns {string} Resource name string.
387
+ */
388
+ projectLocationCollectionDataStorePath(project: string, location: string, collection: string, dataStore: string): string;
389
+ /**
390
+ * Parse the project from ProjectLocationCollectionDataStore resource.
391
+ *
392
+ * @param {string} projectLocationCollectionDataStoreName
393
+ * A fully-qualified path representing project_location_collection_data_store resource.
394
+ * @returns {string} A string representing the project.
395
+ */
396
+ matchProjectFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
397
+ /**
398
+ * Parse the location from ProjectLocationCollectionDataStore resource.
399
+ *
400
+ * @param {string} projectLocationCollectionDataStoreName
401
+ * A fully-qualified path representing project_location_collection_data_store resource.
402
+ * @returns {string} A string representing the location.
403
+ */
404
+ matchLocationFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
405
+ /**
406
+ * Parse the collection from ProjectLocationCollectionDataStore resource.
407
+ *
408
+ * @param {string} projectLocationCollectionDataStoreName
409
+ * A fully-qualified path representing project_location_collection_data_store resource.
410
+ * @returns {string} A string representing the collection.
411
+ */
412
+ matchCollectionFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
413
+ /**
414
+ * Parse the data_store from ProjectLocationCollectionDataStore resource.
415
+ *
416
+ * @param {string} projectLocationCollectionDataStoreName
417
+ * A fully-qualified path representing project_location_collection_data_store resource.
418
+ * @returns {string} A string representing the data_store.
419
+ */
420
+ matchDataStoreFromProjectLocationCollectionDataStoreName(projectLocationCollectionDataStoreName: string): string | number;
421
+ /**
422
+ * Return a fully-qualified projectLocationCollectionDataStoreBranchDocument resource name string.
423
+ *
424
+ * @param {string} project
425
+ * @param {string} location
426
+ * @param {string} collection
427
+ * @param {string} data_store
428
+ * @param {string} branch
429
+ * @param {string} document
430
+ * @returns {string} Resource name string.
431
+ */
432
+ projectLocationCollectionDataStoreBranchDocumentPath(project: string, location: string, collection: string, dataStore: string, branch: string, document: string): string;
433
+ /**
434
+ * Parse the project from ProjectLocationCollectionDataStoreBranchDocument resource.
435
+ *
436
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
437
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
438
+ * @returns {string} A string representing the project.
439
+ */
440
+ matchProjectFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
441
+ /**
442
+ * Parse the location from ProjectLocationCollectionDataStoreBranchDocument resource.
443
+ *
444
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
445
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
446
+ * @returns {string} A string representing the location.
447
+ */
448
+ matchLocationFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
449
+ /**
450
+ * Parse the collection from ProjectLocationCollectionDataStoreBranchDocument resource.
451
+ *
452
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
453
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
454
+ * @returns {string} A string representing the collection.
455
+ */
456
+ matchCollectionFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
457
+ /**
458
+ * Parse the data_store from ProjectLocationCollectionDataStoreBranchDocument resource.
459
+ *
460
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
461
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
462
+ * @returns {string} A string representing the data_store.
463
+ */
464
+ matchDataStoreFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
465
+ /**
466
+ * Parse the branch from ProjectLocationCollectionDataStoreBranchDocument resource.
467
+ *
468
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
469
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
470
+ * @returns {string} A string representing the branch.
471
+ */
472
+ matchBranchFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
473
+ /**
474
+ * Parse the document from ProjectLocationCollectionDataStoreBranchDocument resource.
475
+ *
476
+ * @param {string} projectLocationCollectionDataStoreBranchDocumentName
477
+ * A fully-qualified path representing project_location_collection_data_store_branch_document resource.
478
+ * @returns {string} A string representing the document.
479
+ */
480
+ matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
481
+ /**
482
+ * Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
483
+ *
484
+ * @param {string} project
485
+ * @param {string} location
486
+ * @param {string} collection
487
+ * @param {string} data_store
488
+ * @param {string} conversation
489
+ * @returns {string} Resource name string.
490
+ */
491
+ projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
492
+ /**
493
+ * Parse the project from ProjectLocationCollectionDataStoreConversation resource.
494
+ *
495
+ * @param {string} projectLocationCollectionDataStoreConversationName
496
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
497
+ * @returns {string} A string representing the project.
498
+ */
499
+ matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
500
+ /**
501
+ * Parse the location from ProjectLocationCollectionDataStoreConversation resource.
502
+ *
503
+ * @param {string} projectLocationCollectionDataStoreConversationName
504
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
505
+ * @returns {string} A string representing the location.
506
+ */
507
+ matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
508
+ /**
509
+ * Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
510
+ *
511
+ * @param {string} projectLocationCollectionDataStoreConversationName
512
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
513
+ * @returns {string} A string representing the collection.
514
+ */
515
+ matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
516
+ /**
517
+ * Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
518
+ *
519
+ * @param {string} projectLocationCollectionDataStoreConversationName
520
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
521
+ * @returns {string} A string representing the data_store.
522
+ */
523
+ matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
524
+ /**
525
+ * Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
526
+ *
527
+ * @param {string} projectLocationCollectionDataStoreConversationName
528
+ * A fully-qualified path representing project_location_collection_data_store_conversation resource.
529
+ * @returns {string} A string representing the conversation.
530
+ */
531
+ matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
532
+ /**
533
+ * Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
534
+ *
535
+ * @param {string} project
536
+ * @param {string} location
537
+ * @param {string} collection
538
+ * @param {string} data_store
539
+ * @param {string} schema
540
+ * @returns {string} Resource name string.
541
+ */
542
+ projectLocationCollectionDataStoreSchemaPath(project: string, location: string, collection: string, dataStore: string, schema: string): string;
543
+ /**
544
+ * Parse the project from ProjectLocationCollectionDataStoreSchema resource.
545
+ *
546
+ * @param {string} projectLocationCollectionDataStoreSchemaName
547
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
548
+ * @returns {string} A string representing the project.
549
+ */
550
+ matchProjectFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
551
+ /**
552
+ * Parse the location from ProjectLocationCollectionDataStoreSchema resource.
553
+ *
554
+ * @param {string} projectLocationCollectionDataStoreSchemaName
555
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
556
+ * @returns {string} A string representing the location.
557
+ */
558
+ matchLocationFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
559
+ /**
560
+ * Parse the collection from ProjectLocationCollectionDataStoreSchema resource.
561
+ *
562
+ * @param {string} projectLocationCollectionDataStoreSchemaName
563
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
564
+ * @returns {string} A string representing the collection.
565
+ */
566
+ matchCollectionFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
567
+ /**
568
+ * Parse the data_store from ProjectLocationCollectionDataStoreSchema resource.
569
+ *
570
+ * @param {string} projectLocationCollectionDataStoreSchemaName
571
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
572
+ * @returns {string} A string representing the data_store.
573
+ */
574
+ matchDataStoreFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
575
+ /**
576
+ * Parse the schema from ProjectLocationCollectionDataStoreSchema resource.
577
+ *
578
+ * @param {string} projectLocationCollectionDataStoreSchemaName
579
+ * A fully-qualified path representing project_location_collection_data_store_schema resource.
580
+ * @returns {string} A string representing the schema.
581
+ */
582
+ matchSchemaFromProjectLocationCollectionDataStoreSchemaName(projectLocationCollectionDataStoreSchemaName: string): string | number;
583
+ /**
584
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngine resource name string.
585
+ *
586
+ * @param {string} project
587
+ * @param {string} location
588
+ * @param {string} collection
589
+ * @param {string} data_store
590
+ * @returns {string} Resource name string.
591
+ */
592
+ projectLocationCollectionDataStoreSiteSearchEnginePath(project: string, location: string, collection: string, dataStore: string): string;
593
+ /**
594
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
595
+ *
596
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
597
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
598
+ * @returns {string} A string representing the project.
599
+ */
600
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
601
+ /**
602
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
603
+ *
604
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
605
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
606
+ * @returns {string} A string representing the location.
607
+ */
608
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
609
+ /**
610
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
611
+ *
612
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
613
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
614
+ * @returns {string} A string representing the collection.
615
+ */
616
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
617
+ /**
618
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngine resource.
619
+ *
620
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineName
621
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine resource.
622
+ * @returns {string} A string representing the data_store.
623
+ */
624
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineName(projectLocationCollectionDataStoreSiteSearchEngineName: string): string | number;
625
+ /**
626
+ * Return a fully-qualified projectLocationCollectionDataStoreSiteSearchEngineTargetSite resource name string.
627
+ *
628
+ * @param {string} project
629
+ * @param {string} location
630
+ * @param {string} collection
631
+ * @param {string} data_store
632
+ * @param {string} target_site
633
+ * @returns {string} Resource name string.
634
+ */
635
+ projectLocationCollectionDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, collection: string, dataStore: string, targetSite: string): string;
636
+ /**
637
+ * Parse the project from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
638
+ *
639
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
640
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
641
+ * @returns {string} A string representing the project.
642
+ */
643
+ matchProjectFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
644
+ /**
645
+ * Parse the location from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
646
+ *
647
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
648
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
649
+ * @returns {string} A string representing the location.
650
+ */
651
+ matchLocationFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
652
+ /**
653
+ * Parse the collection from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
654
+ *
655
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
656
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
657
+ * @returns {string} A string representing the collection.
658
+ */
659
+ matchCollectionFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
660
+ /**
661
+ * Parse the data_store from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
662
+ *
663
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
664
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
665
+ * @returns {string} A string representing the data_store.
666
+ */
667
+ matchDataStoreFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
668
+ /**
669
+ * Parse the target_site from ProjectLocationCollectionDataStoreSiteSearchEngineTargetSite resource.
670
+ *
671
+ * @param {string} projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName
672
+ * A fully-qualified path representing project_location_collection_data_store_siteSearchEngine_target_site resource.
673
+ * @returns {string} A string representing the target_site.
674
+ */
675
+ matchTargetSiteFromProjectLocationCollectionDataStoreSiteSearchEngineTargetSiteName(projectLocationCollectionDataStoreSiteSearchEngineTargetSiteName: string): string | number;
676
+ /**
677
+ * Return a fully-qualified projectLocationCollectionEngineConversation resource name string.
678
+ *
679
+ * @param {string} project
680
+ * @param {string} location
681
+ * @param {string} collection
682
+ * @param {string} engine
683
+ * @param {string} conversation
684
+ * @returns {string} Resource name string.
685
+ */
686
+ projectLocationCollectionEngineConversationPath(project: string, location: string, collection: string, engine: string, conversation: string): string;
687
+ /**
688
+ * Parse the project from ProjectLocationCollectionEngineConversation resource.
689
+ *
690
+ * @param {string} projectLocationCollectionEngineConversationName
691
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
692
+ * @returns {string} A string representing the project.
693
+ */
694
+ matchProjectFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
695
+ /**
696
+ * Parse the location from ProjectLocationCollectionEngineConversation resource.
697
+ *
698
+ * @param {string} projectLocationCollectionEngineConversationName
699
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
700
+ * @returns {string} A string representing the location.
701
+ */
702
+ matchLocationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
703
+ /**
704
+ * Parse the collection from ProjectLocationCollectionEngineConversation resource.
705
+ *
706
+ * @param {string} projectLocationCollectionEngineConversationName
707
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
708
+ * @returns {string} A string representing the collection.
709
+ */
710
+ matchCollectionFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
711
+ /**
712
+ * Parse the engine from ProjectLocationCollectionEngineConversation resource.
713
+ *
714
+ * @param {string} projectLocationCollectionEngineConversationName
715
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
716
+ * @returns {string} A string representing the engine.
717
+ */
718
+ matchEngineFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
719
+ /**
720
+ * Parse the conversation from ProjectLocationCollectionEngineConversation resource.
721
+ *
722
+ * @param {string} projectLocationCollectionEngineConversationName
723
+ * A fully-qualified path representing project_location_collection_engine_conversation resource.
724
+ * @returns {string} A string representing the conversation.
725
+ */
726
+ matchConversationFromProjectLocationCollectionEngineConversationName(projectLocationCollectionEngineConversationName: string): string | number;
727
+ /**
728
+ * Return a fully-qualified projectLocationDataStore resource name string.
729
+ *
730
+ * @param {string} project
731
+ * @param {string} location
732
+ * @param {string} data_store
733
+ * @returns {string} Resource name string.
734
+ */
735
+ projectLocationDataStorePath(project: string, location: string, dataStore: string): string;
736
+ /**
737
+ * Parse the project from ProjectLocationDataStore resource.
738
+ *
739
+ * @param {string} projectLocationDataStoreName
740
+ * A fully-qualified path representing project_location_data_store resource.
741
+ * @returns {string} A string representing the project.
742
+ */
743
+ matchProjectFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
744
+ /**
745
+ * Parse the location from ProjectLocationDataStore resource.
746
+ *
747
+ * @param {string} projectLocationDataStoreName
748
+ * A fully-qualified path representing project_location_data_store resource.
749
+ * @returns {string} A string representing the location.
750
+ */
751
+ matchLocationFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
752
+ /**
753
+ * Parse the data_store from ProjectLocationDataStore resource.
754
+ *
755
+ * @param {string} projectLocationDataStoreName
756
+ * A fully-qualified path representing project_location_data_store resource.
757
+ * @returns {string} A string representing the data_store.
758
+ */
759
+ matchDataStoreFromProjectLocationDataStoreName(projectLocationDataStoreName: string): string | number;
760
+ /**
761
+ * Return a fully-qualified projectLocationDataStoreBranchDocument resource name string.
762
+ *
763
+ * @param {string} project
764
+ * @param {string} location
765
+ * @param {string} data_store
766
+ * @param {string} branch
767
+ * @param {string} document
768
+ * @returns {string} Resource name string.
769
+ */
770
+ projectLocationDataStoreBranchDocumentPath(project: string, location: string, dataStore: string, branch: string, document: string): string;
771
+ /**
772
+ * Parse the project from ProjectLocationDataStoreBranchDocument resource.
773
+ *
774
+ * @param {string} projectLocationDataStoreBranchDocumentName
775
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
776
+ * @returns {string} A string representing the project.
777
+ */
778
+ matchProjectFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
779
+ /**
780
+ * Parse the location from ProjectLocationDataStoreBranchDocument resource.
781
+ *
782
+ * @param {string} projectLocationDataStoreBranchDocumentName
783
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
784
+ * @returns {string} A string representing the location.
785
+ */
786
+ matchLocationFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
787
+ /**
788
+ * Parse the data_store from ProjectLocationDataStoreBranchDocument resource.
789
+ *
790
+ * @param {string} projectLocationDataStoreBranchDocumentName
791
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
792
+ * @returns {string} A string representing the data_store.
793
+ */
794
+ matchDataStoreFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
795
+ /**
796
+ * Parse the branch from ProjectLocationDataStoreBranchDocument resource.
797
+ *
798
+ * @param {string} projectLocationDataStoreBranchDocumentName
799
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
800
+ * @returns {string} A string representing the branch.
801
+ */
802
+ matchBranchFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
803
+ /**
804
+ * Parse the document from ProjectLocationDataStoreBranchDocument resource.
805
+ *
806
+ * @param {string} projectLocationDataStoreBranchDocumentName
807
+ * A fully-qualified path representing project_location_data_store_branch_document resource.
808
+ * @returns {string} A string representing the document.
809
+ */
810
+ matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
811
+ /**
812
+ * Return a fully-qualified projectLocationDataStoreConversation resource name string.
813
+ *
814
+ * @param {string} project
815
+ * @param {string} location
816
+ * @param {string} data_store
817
+ * @param {string} conversation
818
+ * @returns {string} Resource name string.
819
+ */
820
+ projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
821
+ /**
822
+ * Parse the project from ProjectLocationDataStoreConversation resource.
823
+ *
824
+ * @param {string} projectLocationDataStoreConversationName
825
+ * A fully-qualified path representing project_location_data_store_conversation resource.
826
+ * @returns {string} A string representing the project.
827
+ */
828
+ matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
829
+ /**
830
+ * Parse the location from ProjectLocationDataStoreConversation resource.
831
+ *
832
+ * @param {string} projectLocationDataStoreConversationName
833
+ * A fully-qualified path representing project_location_data_store_conversation resource.
834
+ * @returns {string} A string representing the location.
835
+ */
836
+ matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
837
+ /**
838
+ * Parse the data_store from ProjectLocationDataStoreConversation resource.
839
+ *
840
+ * @param {string} projectLocationDataStoreConversationName
841
+ * A fully-qualified path representing project_location_data_store_conversation resource.
842
+ * @returns {string} A string representing the data_store.
843
+ */
844
+ matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
845
+ /**
846
+ * Parse the conversation from ProjectLocationDataStoreConversation resource.
847
+ *
848
+ * @param {string} projectLocationDataStoreConversationName
849
+ * A fully-qualified path representing project_location_data_store_conversation resource.
850
+ * @returns {string} A string representing the conversation.
851
+ */
852
+ matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
853
+ /**
854
+ * Return a fully-qualified projectLocationDataStoreSchema resource name string.
855
+ *
856
+ * @param {string} project
857
+ * @param {string} location
858
+ * @param {string} data_store
859
+ * @param {string} schema
860
+ * @returns {string} Resource name string.
861
+ */
862
+ projectLocationDataStoreSchemaPath(project: string, location: string, dataStore: string, schema: string): string;
863
+ /**
864
+ * Parse the project from ProjectLocationDataStoreSchema resource.
865
+ *
866
+ * @param {string} projectLocationDataStoreSchemaName
867
+ * A fully-qualified path representing project_location_data_store_schema resource.
868
+ * @returns {string} A string representing the project.
869
+ */
870
+ matchProjectFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
871
+ /**
872
+ * Parse the location from ProjectLocationDataStoreSchema resource.
873
+ *
874
+ * @param {string} projectLocationDataStoreSchemaName
875
+ * A fully-qualified path representing project_location_data_store_schema resource.
876
+ * @returns {string} A string representing the location.
877
+ */
878
+ matchLocationFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
879
+ /**
880
+ * Parse the data_store from ProjectLocationDataStoreSchema resource.
881
+ *
882
+ * @param {string} projectLocationDataStoreSchemaName
883
+ * A fully-qualified path representing project_location_data_store_schema resource.
884
+ * @returns {string} A string representing the data_store.
885
+ */
886
+ matchDataStoreFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
887
+ /**
888
+ * Parse the schema from ProjectLocationDataStoreSchema resource.
889
+ *
890
+ * @param {string} projectLocationDataStoreSchemaName
891
+ * A fully-qualified path representing project_location_data_store_schema resource.
892
+ * @returns {string} A string representing the schema.
893
+ */
894
+ matchSchemaFromProjectLocationDataStoreSchemaName(projectLocationDataStoreSchemaName: string): string | number;
895
+ /**
896
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngine resource name string.
897
+ *
898
+ * @param {string} project
899
+ * @param {string} location
900
+ * @param {string} data_store
901
+ * @returns {string} Resource name string.
902
+ */
903
+ projectLocationDataStoreSiteSearchEnginePath(project: string, location: string, dataStore: string): string;
904
+ /**
905
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngine resource.
906
+ *
907
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
908
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
909
+ * @returns {string} A string representing the project.
910
+ */
911
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
912
+ /**
913
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngine resource.
914
+ *
915
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
916
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
917
+ * @returns {string} A string representing the location.
918
+ */
919
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
920
+ /**
921
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngine resource.
922
+ *
923
+ * @param {string} projectLocationDataStoreSiteSearchEngineName
924
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine resource.
925
+ * @returns {string} A string representing the data_store.
926
+ */
927
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineName(projectLocationDataStoreSiteSearchEngineName: string): string | number;
928
+ /**
929
+ * Return a fully-qualified projectLocationDataStoreSiteSearchEngineTargetSite resource name string.
930
+ *
931
+ * @param {string} project
932
+ * @param {string} location
933
+ * @param {string} data_store
934
+ * @param {string} target_site
935
+ * @returns {string} Resource name string.
936
+ */
937
+ projectLocationDataStoreSiteSearchEngineTargetSitePath(project: string, location: string, dataStore: string, targetSite: string): string;
938
+ /**
939
+ * Parse the project from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
940
+ *
941
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
942
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
943
+ * @returns {string} A string representing the project.
944
+ */
945
+ matchProjectFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
946
+ /**
947
+ * Parse the location from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
948
+ *
949
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
950
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
951
+ * @returns {string} A string representing the location.
952
+ */
953
+ matchLocationFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
954
+ /**
955
+ * Parse the data_store from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
956
+ *
957
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
958
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
959
+ * @returns {string} A string representing the data_store.
960
+ */
961
+ matchDataStoreFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
962
+ /**
963
+ * Parse the target_site from ProjectLocationDataStoreSiteSearchEngineTargetSite resource.
964
+ *
965
+ * @param {string} projectLocationDataStoreSiteSearchEngineTargetSiteName
966
+ * A fully-qualified path representing project_location_data_store_siteSearchEngine_target_site resource.
967
+ * @returns {string} A string representing the target_site.
968
+ */
969
+ matchTargetSiteFromProjectLocationDataStoreSiteSearchEngineTargetSiteName(projectLocationDataStoreSiteSearchEngineTargetSiteName: string): string | number;
970
+ /**
971
+ * Terminate the gRPC channel and close the client.
972
+ *
973
+ * The client will no longer be usable and all future behavior is undefined.
974
+ * @returns {Promise} A promise that resolves when the client is closed.
975
+ */
976
+ close(): Promise<void>;
977
+ }