@google-cloud/vectorsearch 0.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.
Files changed (34) hide show
  1. package/LICENSE +202 -0
  2. package/README.md +134 -0
  3. package/build/protos/google/cloud/vectorsearch/v1beta/common.proto +34 -0
  4. package/build/protos/google/cloud/vectorsearch/v1beta/data_object.proto +92 -0
  5. package/build/protos/google/cloud/vectorsearch/v1beta/data_object_search_service.proto +428 -0
  6. package/build/protos/google/cloud/vectorsearch/v1beta/data_object_service.proto +233 -0
  7. package/build/protos/google/cloud/vectorsearch/v1beta/embedding_config.proto +71 -0
  8. package/build/protos/google/cloud/vectorsearch/v1beta/vectorsearch_service.proto +631 -0
  9. package/build/protos/protos.d.ts +15049 -0
  10. package/build/protos/protos.js +39060 -0
  11. package/build/protos/protos.json +4174 -0
  12. package/build/src/index.d.ts +17 -0
  13. package/build/src/index.js +32 -0
  14. package/build/src/index.js.map +1 -0
  15. package/build/src/v1beta/data_object_search_service_client.d.ts +574 -0
  16. package/build/src/v1beta/data_object_search_service_client.js +849 -0
  17. package/build/src/v1beta/data_object_search_service_client.js.map +1 -0
  18. package/build/src/v1beta/data_object_search_service_client_config.json +58 -0
  19. package/build/src/v1beta/data_object_search_service_proto_list.json +8 -0
  20. package/build/src/v1beta/data_object_service_client.d.ts +486 -0
  21. package/build/src/v1beta/data_object_service_client.js +767 -0
  22. package/build/src/v1beta/data_object_service_client.js.map +1 -0
  23. package/build/src/v1beta/data_object_service_client_config.json +73 -0
  24. package/build/src/v1beta/data_object_service_proto_list.json +8 -0
  25. package/build/src/v1beta/gapic_metadata.json +277 -0
  26. package/build/src/v1beta/index.d.ts +3 -0
  27. package/build/src/v1beta/index.js +27 -0
  28. package/build/src/v1beta/index.js.map +1 -0
  29. package/build/src/v1beta/vector_search_service_client.d.ts +1020 -0
  30. package/build/src/v1beta/vector_search_service_client.js +1387 -0
  31. package/build/src/v1beta/vector_search_service_client.js.map +1 -0
  32. package/build/src/v1beta/vector_search_service_client_config.json +88 -0
  33. package/build/src/v1beta/vector_search_service_proto_list.json +8 -0
  34. package/package.json +70 -0
