@google-cloud/discoveryengine 0.8.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +30 -0
- package/README.md +13 -1
- package/build/protos/google/cloud/discoveryengine/v1/common.proto +30 -2
- package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +15 -2
- package/build/protos/google/cloud/discoveryengine/v1/conversation.proto +114 -0
- package/build/protos/google/cloud/discoveryengine/v1/conversational_search_service.proto +303 -0
- package/build/protos/google/cloud/discoveryengine/v1/document.proto +8 -5
- package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +4 -3
- package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +27 -23
- package/build/protos/google/cloud/discoveryengine/v1/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +428 -20
- package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +48 -39
- package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +2 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/common.proto +7 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/completion_service.proto +13 -2
- package/build/protos/google/cloud/discoveryengine/v1beta/conversation.proto +138 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/conversational_search_service.proto +306 -0
- package/build/protos/google/cloud/discoveryengine/v1beta/document.proto +2 -4
- package/build/protos/google/cloud/discoveryengine/v1beta/document_service.proto +2 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +17 -17
- package/build/protos/google/cloud/discoveryengine/v1beta/schema.proto +1 -1
- package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +276 -64
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event.proto +45 -36
- package/build/protos/google/cloud/discoveryengine/v1beta/user_event_service.proto +2 -2
- package/build/protos/protos.d.ts +13913 -8367
- package/build/protos/protos.js +36766 -22883
- package/build/protos/protos.json +3956 -2571
- package/build/src/index.d.ts +4 -1
- package/build/src/index.js +4 -1
- package/build/src/v1/completion_service_client.d.ts +161 -12
- package/build/src/v1/completion_service_client.js +188 -4
- package/build/src/v1/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1/conversational_search_service_client.js +1205 -0
- package/build/src/v1/conversational_search_service_client_config.json +68 -0
- package/build/src/v1/document_service_client.d.ts +245 -109
- package/build/src/v1/document_service_client.js +231 -31
- package/build/src/v1/index.d.ts +1 -0
- package/build/src/v1/index.js +3 -1
- package/build/src/v1/schema_service_client.d.ts +187 -53
- package/build/src/v1/schema_service_client.js +224 -27
- package/build/src/v1/search_service_client.d.ts +266 -59
- package/build/src/v1/search_service_client.js +267 -41
- package/build/src/v1/user_event_service_client.d.ts +159 -19
- package/build/src/v1/user_event_service_client.js +208 -7
- package/build/src/v1beta/completion_service_client.d.ts +159 -12
- package/build/src/v1beta/completion_service_client.js +188 -4
- package/build/src/v1beta/conversational_search_service_client.d.ts +947 -0
- package/build/src/v1beta/conversational_search_service_client.js +1205 -0
- package/build/src/v1beta/conversational_search_service_client_config.json +68 -0
- package/build/src/v1beta/document_service_client.d.ts +237 -101
- package/build/src/v1beta/document_service_client.js +227 -27
- package/build/src/v1beta/index.d.ts +1 -0
- package/build/src/v1beta/index.js +3 -1
- package/build/src/v1beta/recommendation_service_client.d.ts +158 -15
- package/build/src/v1beta/recommendation_service_client.js +188 -4
- package/build/src/v1beta/schema_service_client.d.ts +187 -53
- package/build/src/v1beta/schema_service_client.js +224 -27
- package/build/src/v1beta/search_service_client.d.ts +305 -71
- package/build/src/v1beta/search_service_client.js +293 -49
- package/build/src/v1beta/user_event_service_client.d.ts +156 -16
- package/build/src/v1beta/user_event_service_client.js +208 -7
- package/package.json +10 -13
@@ -1,10 +1,10 @@
|
|
1
1
|
/// <reference types="node" />
|
2
2
|
import type * as gax from 'google-gax';
|
3
|
-
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
|
3
|
+
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
|
4
4
|
import { Transform } from 'stream';
|
5
5
|
import * as protos from '../../protos/protos';
|
6
6
|
/**
|
7
|
-
* Service for ingesting {@link google.cloud.discoveryengine.v1.Document|Document}
|
7
|
+
* Service for ingesting {@link protos.google.cloud.discoveryengine.v1.Document|Document}
|
8
8
|
* information of the customer's website.
|
9
9
|
* @class
|
10
10
|
* @memberof v1
|
@@ -23,6 +23,7 @@ export declare class DocumentServiceClient {
|
|
23
23
|
innerApiCalls: {
|
24
24
|
[name: string]: Function;
|
25
25
|
};
|
26
|
+
locationsClient: LocationsClient;
|
26
27
|
pathTemplates: {
|
27
28
|
[name: string]: gax.PathTemplate;
|
28
29
|
};
|
@@ -58,8 +59,7 @@ export declare class DocumentServiceClient {
|
|
58
59
|
* API remote host.
|
59
60
|
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
|
60
61
|
* Follows the structure of {@link gapicConfig}.
|
61
|
-
* @param {boolean
|
62
|
-
* Pass "rest" to use HTTP/1.1 REST API instead of gRPC.
|
62
|
+
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
|
63
63
|
* For more information, please check the
|
64
64
|
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
|
65
65
|
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
|
@@ -67,7 +67,7 @@ export declare class DocumentServiceClient {
|
|
67
67
|
* HTTP implementation. Load only fallback version and pass it to the constructor:
|
68
68
|
* ```
|
69
69
|
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
|
70
|
-
* const client = new DocumentServiceClient({fallback:
|
70
|
+
* const client = new DocumentServiceClient({fallback: true}, gax);
|
71
71
|
* ```
|
72
72
|
*/
|
73
73
|
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
|
@@ -110,27 +110,26 @@ export declare class DocumentServiceClient {
|
|
110
110
|
getProjectId(): Promise<string>;
|
111
111
|
getProjectId(callback: Callback<string, undefined, undefined>): void;
|
112
112
|
/**
|
113
|
-
* Gets a {@link google.cloud.discoveryengine.v1.Document|Document}.
|
113
|
+
* Gets a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
114
114
|
*
|
115
115
|
* @param {Object} request
|
116
116
|
* The request object that will be sent.
|
117
117
|
* @param {string} request.name
|
118
118
|
* Required. Full resource name of
|
119
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, such as
|
119
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, such as
|
120
120
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
121
121
|
*
|
122
122
|
* If the caller does not have permission to access the
|
123
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
123
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
124
124
|
* or not it exists, a `PERMISSION_DENIED` error is returned.
|
125
125
|
*
|
126
|
-
* If the requested {@link google.cloud.discoveryengine.v1.Document|Document} does
|
126
|
+
* If the requested {@link protos.google.cloud.discoveryengine.v1.Document|Document} does
|
127
127
|
* not exist, a `NOT_FOUND` error is returned.
|
128
128
|
* @param {object} [options]
|
129
129
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
130
130
|
* @returns {Promise} - The promise which resolves to an array.
|
131
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document
|
132
|
-
* Please see the
|
133
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
131
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
132
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
134
133
|
* for more details and examples.
|
135
134
|
* @example <caption>include:samples/generated/v1/document_service.get_document.js</caption>
|
136
135
|
* region_tag:discoveryengine_v1_generated_DocumentService_GetDocument_async
|
@@ -143,7 +142,7 @@ export declare class DocumentServiceClient {
|
|
143
142
|
getDocument(request: protos.google.cloud.discoveryengine.v1.IGetDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
|
144
143
|
getDocument(request: protos.google.cloud.discoveryengine.v1.IGetDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IGetDocumentRequest | null | undefined, {} | null | undefined>): void;
|
145
144
|
/**
|
146
|
-
* Creates a {@link google.cloud.discoveryengine.v1.Document|Document}.
|
145
|
+
* Creates a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
147
146
|
*
|
148
147
|
* @param {Object} request
|
149
148
|
* The request object that will be sent.
|
@@ -151,21 +150,21 @@ export declare class DocumentServiceClient {
|
|
151
150
|
* Required. The parent resource name, such as
|
152
151
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
153
152
|
* @param {google.cloud.discoveryengine.v1.Document} request.document
|
154
|
-
* Required. The {@link google.cloud.discoveryengine.v1.Document|Document} to
|
153
|
+
* Required. The {@link protos.google.cloud.discoveryengine.v1.Document|Document} to
|
155
154
|
* create.
|
156
155
|
* @param {string} request.documentId
|
157
156
|
* Required. The ID to use for the
|
158
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, which will become the
|
157
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, which will become the
|
159
158
|
* final component of the
|
160
|
-
* {@link google.cloud.discoveryengine.v1.Document.name|Document.name}.
|
159
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document.name|Document.name}.
|
161
160
|
*
|
162
161
|
* If the caller does not have permission to create the
|
163
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
162
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
164
163
|
* or not it exists, a `PERMISSION_DENIED` error is returned.
|
165
164
|
*
|
166
165
|
* This field must be unique among all
|
167
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s with the same
|
168
|
-
* {@link google.cloud.discoveryengine.v1.CreateDocumentRequest.parent|parent}.
|
166
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s with the same
|
167
|
+
* {@link protos.google.cloud.discoveryengine.v1.CreateDocumentRequest.parent|parent}.
|
169
168
|
* Otherwise, an `ALREADY_EXISTS` error is returned.
|
170
169
|
*
|
171
170
|
* This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
@@ -174,9 +173,8 @@ export declare class DocumentServiceClient {
|
|
174
173
|
* @param {object} [options]
|
175
174
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
176
175
|
* @returns {Promise} - The promise which resolves to an array.
|
177
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document
|
178
|
-
* Please see the
|
179
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
176
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
177
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
180
178
|
* for more details and examples.
|
181
179
|
* @example <caption>include:samples/generated/v1/document_service.create_document.js</caption>
|
182
180
|
* region_tag:discoveryengine_v1_generated_DocumentService_CreateDocument_async
|
@@ -189,7 +187,7 @@ export declare class DocumentServiceClient {
|
|
189
187
|
createDocument(request: protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
190
188
|
createDocument(request: protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.ICreateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
191
189
|
/**
|
192
|
-
* Updates a {@link google.cloud.discoveryengine.v1.Document|Document}.
|
190
|
+
* Updates a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
193
191
|
*
|
194
192
|
* @param {Object} request
|
195
193
|
* The request object that will be sent.
|
@@ -197,23 +195,22 @@ export declare class DocumentServiceClient {
|
|
197
195
|
* Required. The document to update/create.
|
198
196
|
*
|
199
197
|
* If the caller does not have permission to update the
|
200
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
198
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
201
199
|
* or not it exists, a `PERMISSION_DENIED` error is returned.
|
202
200
|
*
|
203
|
-
* If the {@link google.cloud.discoveryengine.v1.Document|Document} to update does
|
201
|
+
* If the {@link protos.google.cloud.discoveryengine.v1.Document|Document} to update does
|
204
202
|
* not exist and
|
205
|
-
* {@link google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing|allow_missing}
|
203
|
+
* {@link protos.google.cloud.discoveryengine.v1.UpdateDocumentRequest.allow_missing|allow_missing}
|
206
204
|
* is not set, a `NOT_FOUND` error is returned.
|
207
205
|
* @param {boolean} request.allowMissing
|
208
206
|
* If set to true, and the
|
209
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document} is not found, a new
|
210
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document} will be created.
|
207
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document} is not found, a new
|
208
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document} will be created.
|
211
209
|
* @param {object} [options]
|
212
210
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
213
211
|
* @returns {Promise} - The promise which resolves to an array.
|
214
|
-
* The first element of the array is an object representing {@link google.cloud.discoveryengine.v1.Document
|
215
|
-
* Please see the
|
216
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
212
|
+
* The first element of the array is an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
213
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
217
214
|
* for more details and examples.
|
218
215
|
* @example <caption>include:samples/generated/v1/document_service.update_document.js</caption>
|
219
216
|
* region_tag:discoveryengine_v1_generated_DocumentService_UpdateDocument_async
|
@@ -226,27 +223,26 @@ export declare class DocumentServiceClient {
|
|
226
223
|
updateDocument(request: protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest, options: CallOptions, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
227
224
|
updateDocument(request: protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest, callback: Callback<protos.google.cloud.discoveryengine.v1.IDocument, protos.google.cloud.discoveryengine.v1.IUpdateDocumentRequest | null | undefined, {} | null | undefined>): void;
|
228
225
|
/**
|
229
|
-
* Deletes a {@link google.cloud.discoveryengine.v1.Document|Document}.
|
226
|
+
* Deletes a {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
230
227
|
*
|
231
228
|
* @param {Object} request
|
232
229
|
* The request object that will be sent.
|
233
230
|
* @param {string} request.name
|
234
231
|
* Required. Full resource name of
|
235
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, such as
|
232
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, such as
|
236
233
|
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`.
|
237
234
|
*
|
238
235
|
* If the caller does not have permission to delete the
|
239
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
236
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}, regardless of whether
|
240
237
|
* or not it exists, a `PERMISSION_DENIED` error is returned.
|
241
238
|
*
|
242
|
-
* If the {@link google.cloud.discoveryengine.v1.Document|Document} to delete does
|
239
|
+
* If the {@link protos.google.cloud.discoveryengine.v1.Document|Document} to delete does
|
243
240
|
* not exist, a `NOT_FOUND` error is returned.
|
244
241
|
* @param {object} [options]
|
245
242
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
246
243
|
* @returns {Promise} - The promise which resolves to an array.
|
247
|
-
* The first element of the array is an object representing {@link google.protobuf.Empty
|
248
|
-
* Please see the
|
249
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods)
|
244
|
+
* The first element of the array is an object representing {@link protos.google.protobuf.Empty|Empty}.
|
245
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
250
246
|
* for more details and examples.
|
251
247
|
* @example <caption>include:samples/generated/v1/document_service.delete_document.js</caption>
|
252
248
|
* region_tag:discoveryengine_v1_generated_DocumentService_DeleteDocument_async
|
@@ -260,11 +256,11 @@ export declare class DocumentServiceClient {
|
|
260
256
|
deleteDocument(request: protos.google.cloud.discoveryengine.v1.IDeleteDocumentRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.discoveryengine.v1.IDeleteDocumentRequest | null | undefined, {} | null | undefined>): void;
|
261
257
|
/**
|
262
258
|
* Bulk import of multiple
|
263
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s. Request processing
|
259
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s. Request processing
|
264
260
|
* may be synchronous. Non-existing items will be created.
|
265
261
|
*
|
266
262
|
* Note: It is possible for a subset of the
|
267
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s to be successfully
|
263
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to be successfully
|
268
264
|
* updated.
|
269
265
|
*
|
270
266
|
* @param {Object} request
|
@@ -284,52 +280,52 @@ export declare class DocumentServiceClient {
|
|
284
280
|
* @param {google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode} request.reconciliationMode
|
285
281
|
* The mode of reconciliation between existing documents and the documents to
|
286
282
|
* be imported. Defaults to
|
287
|
-
* {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
|
283
|
+
* {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL|ReconciliationMode.INCREMENTAL}.
|
288
284
|
* @param {boolean} request.autoGenerateIds
|
289
285
|
* Whether to automatically generate IDs for the documents if absent.
|
290
286
|
*
|
291
287
|
* If set to `true`,
|
292
|
-
* {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s are
|
288
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s are
|
293
289
|
* automatically generated based on the hash of the payload, where IDs may not
|
294
290
|
* be consistent during multiple imports. In which case
|
295
|
-
* {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
|
291
|
+
* {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL|ReconciliationMode.FULL}
|
296
292
|
* is highly recommended to avoid duplicate contents. If unset or set to
|
297
|
-
* `false`, {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s have
|
293
|
+
* `false`, {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s have
|
298
294
|
* to be specified using
|
299
|
-
* {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
|
300
|
-
*
|
295
|
+
* {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field|id_field},
|
296
|
+
* otherwise, documents without IDs fail to be imported.
|
301
297
|
*
|
302
298
|
* Only set this field when using
|
303
|
-
* {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
|
304
|
-
* {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
|
305
|
-
* {@link google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
|
299
|
+
* {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
|
300
|
+
* {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
|
301
|
+
* {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
|
306
302
|
* or
|
307
|
-
* {@link google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
308
|
-
* is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
303
|
+
* {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
304
|
+
* is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
309
305
|
* @param {string} request.idField
|
310
306
|
* The field in the Cloud Storage and BigQuery sources that indicates the
|
311
307
|
* unique IDs of the documents.
|
312
308
|
*
|
313
|
-
* For {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} it is the key of
|
309
|
+
* For {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} it is the key of
|
314
310
|
* the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
|
315
|
-
* For {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
|
311
|
+
* For {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource} it is
|
316
312
|
* the column name of the BigQuery table where the unique ids are stored.
|
317
313
|
*
|
318
|
-
* The values of the JSON field or the BigQuery column
|
319
|
-
* {@link google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
|
314
|
+
* The values of the JSON field or the BigQuery column are used as the
|
315
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document.id|Document.id}s. The JSON field
|
320
316
|
* or the BigQuery column must be of string type, and the values must be set
|
321
317
|
* as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
322
|
-
* with 1-63 characters. Otherwise, documents without valid IDs
|
323
|
-
*
|
318
|
+
* with 1-63 characters. Otherwise, documents without valid IDs fail to be
|
319
|
+
* imported.
|
324
320
|
*
|
325
321
|
* Only set this field when using
|
326
|
-
* {@link google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
|
327
|
-
* {@link google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
|
328
|
-
* {@link google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
|
322
|
+
* {@link protos.google.cloud.discoveryengine.v1.GcsSource|GcsSource} or
|
323
|
+
* {@link protos.google.cloud.discoveryengine.v1.BigQuerySource|BigQuerySource}, and when
|
324
|
+
* {@link protos.google.cloud.discoveryengine.v1.GcsSource.data_schema|GcsSource.data_schema}
|
329
325
|
* or
|
330
|
-
* {@link google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
326
|
+
* {@link protos.google.cloud.discoveryengine.v1.BigQuerySource.data_schema|BigQuerySource.data_schema}
|
331
327
|
* is `custom`. And only set this field when
|
332
|
-
* {@link google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
|
328
|
+
* {@link protos.google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids|auto_generate_ids}
|
333
329
|
* is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
334
330
|
*
|
335
331
|
* If it is unset, a default value `_id` is used when importing from the
|
@@ -340,8 +336,7 @@ export declare class DocumentServiceClient {
|
|
340
336
|
* The first element of the array is an object representing
|
341
337
|
* a long running operation. Its `promise()` method returns a promise
|
342
338
|
* you can `await` for.
|
343
|
-
* Please see the
|
344
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
339
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
345
340
|
* for more details and examples.
|
346
341
|
* @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
|
347
342
|
* region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
|
@@ -359,8 +354,7 @@ export declare class DocumentServiceClient {
|
|
359
354
|
* The operation name that will be passed.
|
360
355
|
* @returns {Promise} - The promise which resolves to an object.
|
361
356
|
* The decoded operation object has result and metadata field to get information from.
|
362
|
-
* Please see the
|
363
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
357
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
364
358
|
* for more details and examples.
|
365
359
|
* @example <caption>include:samples/generated/v1/document_service.import_documents.js</caption>
|
366
360
|
* region_tag:discoveryengine_v1_generated_DocumentService_ImportDocuments_async
|
@@ -368,20 +362,20 @@ export declare class DocumentServiceClient {
|
|
368
362
|
checkImportDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.ImportDocumentsResponse, protos.google.cloud.discoveryengine.v1.ImportDocumentsMetadata>>;
|
369
363
|
/**
|
370
364
|
* Permanently deletes all selected
|
371
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s in a branch.
|
365
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s in a branch.
|
372
366
|
*
|
373
367
|
* This process is asynchronous. Depending on the number of
|
374
|
-
* {@link google.cloud.discoveryengine.v1.Document|Document}s to be deleted, this
|
368
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to be deleted, this
|
375
369
|
* operation can take hours to complete. Before the delete operation
|
376
|
-
* completes, some {@link google.cloud.discoveryengine.v1.Document|Document}s might
|
370
|
+
* completes, some {@link protos.google.cloud.discoveryengine.v1.Document|Document}s might
|
377
371
|
* still be returned by
|
378
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.GetDocument|DocumentService.GetDocument}
|
372
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.GetDocument|DocumentService.GetDocument}
|
379
373
|
* or
|
380
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}.
|
374
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}.
|
381
375
|
*
|
382
|
-
* To get a list of the {@link google.cloud.discoveryengine.v1.Document|Document}s
|
376
|
+
* To get a list of the {@link protos.google.cloud.discoveryengine.v1.Document|Document}s
|
383
377
|
* to be deleted, set
|
384
|
-
* {@link google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
|
378
|
+
* {@link protos.google.cloud.discoveryengine.v1.PurgeDocumentsRequest.force|PurgeDocumentsRequest.force}
|
385
379
|
* to false.
|
386
380
|
*
|
387
381
|
* @param {Object} request
|
@@ -402,8 +396,7 @@ export declare class DocumentServiceClient {
|
|
402
396
|
* The first element of the array is an object representing
|
403
397
|
* a long running operation. Its `promise()` method returns a promise
|
404
398
|
* you can `await` for.
|
405
|
-
* Please see the
|
406
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
399
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
407
400
|
* for more details and examples.
|
408
401
|
* @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
|
409
402
|
* region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
|
@@ -421,15 +414,14 @@ export declare class DocumentServiceClient {
|
|
421
414
|
* The operation name that will be passed.
|
422
415
|
* @returns {Promise} - The promise which resolves to an object.
|
423
416
|
* The decoded operation object has result and metadata field to get information from.
|
424
|
-
* Please see the
|
425
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations)
|
417
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
|
426
418
|
* for more details and examples.
|
427
419
|
* @example <caption>include:samples/generated/v1/document_service.purge_documents.js</caption>
|
428
420
|
* region_tag:discoveryengine_v1_generated_DocumentService_PurgeDocuments_async
|
429
421
|
*/
|
430
422
|
checkPurgeDocumentsProgress(name: string): Promise<LROperation<protos.google.cloud.discoveryengine.v1.PurgeDocumentsResponse, protos.google.cloud.discoveryengine.v1.PurgeDocumentsMetadata>>;
|
431
423
|
/**
|
432
|
-
* Gets a list of {@link google.cloud.discoveryengine.v1.Document|Document}s.
|
424
|
+
* Gets a list of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s.
|
433
425
|
*
|
434
426
|
* @param {Object} request
|
435
427
|
* The request object that will be sent.
|
@@ -439,37 +431,37 @@ export declare class DocumentServiceClient {
|
|
439
431
|
* Use `default_branch` as the branch ID, to list documents under the default
|
440
432
|
* branch.
|
441
433
|
*
|
442
|
-
* If the caller does not have permission to list
|
443
|
-
*
|
444
|
-
* `PERMISSION_DENIED`
|
434
|
+
* If the caller does not have permission to list
|
435
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
|
436
|
+
* regardless of whether or not this branch exists, a `PERMISSION_DENIED`
|
437
|
+
* error is returned.
|
445
438
|
* @param {number} request.pageSize
|
446
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
439
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
447
440
|
* return. If unspecified, defaults to 100. The maximum allowed value is 1000.
|
448
441
|
* Values above 1000 will be coerced to 1000.
|
449
442
|
*
|
450
443
|
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
451
444
|
* @param {string} request.pageToken
|
452
445
|
* A page token
|
453
|
-
* {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
446
|
+
* {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
454
447
|
* received from a previous
|
455
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
448
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
456
449
|
* call. Provide this to retrieve the subsequent page.
|
457
450
|
*
|
458
451
|
* When paginating, all other parameters provided to
|
459
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
452
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
460
453
|
* must match the call that provided the page token. Otherwise, an
|
461
454
|
* `INVALID_ARGUMENT` error is returned.
|
462
455
|
* @param {object} [options]
|
463
456
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
464
457
|
* @returns {Promise} - The promise which resolves to an array.
|
465
|
-
* The first element of the array is Array of {@link google.cloud.discoveryengine.v1.Document
|
458
|
+
* The first element of the array is Array of {@link protos.google.cloud.discoveryengine.v1.Document|Document}.
|
466
459
|
* The client library will perform auto-pagination by default: it will call the API as many
|
467
460
|
* times as needed and will merge results from all the pages into this array.
|
468
461
|
* Note that it can affect your quota.
|
469
462
|
* We recommend using `listDocumentsAsync()`
|
470
463
|
* method described below for async iteration which you can stop as needed.
|
471
|
-
* Please see the
|
472
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
464
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
473
465
|
* for more details and examples.
|
474
466
|
*/
|
475
467
|
listDocuments(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Promise<[
|
@@ -489,36 +481,36 @@ export declare class DocumentServiceClient {
|
|
489
481
|
* Use `default_branch` as the branch ID, to list documents under the default
|
490
482
|
* branch.
|
491
483
|
*
|
492
|
-
* If the caller does not have permission to list
|
493
|
-
*
|
494
|
-
* `PERMISSION_DENIED`
|
484
|
+
* If the caller does not have permission to list
|
485
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
|
486
|
+
* regardless of whether or not this branch exists, a `PERMISSION_DENIED`
|
487
|
+
* error is returned.
|
495
488
|
* @param {number} request.pageSize
|
496
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
489
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
497
490
|
* return. If unspecified, defaults to 100. The maximum allowed value is 1000.
|
498
491
|
* Values above 1000 will be coerced to 1000.
|
499
492
|
*
|
500
493
|
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
501
494
|
* @param {string} request.pageToken
|
502
495
|
* A page token
|
503
|
-
* {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
496
|
+
* {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
504
497
|
* received from a previous
|
505
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
498
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
506
499
|
* call. Provide this to retrieve the subsequent page.
|
507
500
|
*
|
508
501
|
* When paginating, all other parameters provided to
|
509
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
502
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
510
503
|
* must match the call that provided the page token. Otherwise, an
|
511
504
|
* `INVALID_ARGUMENT` error is returned.
|
512
505
|
* @param {object} [options]
|
513
506
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
514
507
|
* @returns {Stream}
|
515
|
-
* An object stream which emits an object representing {@link google.cloud.discoveryengine.v1.Document
|
508
|
+
* An object stream which emits an object representing {@link protos.google.cloud.discoveryengine.v1.Document|Document} on 'data' event.
|
516
509
|
* The client library will perform auto-pagination by default: it will call the API as many
|
517
510
|
* times as needed. Note that it can affect your quota.
|
518
511
|
* We recommend using `listDocumentsAsync()`
|
519
512
|
* method described below for async iteration which you can stop as needed.
|
520
|
-
* Please see the
|
521
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
513
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
522
514
|
* for more details and examples.
|
523
515
|
*/
|
524
516
|
listDocumentsStream(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): Transform;
|
@@ -534,40 +526,91 @@ export declare class DocumentServiceClient {
|
|
534
526
|
* Use `default_branch` as the branch ID, to list documents under the default
|
535
527
|
* branch.
|
536
528
|
*
|
537
|
-
* If the caller does not have permission to list
|
538
|
-
*
|
539
|
-
* `PERMISSION_DENIED`
|
529
|
+
* If the caller does not have permission to list
|
530
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}s under this branch,
|
531
|
+
* regardless of whether or not this branch exists, a `PERMISSION_DENIED`
|
532
|
+
* error is returned.
|
540
533
|
* @param {number} request.pageSize
|
541
|
-
* Maximum number of {@link google.cloud.discoveryengine.v1.Document|Document}s to
|
534
|
+
* Maximum number of {@link protos.google.cloud.discoveryengine.v1.Document|Document}s to
|
542
535
|
* return. If unspecified, defaults to 100. The maximum allowed value is 1000.
|
543
536
|
* Values above 1000 will be coerced to 1000.
|
544
537
|
*
|
545
538
|
* If this field is negative, an `INVALID_ARGUMENT` error is returned.
|
546
539
|
* @param {string} request.pageToken
|
547
540
|
* A page token
|
548
|
-
* {@link google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
541
|
+
* {@link protos.google.cloud.discoveryengine.v1.ListDocumentsResponse.next_page_token|ListDocumentsResponse.next_page_token},
|
549
542
|
* received from a previous
|
550
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
543
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
551
544
|
* call. Provide this to retrieve the subsequent page.
|
552
545
|
*
|
553
546
|
* When paginating, all other parameters provided to
|
554
|
-
* {@link google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
547
|
+
* {@link protos.google.cloud.discoveryengine.v1.DocumentService.ListDocuments|DocumentService.ListDocuments}
|
555
548
|
* must match the call that provided the page token. Otherwise, an
|
556
549
|
* `INVALID_ARGUMENT` error is returned.
|
557
550
|
* @param {object} [options]
|
558
551
|
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
559
552
|
* @returns {Object}
|
560
|
-
* An iterable Object that allows
|
553
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
561
554
|
* When you iterate the returned iterable, each element will be an object representing
|
562
|
-
* {@link google.cloud.discoveryengine.v1.Document
|
555
|
+
* {@link protos.google.cloud.discoveryengine.v1.Document|Document}. The API will be called under the hood as needed, once per the page,
|
563
556
|
* so you can stop the iteration when you don't need more results.
|
564
|
-
* Please see the
|
565
|
-
* [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination)
|
557
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
566
558
|
* for more details and examples.
|
567
559
|
* @example <caption>include:samples/generated/v1/document_service.list_documents.js</caption>
|
568
560
|
* region_tag:discoveryengine_v1_generated_DocumentService_ListDocuments_async
|
569
561
|
*/
|
570
562
|
listDocumentsAsync(request?: protos.google.cloud.discoveryengine.v1.IListDocumentsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.discoveryengine.v1.IDocument>;
|
563
|
+
/**
|
564
|
+
* Gets information about a location.
|
565
|
+
*
|
566
|
+
* @param {Object} request
|
567
|
+
* The request object that will be sent.
|
568
|
+
* @param {string} request.name
|
569
|
+
* Resource name for the location.
|
570
|
+
* @param {object} [options]
|
571
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
|
572
|
+
* @returns {Promise} - The promise which resolves to an array.
|
573
|
+
* The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
|
574
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
|
575
|
+
* for more details and examples.
|
576
|
+
* @example
|
577
|
+
* ```
|
578
|
+
* const [response] = await client.getLocation(request);
|
579
|
+
* ```
|
580
|
+
*/
|
581
|
+
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>;
|
582
|
+
/**
|
583
|
+
* Lists information about the supported locations for this service. Returns an iterable object.
|
584
|
+
*
|
585
|
+
* `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
|
586
|
+
* @param {Object} request
|
587
|
+
* The request object that will be sent.
|
588
|
+
* @param {string} request.name
|
589
|
+
* The resource that owns the locations collection, if applicable.
|
590
|
+
* @param {string} request.filter
|
591
|
+
* The standard list filter.
|
592
|
+
* @param {number} request.pageSize
|
593
|
+
* The standard list page size.
|
594
|
+
* @param {string} request.pageToken
|
595
|
+
* The standard list page token.
|
596
|
+
* @param {object} [options]
|
597
|
+
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
|
598
|
+
* @returns {Object}
|
599
|
+
* An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
|
600
|
+
* When you iterate the returned iterable, each element will be an object representing
|
601
|
+
* {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
|
602
|
+
* so you can stop the iteration when you don't need more results.
|
603
|
+
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
|
604
|
+
* for more details and examples.
|
605
|
+
* @example
|
606
|
+
* ```
|
607
|
+
* const iterable = client.listLocationsAsync(request);
|
608
|
+
* for await (const response of iterable) {
|
609
|
+
* // process response
|
610
|
+
* }
|
611
|
+
* ```
|
612
|
+
*/
|
613
|
+
listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
|
571
614
|
/**
|
572
615
|
* Gets the latest state of a long-running operation. Clients can use this
|
573
616
|
* method to poll the operation result at intervals as recommended by the API
|
@@ -799,6 +842,57 @@ export declare class DocumentServiceClient {
|
|
799
842
|
* @returns {string} A string representing the document.
|
800
843
|
*/
|
801
844
|
matchDocumentFromProjectLocationCollectionDataStoreBranchDocumentName(projectLocationCollectionDataStoreBranchDocumentName: string): string | number;
|
845
|
+
/**
|
846
|
+
* Return a fully-qualified projectLocationCollectionDataStoreConversation resource name string.
|
847
|
+
*
|
848
|
+
* @param {string} project
|
849
|
+
* @param {string} location
|
850
|
+
* @param {string} collection
|
851
|
+
* @param {string} data_store
|
852
|
+
* @param {string} conversation
|
853
|
+
* @returns {string} Resource name string.
|
854
|
+
*/
|
855
|
+
projectLocationCollectionDataStoreConversationPath(project: string, location: string, collection: string, dataStore: string, conversation: string): string;
|
856
|
+
/**
|
857
|
+
* Parse the project from ProjectLocationCollectionDataStoreConversation resource.
|
858
|
+
*
|
859
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
860
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
861
|
+
* @returns {string} A string representing the project.
|
862
|
+
*/
|
863
|
+
matchProjectFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
864
|
+
/**
|
865
|
+
* Parse the location from ProjectLocationCollectionDataStoreConversation resource.
|
866
|
+
*
|
867
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
868
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
869
|
+
* @returns {string} A string representing the location.
|
870
|
+
*/
|
871
|
+
matchLocationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
872
|
+
/**
|
873
|
+
* Parse the collection from ProjectLocationCollectionDataStoreConversation resource.
|
874
|
+
*
|
875
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
876
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
877
|
+
* @returns {string} A string representing the collection.
|
878
|
+
*/
|
879
|
+
matchCollectionFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
880
|
+
/**
|
881
|
+
* Parse the data_store from ProjectLocationCollectionDataStoreConversation resource.
|
882
|
+
*
|
883
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
884
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
885
|
+
* @returns {string} A string representing the data_store.
|
886
|
+
*/
|
887
|
+
matchDataStoreFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
888
|
+
/**
|
889
|
+
* Parse the conversation from ProjectLocationCollectionDataStoreConversation resource.
|
890
|
+
*
|
891
|
+
* @param {string} projectLocationCollectionDataStoreConversationName
|
892
|
+
* A fully-qualified path representing project_location_collection_data_store_conversation resource.
|
893
|
+
* @returns {string} A string representing the conversation.
|
894
|
+
*/
|
895
|
+
matchConversationFromProjectLocationCollectionDataStoreConversationName(projectLocationCollectionDataStoreConversationName: string): string | number;
|
802
896
|
/**
|
803
897
|
* Return a fully-qualified projectLocationCollectionDataStoreSchema resource name string.
|
804
898
|
*
|
@@ -943,6 +1037,48 @@ export declare class DocumentServiceClient {
|
|
943
1037
|
* @returns {string} A string representing the document.
|
944
1038
|
*/
|
945
1039
|
matchDocumentFromProjectLocationDataStoreBranchDocumentName(projectLocationDataStoreBranchDocumentName: string): string | number;
|
1040
|
+
/**
|
1041
|
+
* Return a fully-qualified projectLocationDataStoreConversation resource name string.
|
1042
|
+
*
|
1043
|
+
* @param {string} project
|
1044
|
+
* @param {string} location
|
1045
|
+
* @param {string} data_store
|
1046
|
+
* @param {string} conversation
|
1047
|
+
* @returns {string} Resource name string.
|
1048
|
+
*/
|
1049
|
+
projectLocationDataStoreConversationPath(project: string, location: string, dataStore: string, conversation: string): string;
|
1050
|
+
/**
|
1051
|
+
* Parse the project from ProjectLocationDataStoreConversation resource.
|
1052
|
+
*
|
1053
|
+
* @param {string} projectLocationDataStoreConversationName
|
1054
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1055
|
+
* @returns {string} A string representing the project.
|
1056
|
+
*/
|
1057
|
+
matchProjectFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1058
|
+
/**
|
1059
|
+
* Parse the location from ProjectLocationDataStoreConversation resource.
|
1060
|
+
*
|
1061
|
+
* @param {string} projectLocationDataStoreConversationName
|
1062
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1063
|
+
* @returns {string} A string representing the location.
|
1064
|
+
*/
|
1065
|
+
matchLocationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1066
|
+
/**
|
1067
|
+
* Parse the data_store from ProjectLocationDataStoreConversation resource.
|
1068
|
+
*
|
1069
|
+
* @param {string} projectLocationDataStoreConversationName
|
1070
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1071
|
+
* @returns {string} A string representing the data_store.
|
1072
|
+
*/
|
1073
|
+
matchDataStoreFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
1074
|
+
/**
|
1075
|
+
* Parse the conversation from ProjectLocationDataStoreConversation resource.
|
1076
|
+
*
|
1077
|
+
* @param {string} projectLocationDataStoreConversationName
|
1078
|
+
* A fully-qualified path representing project_location_data_store_conversation resource.
|
1079
|
+
* @returns {string} A string representing the conversation.
|
1080
|
+
*/
|
1081
|
+
matchConversationFromProjectLocationDataStoreConversationName(projectLocationDataStoreConversationName: string): string | number;
|
946
1082
|
/**
|
947
1083
|
* Return a fully-qualified projectLocationDataStoreSchema resource name string.
|
948
1084
|
*
|