@maxim_mazurok/gapi.client.firestore-v1 0.0.20240713 → 0.0.20240822

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 (2) hide show
  1. package/index.d.ts +35 -21
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://firestore.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20240713
12
+ // Revision: 20240822
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -250,6 +250,10 @@ declare namespace gapi.client {
250
250
  interface FindNearest {
251
251
  /** Required. The distance measure to use, required. */
252
252
  distanceMeasure?: string;
253
+ /** Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations. */
254
+ distanceResultField?: string;
255
+ /** Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. For EUCLIDEAN, COSINE: WHERE distance <= distance_threshold For DOT_PRODUCT: WHERE distance >= distance_threshold */
256
+ distanceThreshold?: number;
253
257
  /** Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. */
254
258
  limit?: number;
255
259
  /** Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. */
@@ -288,11 +292,11 @@ declare namespace gapi.client {
288
292
  weeklyRecurrence?: GoogleFirestoreAdminV1WeeklyRecurrence;
289
293
  }
290
294
  interface GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata {
291
- /** The ids of the collection groups that are being deleted. */
295
+ /** The IDs of the collection groups that are being deleted. */
292
296
  collectionIds?: string[];
293
297
  /** The time this operation completed. Will be unset if operation still in progress. */
294
298
  endTime?: string;
295
- /** Which namespace ids are being deleted. */
299
+ /** Which namespace IDs are being deleted. */
296
300
  namespaceIds?: string[];
297
301
  /** The state of the operation. */
298
302
  operationState?: string;
@@ -318,6 +322,10 @@ declare namespace gapi.client {
318
322
  kmsKeyName?: string;
319
323
  }
320
324
  interface GoogleFirestoreAdminV1CreateDatabaseMetadata {}
325
+ interface GoogleFirestoreAdminV1CustomerManagedEncryptionOptions {
326
+ /** Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
327
+ kmsKeyName?: string;
328
+ }
321
329
  interface GoogleFirestoreAdminV1DailyRecurrence {}
322
330
  interface GoogleFirestoreAdminV1Database {
323
331
  /** The App Engine integration mode to use for this database. */
@@ -336,7 +344,7 @@ declare namespace gapi.client {
336
344
  earliestVersionTime?: string;
337
345
  /** This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. */
338
346
  etag?: string;
339
- /** Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("~") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). */
347
+ /** Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo). */
340
348
  keyPrefix?: string;
341
349
  /** The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations. */
342
350
  locationId?: string;
@@ -356,12 +364,20 @@ declare namespace gapi.client {
356
364
  versionRetentionPeriod?: string;
357
365
  }
358
366
  interface GoogleFirestoreAdminV1DeleteDatabaseMetadata {}
367
+ interface GoogleFirestoreAdminV1EncryptionConfig {
368
+ /** Use Customer Managed Encryption Keys (CMEK) for encryption. */
369
+ customerManagedEncryption?: GoogleFirestoreAdminV1CustomerManagedEncryptionOptions;
370
+ /** Use Google default encryption. */
371
+ googleDefaultEncryption?: any;
372
+ /** The database will use the same encryption configuration as the source. */
373
+ useSourceEncryption?: any;
374
+ }
359
375
  interface GoogleFirestoreAdminV1ExportDocumentsMetadata {
360
- /** Which collection ids are being exported. */
376
+ /** Which collection IDs are being exported. */
361
377
  collectionIds?: string[];
362
378
  /** The time this operation completed. Will be unset if operation still in progress. */
363
379
  endTime?: string;
364
- /** Which namespace ids are being exported. */
380
+ /** Which namespace IDs are being exported. */
365
381
  namespaceIds?: string[];
366
382
  /** The state of the export operation. */
367
383
  operationState?: string;
@@ -377,7 +393,7 @@ declare namespace gapi.client {
377
393
  startTime?: string;
378
394
  }
379
395
  interface GoogleFirestoreAdminV1ExportDocumentsRequest {
380
- /** Which collection ids to export. Unspecified means all collections. Each collection id in this list must be unique. */
396
+ /** Which collection IDs to export. Unspecified means all collections. Each collection ID in this list must be unique. */
381
397
  collectionIds?: string[];
382
398
  /** An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to include them. Each namespace in this list must be unique. */
383
399
  namespaceIds?: string[];
@@ -417,14 +433,15 @@ declare namespace gapi.client {
417
433
  ttlConfigDelta?: GoogleFirestoreAdminV1TtlConfigDelta;
418
434
  }
419
435
  interface GoogleFirestoreAdminV1FlatIndex {}
436
+ interface GoogleFirestoreAdminV1GoogleDefaultEncryptionOptions {}
420
437
  interface GoogleFirestoreAdminV1ImportDocumentsMetadata {
421
- /** Which collection ids are being imported. */
438
+ /** Which collection IDs are being imported. */
422
439
  collectionIds?: string[];
423
440
  /** The time this operation completed. Will be unset if operation still in progress. */
424
441
  endTime?: string;
425
442
  /** The location of the documents being imported. */
426
443
  inputUriPrefix?: string;
427
- /** Which namespace ids are being imported. */
444
+ /** Which namespace IDs are being imported. */
428
445
  namespaceIds?: string[];
429
446
  /** The state of the import operation. */
430
447
  operationState?: string;
@@ -436,7 +453,7 @@ declare namespace gapi.client {
436
453
  startTime?: string;
437
454
  }
438
455
  interface GoogleFirestoreAdminV1ImportDocumentsRequest {
439
- /** Which collection ids to import. Unspecified means all collections included in the import. Each collection id in this list must be unique. */
456
+ /** Which collection IDs to import. Unspecified means all collections included in the import. Each collection ID in this list must be unique. */
440
457
  collectionIds?: string[];
441
458
  /** Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix. */
442
459
  inputUriPrefix?: string;
@@ -450,7 +467,7 @@ declare namespace gapi.client {
450
467
  fields?: GoogleFirestoreAdminV1IndexField[];
451
468
  /** Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. */
452
469
  name?: string;
453
- /** Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. */
470
+ /** Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection ID. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection ID as this index. */
454
471
  queryScope?: string;
455
472
  /** Output only. The serving state of the index. */
456
473
  state?: string;
@@ -545,17 +562,14 @@ declare namespace gapi.client {
545
562
  startTime?: string;
546
563
  }
547
564
  interface GoogleFirestoreAdminV1RestoreDatabaseRequest {
548
- /** Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}` */
565
+ /** Required. Backup to restore from. Must be from the same project as the parent. The restored database will be created in the same location as the source backup. Format is: `projects/{project_id}/locations/{location}/backups/{backup}` */
549
566
  backup?: string;
550
- /** Required. The ID to use for the database, which will become the final component of the database's resource name. This database id must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid. */
567
+ /** Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. */
551
568
  databaseId?: string;
552
- /** Use Customer Managed Encryption Keys (CMEK) for encryption. Only keys in the same location as the restored database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. */
553
- kmsKeyName?: string;
554
- /** The restored database will use the same encryption configuration as the backup. This is the default option when no `encryption_config` is specified. */
555
- useBackupEncryption?: any;
556
- /** Use Google default encryption. */
557
- useGoogleDefaultEncryption?: any;
569
+ /** Optional. Encryption configuration for the restored database. If this field is not specified, the restored database will use the same encryption configuration as the backup, namely use_source_encryption. */
570
+ encryptionConfig?: GoogleFirestoreAdminV1EncryptionConfig;
558
571
  }
572
+ interface GoogleFirestoreAdminV1SourceEncryptionOptions {}
559
573
  interface GoogleFirestoreAdminV1Stats {
560
574
  /** Output only. The total number of documents contained in the backup. */
561
575
  documentCount?: string;
@@ -2544,7 +2558,7 @@ declare namespace gapi.client {
2544
2558
  alt?: string;
2545
2559
  /** JSONP */
2546
2560
  callback?: string;
2547
- /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid. */
2561
+ /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. */
2548
2562
  databaseId?: string;
2549
2563
  /** Selector specifying which fields to include in a partial response. */
2550
2564
  fields?: string;
@@ -2575,7 +2589,7 @@ declare namespace gapi.client {
2575
2589
  alt?: string;
2576
2590
  /** JSONP */
2577
2591
  callback?: string;
2578
- /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database id is also valid. */
2592
+ /** Required. The ID to use for the database, which will become the final component of the database's resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. "(default)" database ID is also valid. */
2579
2593
  databaseId?: string;
2580
2594
  /** Selector specifying which fields to include in a partial response. */
2581
2595
  fields?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.firestore-v1",
3
- "version": "0.0.20240713",
3
+ "version": "0.0.20240822",
4
4
  "description": "TypeScript typings for Cloud Firestore API v1",
5
5
  "repository": {
6
6
  "type": "git",