@@ -0,0 +1,1020 @@
1
+ import type * as gax from 'google-gax';
2
+ import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax';
3
+ import { Transform } from 'stream';
4
+ import * as protos from '../../protos/protos';
5
+ /**
6
+ * VectorSearchService provides methods for managing Collection resources, and
7
+ * Collection Index resources. The primary resources offered by this service are
8
+ * Collections which are a container for a set of related JSON data objects, and
9
+ * Collection Indexes which enable efficient ANN search across data objects
10
+ * within a Collection.
11
+ * @class
12
+ * @memberof v1beta
13
+ */
14
+ export declare class VectorSearchServiceClient {
15
+ private _terminated;
16
+ private _opts;
17
+ private _providedCustomServicePath;
18
+ private _gaxModule;
19
+ private _gaxGrpc;
20
+ private _protos;
21
+ private _defaults;
22
+ private _universeDomain;
23
+ private _servicePath;
24
+ private _log;
25
+ auth: gax.GoogleAuth;
26
+ descriptors: Descriptors;
27
+ warn: (code: string, message: string, warnType?: string) => void;
28
+ innerApiCalls: {
29
+ [name: string]: Function;
30
+ };
31
+ locationsClient: LocationsClient;
32
+ pathTemplates: {
33
+ [name: string]: gax.PathTemplate;
34
+ };
35
+ operationsClient: gax.OperationsClient;
36
+ vectorSearchServiceStub?: Promise<{
37
+ [name: string]: Function;
38
+ }>;
39
+ /**
40
+ * Construct an instance of VectorSearchServiceClient.
41
+ *
42
+ * @param {object} [options] - The configuration object.
43
+ * The options accepted by the constructor are described in detail
44
+ * in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
45
+ * The common options are:
46
+ * @param {object} [options.credentials] - Credentials object.
47
+ * @param {string} [options.credentials.client_email]
48
+ * @param {string} [options.credentials.private_key]
49
+ * @param {string} [options.email] - Account email address. Required when
50
+ * using a .pem or .p12 keyFilename.
51
+ * @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
52
+ * .p12 key downloaded from the Google Developers Console. If you provide
53
+ * a path to a JSON file, the projectId option below is not necessary.
54
+ * NOTE: .pem and .p12 require you to specify options.email as well.
55
+ * @param {number} [options.port] - The port on which to connect to
56
+ * the remote host.
57
+ * @param {string} [options.projectId] - The project ID from the Google
58
+ * Developer's Console, e.g. 'grape-spaceship-123'. We will also check
59
+ * the environment variable GCLOUD_PROJECT for your project ID. If your
60
+ * app is running in an environment which supports
61
+ * {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
62
+ * your project ID will be detected automatically.
63
+ * @param {string} [options.apiEndpoint] - The domain name of the
64
+ * API remote host.
65
+ * @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
66
+ * Follows the structure of {@link gapicConfig}.
67
+ * @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
68
+ * For more information, please check the
69
+ * {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
70
+ * @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
71
+ * need to avoid loading the default gRPC version and want to use the fallback
72
+ * HTTP implementation. Load only fallback version and pass it to the constructor:
73
+ * ```
74
+ * const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
75
+ * const client = new VectorSearchServiceClient({fallback: true}, gax);
76
+ * ```
77
+ */
78
+ constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
79
+ /**
80
+ * Initialize the client.
81
+ * Performs asynchronous operations (such as authentication) and prepares the client.
82
+ * This function will be called automatically when any class method is called for the
83
+ * first time, but if you need to initialize it before calling an actual method,
84
+ * feel free to call initialize() directly.
85
+ *
86
+ * You can await on this method if you want to make sure the client is initialized.
87
+ *
88
+ * @returns {Promise} A promise that resolves to an authenticated service stub.
89
+ */
90
+ initialize(): Promise<{
91
+ [name: string]: Function;
92
+ }>;
93
+ /**
94
+ * The DNS address for this API service.
95
+ * @deprecated Use the apiEndpoint method of the client instance.
96
+ * @returns {string} The DNS address for this service.
97
+ */
98
+ static get servicePath(): string;
99
+ /**
100
+ * The DNS address for this API service - same as servicePath.
101
+ * @deprecated Use the apiEndpoint method of the client instance.
102
+ * @returns {string} The DNS address for this service.
103
+ */
104
+ static get apiEndpoint(): string;
105
+ /**
106
+ * The DNS address for this API service.
107
+ * @returns {string} The DNS address for this service.
108
+ */
109
+ get apiEndpoint(): string;
110
+ get universeDomain(): string;
111
+ /**
112
+ * The port for this API service.
113
+ * @returns {number} The default port for this service.
114
+ */
115
+ static get port(): number;
116
+ /**
117
+ * The scopes needed to make gRPC calls for every method defined
118
+ * in this service.
119
+ * @returns {string[]} List of default scopes.
120
+ */
121
+ static get scopes(): string[];
122
+ getProjectId(): Promise<string>;
123
+ getProjectId(callback: Callback<string, undefined, undefined>): void;
124
+ /**
125
+ * Gets details of a single Collection.
126
+ *
127
+ * @param {Object} request
128
+ * The request object that will be sent.
129
+ * @param {string} request.name
130
+ * Required. Name of the resource
131
+ * @param {object} [options]
132
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
133
+ * @returns {Promise} - The promise which resolves to an array.
134
+ * The first element of the array is an object representing {@link protos.google.cloud.vectorsearch.v1beta.Collection|Collection}.
135
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
136
+ * for more details and examples.
137
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.get_collection.js</caption>
138
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_GetCollection_async
139
+ */
140
+ getCollection(request?: protos.google.cloud.vectorsearch.v1beta.IGetCollectionRequest, options?: CallOptions): Promise<[
141
+ protos.google.cloud.vectorsearch.v1beta.ICollection,
142
+ protos.google.cloud.vectorsearch.v1beta.IGetCollectionRequest | undefined,
143
+ {} | undefined
144
+ ]>;
145
+ getCollection(request: protos.google.cloud.vectorsearch.v1beta.IGetCollectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IGetCollectionRequest | null | undefined, {} | null | undefined>): void;
146
+ getCollection(request: protos.google.cloud.vectorsearch.v1beta.IGetCollectionRequest, callback: Callback<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IGetCollectionRequest | null | undefined, {} | null | undefined>): void;
147
+ /**
148
+ * Gets details of a single Index.
149
+ *
150
+ * @param {Object} request
151
+ * The request object that will be sent.
152
+ * @param {string} request.name
153
+ * Required. Name of the resource
154
+ * @param {object} [options]
155
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
156
+ * @returns {Promise} - The promise which resolves to an array.
157
+ * The first element of the array is an object representing {@link protos.google.cloud.vectorsearch.v1beta.Index|Index}.
158
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
159
+ * for more details and examples.
160
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.get_index.js</caption>
161
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_GetIndex_async
162
+ */
163
+ getIndex(request?: protos.google.cloud.vectorsearch.v1beta.IGetIndexRequest, options?: CallOptions): Promise<[
164
+ protos.google.cloud.vectorsearch.v1beta.IIndex,
165
+ protos.google.cloud.vectorsearch.v1beta.IGetIndexRequest | undefined,
166
+ {} | undefined
167
+ ]>;
168
+ getIndex(request: protos.google.cloud.vectorsearch.v1beta.IGetIndexRequest, options: CallOptions, callback: Callback<protos.google.cloud.vectorsearch.v1beta.IIndex, protos.google.cloud.vectorsearch.v1beta.IGetIndexRequest | null | undefined, {} | null | undefined>): void;
169
+ getIndex(request: protos.google.cloud.vectorsearch.v1beta.IGetIndexRequest, callback: Callback<protos.google.cloud.vectorsearch.v1beta.IIndex, protos.google.cloud.vectorsearch.v1beta.IGetIndexRequest | null | undefined, {} | null | undefined>): void;
170
+ /**
171
+ * Creates a new Collection in a given project and location.
172
+ *
173
+ * @param {Object} request
174
+ * The request object that will be sent.
175
+ * @param {string} request.parent
176
+ * Required. Value for parent.
177
+ * @param {string} request.collectionId
178
+ * Required. ID of the Collection to create.
179
+ * The id must be 1-63 characters long, and comply with
180
+ * <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
181
+ * Specifically, it must be 1-63 characters long and match the regular
182
+ * expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
183
+ * @param {google.cloud.vectorsearch.v1beta.Collection} request.collection
184
+ * Required. The resource being created
185
+ * @param {string} [request.requestId]
186
+ * Optional. An optional request ID to identify requests. Specify a unique
187
+ * request ID so that if you must retry your request, the server will know to
188
+ * ignore the request if it has already been completed. The server will
189
+ * guarantee that for at least 60 minutes since the first request.
190
+ *
191
+ * For example, consider a situation where you make an initial request and the
192
+ * request times out. If you make the request again with the same request
193
+ * ID, the server can check if original operation with the same request ID
194
+ * was received, and if so, will ignore the second request. This prevents
195
+ * clients from accidentally creating duplicate commitments.
196
+ *
197
+ * The request ID must be a valid UUID with the exception that zero UUID is
198
+ * not supported (00000000-0000-0000-0000-000000000000).
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 {Promise} - The promise which resolves to an array.
202
+ * The first element of the array is an object representing
203
+ * a long running operation. Its `promise()` method returns a promise
204
+ * you can `await` for.
205
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
206
+ * for more details and examples.
207
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.create_collection.js</caption>
208
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_CreateCollection_async
209
+ */
210
+ createCollection(request?: protos.google.cloud.vectorsearch.v1beta.ICreateCollectionRequest, options?: CallOptions): Promise<[
211
+ LROperation<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>,
212
+ protos.google.longrunning.IOperation | undefined,
213
+ {} | undefined
214
+ ]>;
215
+ createCollection(request: protos.google.cloud.vectorsearch.v1beta.ICreateCollectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
216
+ createCollection(request: protos.google.cloud.vectorsearch.v1beta.ICreateCollectionRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
217
+ /**
218
+ * Check the status of the long running operation returned by `createCollection()`.
219
+ * @param {String} name
220
+ * The operation name that will be passed.
221
+ * @returns {Promise} - The promise which resolves to an object.
222
+ * The decoded operation object has result and metadata field to get information from.
223
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
224
+ * for more details and examples.
225
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.create_collection.js</caption>
226
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_CreateCollection_async
227
+ */
228
+ checkCreateCollectionProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1beta.Collection, protos.google.cloud.vectorsearch.v1beta.OperationMetadata>>;
229
+ /**
230
+ * Updates the parameters of a single Collection.
231
+ *
232
+ * @param {Object} request
233
+ * The request object that will be sent.
234
+ * @param {google.protobuf.FieldMask} [request.updateMask]
235
+ * Optional. Field mask is used to specify the fields to be overwritten in the
236
+ * Collection resource by the update.
237
+ * The fields specified in the update_mask are relative to the resource, not
238
+ * the full request. A field will be overwritten if it is in the mask. If the
239
+ * user does not provide a mask then all fields present in the request will be
240
+ * overwritten.
241
+ *
242
+ * The following fields support update: `display_name`, `description`,
243
+ * `labels`, `data_schema`, `vector_schema`.
244
+ * For `data_schema` and `vector_schema`, fields can only be added, not
245
+ * modified or deleted.
246
+ * Partial updates for `data_schema` and `vector_schema` are also supported
247
+ * by using sub-field paths in `update_mask`, e.g.
248
+ * `data_schema.properties.foo` or `vector_schema.my_vector_field`.
249
+ *
250
+ * If `*` is provided in the update_mask, full replacement will be performed.
251
+ * @param {google.cloud.vectorsearch.v1beta.Collection} request.collection
252
+ * Required. The resource being updated
253
+ * @param {string} [request.requestId]
254
+ * Optional. An optional request ID to identify requests. Specify a unique
255
+ * request ID so that if you must retry your request, the server will know to
256
+ * ignore the request if it has already been completed. The server will
257
+ * guarantee that for at least 60 minutes since the first request.
258
+ *
259
+ * For example, consider a situation where you make an initial request and the
260
+ * request times out. If you make the request again with the same request
261
+ * ID, the server can check if original operation with the same request ID
262
+ * was received, and if so, will ignore the second request. This prevents
263
+ * clients from accidentally creating duplicate commitments.
264
+ *
265
+ * The request ID must be a valid UUID with the exception that zero UUID is
266
+ * not supported (00000000-0000-0000-0000-000000000000).
267
+ * @param {object} [options]
268
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
269
+ * @returns {Promise} - The promise which resolves to an array.
270
+ * The first element of the array is an object representing
271
+ * a long running operation. Its `promise()` method returns a promise
272
+ * you can `await` for.
273
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
274
+ * for more details and examples.
275
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.update_collection.js</caption>
276
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_UpdateCollection_async
277
+ */
278
+ updateCollection(request?: protos.google.cloud.vectorsearch.v1beta.IUpdateCollectionRequest, options?: CallOptions): Promise<[
279
+ LROperation<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>,
280
+ protos.google.longrunning.IOperation | undefined,
281
+ {} | undefined
282
+ ]>;
283
+ updateCollection(request: protos.google.cloud.vectorsearch.v1beta.IUpdateCollectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
284
+ updateCollection(request: protos.google.cloud.vectorsearch.v1beta.IUpdateCollectionRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.ICollection, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
285
+ /**
286
+ * Check the status of the long running operation returned by `updateCollection()`.
287
+ * @param {String} name
288
+ * The operation name that will be passed.
289
+ * @returns {Promise} - The promise which resolves to an object.
290
+ * The decoded operation object has result and metadata field to get information from.
291
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
292
+ * for more details and examples.
293
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.update_collection.js</caption>
294
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_UpdateCollection_async
295
+ */
296
+ checkUpdateCollectionProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1beta.Collection, protos.google.cloud.vectorsearch.v1beta.OperationMetadata>>;
297
+ /**
298
+ * Deletes a single Collection.
299
+ *
300
+ * @param {Object} request
301
+ * The request object that will be sent.
302
+ * @param {string} request.name
303
+ * Required. Name of the resource
304
+ * @param {string} [request.requestId]
305
+ * Optional. An optional request ID to identify requests. Specify a unique
306
+ * request ID so that if you must retry your request, the server will know to
307
+ * ignore the request if it has already been completed. The server will
308
+ * guarantee that for at least 60 minutes after the first request.
309
+ *
310
+ * For example, consider a situation where you make an initial request and the
311
+ * request times out. If you make the request again with the same request
312
+ * ID, the server can check if original operation with the same request ID
313
+ * was received, and if so, will ignore the second request. This prevents
314
+ * clients from accidentally creating duplicate commitments.
315
+ *
316
+ * The request ID must be a valid UUID with the exception that zero UUID is
317
+ * not supported (00000000-0000-0000-0000-000000000000).
318
+ * @param {object} [options]
319
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
320
+ * @returns {Promise} - The promise which resolves to an array.
321
+ * The first element of the array is an object representing
322
+ * a long running operation. Its `promise()` method returns a promise
323
+ * you can `await` for.
324
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
325
+ * for more details and examples.
326
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.delete_collection.js</caption>
327
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_DeleteCollection_async
328
+ */
329
+ deleteCollection(request?: protos.google.cloud.vectorsearch.v1beta.IDeleteCollectionRequest, options?: CallOptions): Promise<[
330
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>,
331
+ protos.google.longrunning.IOperation | undefined,
332
+ {} | undefined
333
+ ]>;
334
+ deleteCollection(request: protos.google.cloud.vectorsearch.v1beta.IDeleteCollectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
335
+ deleteCollection(request: protos.google.cloud.vectorsearch.v1beta.IDeleteCollectionRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
336
+ /**
337
+ * Check the status of the long running operation returned by `deleteCollection()`.
338
+ * @param {String} name
339
+ * The operation name that will be passed.
340
+ * @returns {Promise} - The promise which resolves to an object.
341
+ * The decoded operation object has result and metadata field to get information from.
342
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
343
+ * for more details and examples.
344
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.delete_collection.js</caption>
345
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_DeleteCollection_async
346
+ */
347
+ checkDeleteCollectionProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vectorsearch.v1beta.OperationMetadata>>;
348
+ /**
349
+ * Creates a new Index in a given project and location.
350
+ *
351
+ * @param {Object} request
352
+ * The request object that will be sent.
353
+ * @param {string} request.parent
354
+ * Required. The resource name of the Collection for which to create the
355
+ * Index. Format:
356
+ * `projects/{project}/locations/{location}/collections/{collection}`
357
+ * @param {string} request.indexId
358
+ * Required. ID of the Index to create.
359
+ * The id must be 1-63 characters long, and comply with
360
+ * <a href="https://www.ietf.org/rfc/rfc1035.txt" target="_blank">RFC1035</a>.
361
+ * Specifically, it must be 1-63 characters long and match the regular
362
+ * expression `[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?`.
363
+ * @param {google.cloud.vectorsearch.v1beta.Index} request.index
364
+ * Required. The resource being created
365
+ * @param {string} [request.requestId]
366
+ * Optional. An optional request ID to identify requests. Specify a unique
367
+ * request ID so that if you must retry your request, the server will know to
368
+ * ignore the request if it has already been completed. The server will
369
+ * guarantee that for at least 60 minutes since the first request.
370
+ *
371
+ * For example, consider a situation where you make an initial request and the
372
+ * request times out. If you make the request again with the same request
373
+ * ID, the server can check if original operation with the same request ID
374
+ * was received, and if so, will ignore the second request. This prevents
375
+ * clients from accidentally creating duplicate commitments.
376
+ *
377
+ * The request ID must be a valid UUID with the exception that zero UUID is
378
+ * not supported (00000000-0000-0000-0000-000000000000).
379
+ * @param {object} [options]
380
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
381
+ * @returns {Promise} - The promise which resolves to an array.
382
+ * The first element of the array is an object representing
383
+ * a long running operation. Its `promise()` method returns a promise
384
+ * you can `await` for.
385
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
386
+ * for more details and examples.
387
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.create_index.js</caption>
388
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_CreateIndex_async
389
+ */
390
+ createIndex(request?: protos.google.cloud.vectorsearch.v1beta.ICreateIndexRequest, options?: CallOptions): Promise<[
391
+ LROperation<protos.google.cloud.vectorsearch.v1beta.IIndex, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>,
392
+ protos.google.longrunning.IOperation | undefined,
393
+ {} | undefined
394
+ ]>;
395
+ createIndex(request: protos.google.cloud.vectorsearch.v1beta.ICreateIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.IIndex, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
396
+ createIndex(request: protos.google.cloud.vectorsearch.v1beta.ICreateIndexRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.IIndex, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
397
+ /**
398
+ * Check the status of the long running operation returned by `createIndex()`.
399
+ * @param {String} name
400
+ * The operation name that will be passed.
401
+ * @returns {Promise} - The promise which resolves to an object.
402
+ * The decoded operation object has result and metadata field to get information from.
403
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
404
+ * for more details and examples.
405
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.create_index.js</caption>
406
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_CreateIndex_async
407
+ */
408
+ checkCreateIndexProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1beta.Index, protos.google.cloud.vectorsearch.v1beta.OperationMetadata>>;
409
+ /**
410
+ * Deletes a single Index.
411
+ *
412
+ * @param {Object} request
413
+ * The request object that will be sent.
414
+ * @param {string} request.name
415
+ * Required. The resource name of the Index to delete.
416
+ * Format:
417
+ * `projects/{project}/locations/{location}/collections/{collection}/indexes/{index}`
418
+ * @param {string} [request.requestId]
419
+ * Optional. An optional request ID to identify requests. Specify a unique
420
+ * request ID so that if you must retry your request, the server will know to
421
+ * ignore the request if it has already been completed. The server will
422
+ * guarantee that for at least 60 minutes since the first request.
423
+ *
424
+ * For example, consider a situation where you make an initial request and the
425
+ * request times out. If you make the request again with the same request
426
+ * ID, the server can check if original operation with the same request ID
427
+ * was received, and if so, will ignore the second request. This prevents
428
+ * clients from accidentally creating duplicate commitments.
429
+ *
430
+ * The request ID must be a valid UUID with the exception that zero UUID is
431
+ * not supported (00000000-0000-0000-0000-000000000000).
432
+ * @param {object} [options]
433
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
434
+ * @returns {Promise} - The promise which resolves to an array.
435
+ * The first element of the array is an object representing
436
+ * a long running operation. Its `promise()` method returns a promise
437
+ * you can `await` for.
438
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
439
+ * for more details and examples.
440
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.delete_index.js</caption>
441
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_DeleteIndex_async
442
+ */
443
+ deleteIndex(request?: protos.google.cloud.vectorsearch.v1beta.IDeleteIndexRequest, options?: CallOptions): Promise<[
444
+ LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>,
445
+ protos.google.longrunning.IOperation | undefined,
446
+ {} | undefined
447
+ ]>;
448
+ deleteIndex(request: protos.google.cloud.vectorsearch.v1beta.IDeleteIndexRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
449
+ deleteIndex(request: protos.google.cloud.vectorsearch.v1beta.IDeleteIndexRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.vectorsearch.v1beta.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
450
+ /**
451
+ * Check the status of the long running operation returned by `deleteIndex()`.
452
+ * @param {String} name
453
+ * The operation name that will be passed.
454
+ * @returns {Promise} - The promise which resolves to an object.
455
+ * The decoded operation object has result and metadata field to get information from.
456
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
457
+ * for more details and examples.
458
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.delete_index.js</caption>
459
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_DeleteIndex_async
460
+ */
461
+ checkDeleteIndexProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.vectorsearch.v1beta.OperationMetadata>>;
462
+ /**
463
+ * Initiates a Long-Running Operation to import DataObjects into a Collection.
464
+ *
465
+ * @param {Object} request
466
+ * The request object that will be sent.
467
+ * @param {google.cloud.vectorsearch.v1beta.ImportDataObjectsRequest.GcsImportConfig} request.gcsImport
468
+ * The Cloud Storage location of the input content.
469
+ * @param {string} request.name
470
+ * Required. The resource name of the Collection to import DataObjects into.
471
+ * Format: `projects/{project}/locations/{location}/collections/{collection}`.
472
+ * @param {object} [options]
473
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
474
+ * @returns {Promise} - The promise which resolves to an array.
475
+ * The first element of the array is an object representing
476
+ * a long running operation. Its `promise()` method returns a promise
477
+ * you can `await` for.
478
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
479
+ * for more details and examples.
480
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.import_data_objects.js</caption>
481
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ImportDataObjects_async
482
+ */
483
+ importDataObjects(request?: protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsRequest, options?: CallOptions): Promise<[
484
+ LROperation<protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsMetadata>,
485
+ protos.google.longrunning.IOperation | undefined,
486
+ {} | undefined
487
+ ]>;
488
+ importDataObjects(request: protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
489
+ importDataObjects(request: protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsRequest, callback: Callback<LROperation<protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.IImportDataObjectsMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
490
+ /**
491
+ * Check the status of the long running operation returned by `importDataObjects()`.
492
+ * @param {String} name
493
+ * The operation name that will be passed.
494
+ * @returns {Promise} - The promise which resolves to an object.
495
+ * The decoded operation object has result and metadata field to get information from.
496
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
497
+ * for more details and examples.
498
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.import_data_objects.js</caption>
499
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ImportDataObjects_async
500
+ */
501
+ checkImportDataObjectsProgress(name: string): Promise<LROperation<protos.google.cloud.vectorsearch.v1beta.ImportDataObjectsResponse, protos.google.cloud.vectorsearch.v1beta.ImportDataObjectsMetadata>>;
502
+ /**
503
+ * Lists Collections in a given project and location.
504
+ *
505
+ * @param {Object} request
506
+ * The request object that will be sent.
507
+ * @param {string} request.parent
508
+ * Required. Parent value for ListCollectionsRequest
509
+ * @param {number} [request.pageSize]
510
+ * Optional. Requested page size. Server may return fewer items than
511
+ * requested. If unspecified, server will pick an appropriate default.
512
+ * @param {string} [request.pageToken]
513
+ * Optional. A token identifying a page of results the server should return.
514
+ * @param {string} [request.filter]
515
+ * Optional. Filtering results
516
+ * @param {string} [request.orderBy]
517
+ * Optional. Hint for how to order the results
518
+ * @param {object} [options]
519
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
520
+ * @returns {Promise} - The promise which resolves to an array.
521
+ * The first element of the array is Array of {@link protos.google.cloud.vectorsearch.v1beta.Collection|Collection}.
522
+ * The client library will perform auto-pagination by default: it will call the API as many
523
+ * times as needed and will merge results from all the pages into this array.
524
+ * Note that it can affect your quota.
525
+ * We recommend using `listCollectionsAsync()`
526
+ * method described below for async iteration which you can stop as needed.
527
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
528
+ * for more details and examples.
529
+ */
530
+ listCollections(request?: protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, options?: CallOptions): Promise<[
531
+ protos.google.cloud.vectorsearch.v1beta.ICollection[],
532
+ protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest | null,
533
+ protos.google.cloud.vectorsearch.v1beta.IListCollectionsResponse
534
+ ]>;
535
+ listCollections(request: protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, protos.google.cloud.vectorsearch.v1beta.IListCollectionsResponse | null | undefined, protos.google.cloud.vectorsearch.v1beta.ICollection>): void;
536
+ listCollections(request: protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, protos.google.cloud.vectorsearch.v1beta.IListCollectionsResponse | null | undefined, protos.google.cloud.vectorsearch.v1beta.ICollection>): void;
537
+ /**
538
+ * Equivalent to `listCollections`, but returns a NodeJS Stream object.
539
+ * @param {Object} request
540
+ * The request object that will be sent.
541
+ * @param {string} request.parent
542
+ * Required. Parent value for ListCollectionsRequest
543
+ * @param {number} [request.pageSize]
544
+ * Optional. Requested page size. Server may return fewer items than
545
+ * requested. If unspecified, server will pick an appropriate default.
546
+ * @param {string} [request.pageToken]
547
+ * Optional. A token identifying a page of results the server should return.
548
+ * @param {string} [request.filter]
549
+ * Optional. Filtering results
550
+ * @param {string} [request.orderBy]
551
+ * Optional. Hint for how to order the results
552
+ * @param {object} [options]
553
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
554
+ * @returns {Stream}
555
+ * An object stream which emits an object representing {@link protos.google.cloud.vectorsearch.v1beta.Collection|Collection} on 'data' event.
556
+ * The client library will perform auto-pagination by default: it will call the API as many
557
+ * times as needed. Note that it can affect your quota.
558
+ * We recommend using `listCollectionsAsync()`
559
+ * method described below for async iteration which you can stop as needed.
560
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
561
+ * for more details and examples.
562
+ */
563
+ listCollectionsStream(request?: protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, options?: CallOptions): Transform;
564
+ /**
565
+ * Equivalent to `listCollections`, but returns an iterable object.
566
+ *
567
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
568
+ * @param {Object} request
569
+ * The request object that will be sent.
570
+ * @param {string} request.parent
571
+ * Required. Parent value for ListCollectionsRequest
572
+ * @param {number} [request.pageSize]
573
+ * Optional. Requested page size. Server may return fewer items than
574
+ * requested. If unspecified, server will pick an appropriate default.
575
+ * @param {string} [request.pageToken]
576
+ * Optional. A token identifying a page of results the server should return.
577
+ * @param {string} [request.filter]
578
+ * Optional. Filtering results
579
+ * @param {string} [request.orderBy]
580
+ * Optional. Hint for how to order the results
581
+ * @param {object} [options]
582
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
583
+ * @returns {Object}
584
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
585
+ * When you iterate the returned iterable, each element will be an object representing
586
+ * {@link protos.google.cloud.vectorsearch.v1beta.Collection|Collection}. The API will be called under the hood as needed, once per the page,
587
+ * so you can stop the iteration when you don't need more results.
588
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
589
+ * for more details and examples.
590
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.list_collections.js</caption>
591
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ListCollections_async
592
+ */
593
+ listCollectionsAsync(request?: protos.google.cloud.vectorsearch.v1beta.IListCollectionsRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vectorsearch.v1beta.ICollection>;
594
+ /**
595
+ * Lists Indexes in a given project and location.
596
+ *
597
+ * @param {Object} request
598
+ * The request object that will be sent.
599
+ * @param {string} request.parent
600
+ * Required. Parent value for ListIndexesRequest
601
+ * @param {number} [request.pageSize]
602
+ * Optional. Requested page size. Server may return fewer items than
603
+ * requested. If unspecified, server will pick an appropriate default.
604
+ * @param {string} [request.pageToken]
605
+ * Optional. A token identifying a page of results the server should return.
606
+ * @param {string} [request.filter]
607
+ * Optional. Filtering results
608
+ * @param {string} [request.orderBy]
609
+ * Optional. Hint for how to order the results
610
+ * @param {object} [options]
611
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
612
+ * @returns {Promise} - The promise which resolves to an array.
613
+ * The first element of the array is Array of {@link protos.google.cloud.vectorsearch.v1beta.Index|Index}.
614
+ * The client library will perform auto-pagination by default: it will call the API as many
615
+ * times as needed and will merge results from all the pages into this array.
616
+ * Note that it can affect your quota.
617
+ * We recommend using `listIndexesAsync()`
618
+ * method described below for async iteration which you can stop as needed.
619
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
620
+ * for more details and examples.
621
+ */
622
+ listIndexes(request?: protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, options?: CallOptions): Promise<[
623
+ protos.google.cloud.vectorsearch.v1beta.IIndex[],
624
+ protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest | null,
625
+ protos.google.cloud.vectorsearch.v1beta.IListIndexesResponse
626
+ ]>;
627
+ listIndexes(request: protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, options: CallOptions, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, protos.google.cloud.vectorsearch.v1beta.IListIndexesResponse | null | undefined, protos.google.cloud.vectorsearch.v1beta.IIndex>): void;
628
+ listIndexes(request: protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, callback: PaginationCallback<protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, protos.google.cloud.vectorsearch.v1beta.IListIndexesResponse | null | undefined, protos.google.cloud.vectorsearch.v1beta.IIndex>): void;
629
+ /**
630
+ * Equivalent to `listIndexes`, but returns a NodeJS Stream object.
631
+ * @param {Object} request
632
+ * The request object that will be sent.
633
+ * @param {string} request.parent
634
+ * Required. Parent value for ListIndexesRequest
635
+ * @param {number} [request.pageSize]
636
+ * Optional. Requested page size. Server may return fewer items than
637
+ * requested. If unspecified, server will pick an appropriate default.
638
+ * @param {string} [request.pageToken]
639
+ * Optional. A token identifying a page of results the server should return.
640
+ * @param {string} [request.filter]
641
+ * Optional. Filtering results
642
+ * @param {string} [request.orderBy]
643
+ * Optional. Hint for how to order the results
644
+ * @param {object} [options]
645
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
646
+ * @returns {Stream}
647
+ * An object stream which emits an object representing {@link protos.google.cloud.vectorsearch.v1beta.Index|Index} on 'data' event.
648
+ * The client library will perform auto-pagination by default: it will call the API as many
649
+ * times as needed. Note that it can affect your quota.
650
+ * We recommend using `listIndexesAsync()`
651
+ * method described below for async iteration which you can stop as needed.
652
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
653
+ * for more details and examples.
654
+ */
655
+ listIndexesStream(request?: protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, options?: CallOptions): Transform;
656
+ /**
657
+ * Equivalent to `listIndexes`, but returns an iterable object.
658
+ *
659
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
660
+ * @param {Object} request
661
+ * The request object that will be sent.
662
+ * @param {string} request.parent
663
+ * Required. Parent value for ListIndexesRequest
664
+ * @param {number} [request.pageSize]
665
+ * Optional. Requested page size. Server may return fewer items than
666
+ * requested. If unspecified, server will pick an appropriate default.
667
+ * @param {string} [request.pageToken]
668
+ * Optional. A token identifying a page of results the server should return.
669
+ * @param {string} [request.filter]
670
+ * Optional. Filtering results
671
+ * @param {string} [request.orderBy]
672
+ * Optional. Hint for how to order the results
673
+ * @param {object} [options]
674
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
675
+ * @returns {Object}
676
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
677
+ * When you iterate the returned iterable, each element will be an object representing
678
+ * {@link protos.google.cloud.vectorsearch.v1beta.Index|Index}. The API will be called under the hood as needed, once per the page,
679
+ * so you can stop the iteration when you don't need more results.
680
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
681
+ * for more details and examples.
682
+ * @example <caption>include:samples/generated/v1beta/vector_search_service.list_indexes.js</caption>
683
+ * region_tag:vectorsearch_v1beta_generated_VectorSearchService_ListIndexes_async
684
+ */
685
+ listIndexesAsync(request?: protos.google.cloud.vectorsearch.v1beta.IListIndexesRequest, options?: CallOptions): AsyncIterable<protos.google.cloud.vectorsearch.v1beta.IIndex>;
686
+ /**
687
+ * Gets information about a location.
688
+ *
689
+ * @param {Object} request
690
+ * The request object that will be sent.
691
+ * @param {string} request.name
692
+ * Resource name for the location.
693
+ * @param {object} [options]
694
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html | CallOptions} for more details.
695
+ * @returns {Promise} - The promise which resolves to an array.
696
+ * The first element of the array is an object representing {@link google.cloud.location.Location | Location}.
697
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
698
+ * for more details and examples.
699
+ * @example
700
+ * ```
701
+ * const [response] = await client.getLocation(request);
702
+ * ```
703
+ */
704
+ 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>;
705
+ /**
706
+ * Lists information about the supported locations for this service. Returns an iterable object.
707
+ *
708
+ * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand.
709
+ * @param {Object} request
710
+ * The request object that will be sent.
711
+ * @param {string} request.name
712
+ * The resource that owns the locations collection, if applicable.
713
+ * @param {string} request.filter
714
+ * The standard list filter.
715
+ * @param {number} request.pageSize
716
+ * The standard list page size.
717
+ * @param {string} request.pageToken
718
+ * The standard list page token.
719
+ * @param {object} [options]
720
+ * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
721
+ * @returns {Object}
722
+ * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }.
723
+ * When you iterate the returned iterable, each element will be an object representing
724
+ * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page,
725
+ * so you can stop the iteration when you don't need more results.
726
+ * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation }
727
+ * for more details and examples.
728
+ * @example
729
+ * ```
730
+ * const iterable = client.listLocationsAsync(request);
731
+ * for await (const response of iterable) {
732
+ * // process response
733
+ * }
734
+ * ```
735
+ */
736
+ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable<LocationProtos.google.cloud.location.ILocation>;
737
+ /**
738
+ * Gets the latest state of a long-running operation. Clients can use this
739
+ * method to poll the operation result at intervals as recommended by the API
740
+ * service.
741
+ *
742
+ * @param {Object} request - The request object that will be sent.
743
+ * @param {string} request.name - The name of the operation resource.
744
+ * @param {Object=} options
745
+ * Optional parameters. You can override the default settings for this call,
746
+ * e.g, timeout, retries, paginations, etc. See {@link
747
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
748
+ * for the details.
749
+ * @param {function(?Error, ?Object)=} callback
750
+ * The function which will be called with the result of the API call.
751
+ *
752
+ * The second parameter to the callback is an object representing
753
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
754
+ * @return {Promise} - The promise which resolves to an array.
755
+ * The first element of the array is an object representing
756
+ * {@link google.longrunning.Operation | google.longrunning.Operation}.
757
+ * The promise has a method named "cancel" which cancels the ongoing API call.
758
+ *
759
+ * @example
760
+ * ```
761
+ * const client = longrunning.operationsClient();
762
+ * const name = '';
763
+ * const [response] = await client.getOperation({name});
764
+ * // doThingsWith(response)
765
+ * ```
766
+ */
767
+ getOperation(request: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: 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]>;
768
+ /**
769
+ * Lists operations that match the specified filter in the request. If the
770
+ * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object.
771
+ *
772
+ * For-await-of syntax is used with the iterable to recursively get response element on-demand.
773
+ *
774
+ * @param {Object} request - The request object that will be sent.
775
+ * @param {string} request.name - The name of the operation collection.
776
+ * @param {string} request.filter - The standard list filter.
777
+ * @param {number=} request.pageSize -
778
+ * The maximum number of resources contained in the underlying API
779
+ * response. If page streaming is performed per-resource, this
780
+ * parameter does not affect the return value. If page streaming is
781
+ * performed per-page, this determines the maximum number of
782
+ * resources in a page.
783
+ * @param {Object=} options
784
+ * Optional parameters. You can override the default settings for this call,
785
+ * e.g, timeout, retries, paginations, etc. See {@link
786
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
787
+ * details.
788
+ * @returns {Object}
789
+ * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}.
790
+ *
791
+ * @example
792
+ * ```
793
+ * const client = longrunning.operationsClient();
794
+ * for await (const response of client.listOperationsAsync(request));
795
+ * // doThingsWith(response)
796
+ * ```
797
+ */
798
+ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable<protos.google.longrunning.IOperation>;
799
+ /**
800
+ * Starts asynchronous cancellation on a long-running operation. The server
801
+ * makes a best effort to cancel the operation, but success is not
802
+ * guaranteed. If the server doesn't support this method, it returns
803
+ * `google.rpc.Code.UNIMPLEMENTED`. Clients can use
804
+ * {@link Operations.GetOperation} or
805
+ * other methods to check whether the cancellation succeeded or whether the
806
+ * operation completed despite cancellation. On successful cancellation,
807
+ * the operation is not deleted; instead, it becomes an operation with
808
+ * an {@link Operation.error} value with a {@link google.rpc.Status.code} of
809
+ * 1, corresponding to `Code.CANCELLED`.
810
+ *
811
+ * @param {Object} request - The request object that will be sent.
812
+ * @param {string} request.name - The name of the operation resource to be cancelled.
813
+ * @param {Object=} options
814
+ * Optional parameters. You can override the default settings for this call,
815
+ * e.g, timeout, retries, paginations, etc. See {@link
816
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the
817
+ * details.
818
+ * @param {function(?Error)=} callback
819
+ * The function which will be called with the result of the API call.
820
+ * @return {Promise} - The promise which resolves when API call finishes.
821
+ * The promise has a method named "cancel" which cancels the ongoing API
822
+ * call.
823
+ *
824
+ * @example
825
+ * ```
826
+ * const client = longrunning.operationsClient();
827
+ * await client.cancelOperation({name: ''});
828
+ * ```
829
+ */
830
+ cancelOperation(request: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>, callback?: Callback<protos.google.longrunning.CancelOperationRequest, protos.google.protobuf.Empty, {} | undefined | null>): Promise<protos.google.protobuf.Empty>;
831
+ /**
832
+ * Deletes a long-running operation. This method indicates that the client is
833
+ * no longer interested in the operation result. It does not cancel the
834
+ * operation. If the server doesn't support this method, it returns
835
+ * `google.rpc.Code.UNIMPLEMENTED`.
836
+ *
837
+ * @param {Object} request - The request object that will be sent.
838
+ * @param {string} request.name - The name of the operation resource to be deleted.
839
+ * @param {Object=} options
840
+ * Optional parameters. You can override the default settings for this call,
841
+ * e.g, timeout, retries, paginations, etc. See {@link
842
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions}
843
+ * for the details.
844
+ * @param {function(?Error)=} callback
845
+ * The function which will be called with the result of the API call.
846
+ * @return {Promise} - The promise which resolves when API call finishes.
847
+ * The promise has a method named "cancel" which cancels the ongoing API
848
+ * call.
849
+ *
850
+ * @example
851
+ * ```
852
+ * const client = longrunning.operationsClient();
853
+ * await client.deleteOperation({name: ''});
854
+ * ```
855
+ */
856
+ deleteOperation(request: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: 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>;
857
+ /**
858
+ * Return a fully-qualified collection resource name string.
859
+ *
860
+ * @param {string} project
861
+ * @param {string} location
862
+ * @param {string} collection
863
+ * @returns {string} Resource name string.
864
+ */
865
+ collectionPath(project: string, location: string, collection: string): string;
866
+ /**
867
+ * Parse the project from Collection resource.
868
+ *
869
+ * @param {string} collectionName
870
+ * A fully-qualified path representing Collection resource.
871
+ * @returns {string} A string representing the project.
872
+ */
873
+ matchProjectFromCollectionName(collectionName: string): string | number;
874
+ /**
875
+ * Parse the location from Collection resource.
876
+ *
877
+ * @param {string} collectionName
878
+ * A fully-qualified path representing Collection resource.
879
+ * @returns {string} A string representing the location.
880
+ */
881
+ matchLocationFromCollectionName(collectionName: string): string | number;
882
+ /**
883
+ * Parse the collection from Collection resource.
884
+ *
885
+ * @param {string} collectionName
886
+ * A fully-qualified path representing Collection resource.
887
+ * @returns {string} A string representing the collection.
888
+ */
889
+ matchCollectionFromCollectionName(collectionName: string): string | number;
890
+ /**
891
+ * Return a fully-qualified dataObject resource name string.
892
+ *
893
+ * @param {string} project
894
+ * @param {string} location
895
+ * @param {string} collection
896
+ * @param {string} dataObject
897
+ * @returns {string} Resource name string.
898
+ */
899
+ dataObjectPath(project: string, location: string, collection: string, dataObject: string): string;
900
+ /**
901
+ * Parse the project from DataObject resource.
902
+ *
903
+ * @param {string} dataObjectName
904
+ * A fully-qualified path representing DataObject resource.
905
+ * @returns {string} A string representing the project.
906
+ */
907
+ matchProjectFromDataObjectName(dataObjectName: string): string | number;
908
+ /**
909
+ * Parse the location from DataObject resource.
910
+ *
911
+ * @param {string} dataObjectName
912
+ * A fully-qualified path representing DataObject resource.
913
+ * @returns {string} A string representing the location.
914
+ */
915
+ matchLocationFromDataObjectName(dataObjectName: string): string | number;
916
+ /**
917
+ * Parse the collection from DataObject resource.
918
+ *
919
+ * @param {string} dataObjectName
920
+ * A fully-qualified path representing DataObject resource.
921
+ * @returns {string} A string representing the collection.
922
+ */
923
+ matchCollectionFromDataObjectName(dataObjectName: string): string | number;
924
+ /**
925
+ * Parse the dataObject from DataObject resource.
926
+ *
927
+ * @param {string} dataObjectName
928
+ * A fully-qualified path representing DataObject resource.
929
+ * @returns {string} A string representing the dataObject.
930
+ */
931
+ matchDataObjectFromDataObjectName(dataObjectName: string): string | number;
932
+ /**
933
+ * Return a fully-qualified index resource name string.
934
+ *
935
+ * @param {string} project
936
+ * @param {string} location
937
+ * @param {string} collection
938
+ * @param {string} index
939
+ * @returns {string} Resource name string.
940
+ */
941
+ indexPath(project: string, location: string, collection: string, index: string): string;
942
+ /**
943
+ * Parse the project from Index resource.
944
+ *
945
+ * @param {string} indexName
946
+ * A fully-qualified path representing Index resource.
947
+ * @returns {string} A string representing the project.
948
+ */
949
+ matchProjectFromIndexName(indexName: string): string | number;
950
+ /**
951
+ * Parse the location from Index resource.
952
+ *
953
+ * @param {string} indexName
954
+ * A fully-qualified path representing Index resource.
955
+ * @returns {string} A string representing the location.
956
+ */
957
+ matchLocationFromIndexName(indexName: string): string | number;
958
+ /**
959
+ * Parse the collection from Index resource.
960
+ *
961
+ * @param {string} indexName
962
+ * A fully-qualified path representing Index resource.
963
+ * @returns {string} A string representing the collection.
964
+ */
965
+ matchCollectionFromIndexName(indexName: string): string | number;
966
+ /**
967
+ * Parse the index from Index resource.
968
+ *
969
+ * @param {string} indexName
970
+ * A fully-qualified path representing Index resource.
971
+ * @returns {string} A string representing the index.
972
+ */
973
+ matchIndexFromIndexName(indexName: string): string | number;
974
+ /**
975
+ * Return a fully-qualified location resource name string.
976
+ *
977
+ * @param {string} project
978
+ * @param {string} location
979
+ * @returns {string} Resource name string.
980
+ */
981
+ locationPath(project: string, location: string): string;
982
+ /**
983
+ * Parse the project from Location resource.
984
+ *
985
+ * @param {string} locationName
986
+ * A fully-qualified path representing Location resource.
987
+ * @returns {string} A string representing the project.
988
+ */
989
+ matchProjectFromLocationName(locationName: string): string | number;
990
+ /**
991
+ * Parse the location from Location resource.
992
+ *
993
+ * @param {string} locationName
994
+ * A fully-qualified path representing Location resource.
995
+ * @returns {string} A string representing the location.
996
+ */
997
+ matchLocationFromLocationName(locationName: string): string | number;
998
+ /**
999
+ * Return a fully-qualified project resource name string.
1000
+ *
1001
+ * @param {string} project
1002
+ * @returns {string} Resource name string.
1003
+ */
1004
+ projectPath(project: string): string;
1005
+ /**
1006
+ * Parse the project from Project resource.
1007
+ *
1008
+ * @param {string} projectName
1009
+ * A fully-qualified path representing Project resource.
1010
+ * @returns {string} A string representing the project.
1011
+ */
1012
+ matchProjectFromProjectName(projectName: string): string | number;
1013
+ /**
1014
+ * Terminate the gRPC channel and close the client.
1015
+ *
1016
+ * The client will no longer be usable and all future behavior is undefined.
1017
+ * @returns {Promise} A promise that resolves when the client is closed.
1018
+ */
1019
+ close(): Promise<void>;
1020
+ }