google-cloud-firestore-v1 0.13.0 → 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: daaf7e0dea627c757380257e6136f54a014ce3d3abf119c83b5f841d7f27b3bb
4
- data.tar.gz: 6ce5619f7d260526ee8165cc0cbb261101b04dabdc4f02cd9dd64518d21ca59c
3
+ metadata.gz: 5a39459742546e2f2c2d7b823289fdcf0280c3d14dded7d7647311abc239b85c
4
+ data.tar.gz: 9d636f7b8fc6a1dc75eaeefe8c61b5c5210434204aaaf0bef958e75691b90e4a
5
5
  SHA512:
6
- metadata.gz: ecfbc1803fa94e263b082c90533e5ba3d7d03c4c9cb428a4e97010f1d82bb34e7f4f12dd8e68f0b0544b0fa695adf74226c8698376e8e19a942107a29b253f5e
7
- data.tar.gz: 1240f8b8bb30887f3ff84a9823158f80333b82573119310bb50dfa1415d7f682c81d1ba1c04132e5d5cb99a21d7e1b05f917723bd06af07d7f7d899117e73c35
6
+ metadata.gz: e58901879bfc57a44e8027222b418e1ced0a4ee2b5844cc2adbbe5c12d3e7cc980d254f01bb270b7aafde1362ec4b784d51132b9f39eb0691b59d6a998933248
7
+ data.tar.gz: 3eccd75184c392e75614c4bb6e551b42622012474a8696ce40f40df9af62cb3ec6443ec7a595100a755497c047d64a1e133ecb5aee1e7632f8a06473ec0aaa89
@@ -38,6 +38,9 @@ module Google
38
38
  # truly serverless apps.
39
39
  #
40
40
  class Client
41
+ # @private
42
+ API_VERSION = ""
43
+
41
44
  # @private
42
45
  DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
43
46
 
@@ -326,10 +329,11 @@ module Google
326
329
  # Customize the options with defaults
327
330
  metadata = @config.rpcs.get_document.metadata.to_h
328
331
 
329
- # Set x-goog-api-client and x-goog-user-project headers
332
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
330
333
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
331
334
  lib_name: @config.lib_name, lib_version: @config.lib_version,
332
335
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
336
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
333
337
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
334
338
 
335
339
  header_params = {}
@@ -469,10 +473,11 @@ module Google
469
473
  # Customize the options with defaults
470
474
  metadata = @config.rpcs.list_documents.metadata.to_h
471
475
 
472
- # Set x-goog-api-client and x-goog-user-project headers
476
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
473
477
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
474
478
  lib_name: @config.lib_name, lib_version: @config.lib_version,
475
479
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
480
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
476
481
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
477
482
 
478
483
  header_params = {}
@@ -575,10 +580,11 @@ module Google
575
580
  # Customize the options with defaults
576
581
  metadata = @config.rpcs.update_document.metadata.to_h
577
582
 
578
- # Set x-goog-api-client and x-goog-user-project headers
583
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
579
584
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
580
585
  lib_name: @config.lib_name, lib_version: @config.lib_version,
581
586
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
587
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
582
588
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
583
589
 
584
590
  header_params = {}
@@ -664,10 +670,11 @@ module Google
664
670
  # Customize the options with defaults
665
671
  metadata = @config.rpcs.delete_document.metadata.to_h
666
672
 
667
- # Set x-goog-api-client and x-goog-user-project headers
673
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
668
674
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
669
675
  lib_name: @config.lib_name, lib_version: @config.lib_version,
670
676
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
677
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
671
678
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
672
679
 
673
680
  header_params = {}
@@ -779,10 +786,11 @@ module Google
779
786
  # Customize the options with defaults
780
787
  metadata = @config.rpcs.batch_get_documents.metadata.to_h
781
788
 
782
- # Set x-goog-api-client and x-goog-user-project headers
789
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
783
790
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
784
791
  lib_name: @config.lib_name, lib_version: @config.lib_version,
785
792
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
793
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
786
794
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
787
795
 
788
796
  header_params = {}
@@ -868,10 +876,11 @@ module Google
868
876
  # Customize the options with defaults
869
877
  metadata = @config.rpcs.begin_transaction.metadata.to_h
870
878
 
871
- # Set x-goog-api-client and x-goog-user-project headers
879
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
872
880
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
873
881
  lib_name: @config.lib_name, lib_version: @config.lib_version,
874
882
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
883
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
875
884
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
876
885
 
877
886
  header_params = {}
@@ -960,10 +969,11 @@ module Google
960
969
  # Customize the options with defaults
961
970
  metadata = @config.rpcs.commit.metadata.to_h
962
971
 
963
- # Set x-goog-api-client and x-goog-user-project headers
972
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
964
973
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
965
974
  lib_name: @config.lib_name, lib_version: @config.lib_version,
966
975
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
976
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
967
977
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
968
978
 
969
979
  header_params = {}
@@ -1048,10 +1058,11 @@ module Google
1048
1058
  # Customize the options with defaults
1049
1059
  metadata = @config.rpcs.rollback.metadata.to_h
1050
1060
 
1051
- # Set x-goog-api-client and x-goog-user-project headers
1061
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1052
1062
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1053
1063
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1054
1064
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1065
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1055
1066
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1056
1067
 
1057
1068
  header_params = {}
@@ -1161,10 +1172,11 @@ module Google
1161
1172
  # Customize the options with defaults
1162
1173
  metadata = @config.rpcs.run_query.metadata.to_h
1163
1174
 
1164
- # Set x-goog-api-client and x-goog-user-project headers
1175
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1165
1176
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1166
1177
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1167
1178
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1179
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1168
1180
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1169
1181
 
1170
1182
  header_params = {}
@@ -1286,10 +1298,11 @@ module Google
1286
1298
  # Customize the options with defaults
1287
1299
  metadata = @config.rpcs.run_aggregation_query.metadata.to_h
1288
1300
 
1289
- # Set x-goog-api-client and x-goog-user-project headers
1301
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1290
1302
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1291
1303
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1292
1304
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1305
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1293
1306
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1294
1307
 
1295
1308
  header_params = {}
@@ -1422,10 +1435,11 @@ module Google
1422
1435
  # Customize the options with defaults
1423
1436
  metadata = @config.rpcs.partition_query.metadata.to_h
1424
1437
 
1425
- # Set x-goog-api-client and x-goog-user-project headers
1438
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1426
1439
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1427
1440
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1428
1441
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1442
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1429
1443
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1430
1444
 
1431
1445
  header_params = {}
@@ -1510,10 +1524,11 @@ module Google
1510
1524
  # Customize the options with defaults
1511
1525
  metadata = @config.rpcs.write.metadata.to_h
1512
1526
 
1513
- # Set x-goog-api-client and x-goog-user-project headers
1527
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1514
1528
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1515
1529
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1516
1530
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1531
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1517
1532
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1518
1533
 
1519
1534
  options.apply_defaults timeout: @config.rpcs.write.timeout,
@@ -1589,10 +1604,11 @@ module Google
1589
1604
  # Customize the options with defaults
1590
1605
  metadata = @config.rpcs.listen.metadata.to_h
1591
1606
 
1592
- # Set x-goog-api-client and x-goog-user-project headers
1607
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1593
1608
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1594
1609
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1595
1610
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1611
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1596
1612
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1597
1613
 
1598
1614
  options.apply_defaults timeout: @config.rpcs.listen.timeout,
@@ -1680,10 +1696,11 @@ module Google
1680
1696
  # Customize the options with defaults
1681
1697
  metadata = @config.rpcs.list_collection_ids.metadata.to_h
1682
1698
 
1683
- # Set x-goog-api-client and x-goog-user-project headers
1699
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1684
1700
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1685
1701
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1686
1702
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1703
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1687
1704
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1688
1705
 
1689
1706
  header_params = {}
@@ -1783,10 +1800,11 @@ module Google
1783
1800
  # Customize the options with defaults
1784
1801
  metadata = @config.rpcs.batch_write.metadata.to_h
1785
1802
 
1786
- # Set x-goog-api-client and x-goog-user-project headers
1803
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1787
1804
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1788
1805
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1789
1806
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1807
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1790
1808
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1791
1809
 
1792
1810
  header_params = {}
@@ -1884,10 +1902,11 @@ module Google
1884
1902
  # Customize the options with defaults
1885
1903
  metadata = @config.rpcs.create_document.metadata.to_h
1886
1904
 
1887
- # Set x-goog-api-client and x-goog-user-project headers
1905
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1888
1906
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1889
1907
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1890
1908
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION
1909
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1891
1910
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1892
1911
 
1893
1912
  header_params = {}
@@ -40,6 +40,9 @@ module Google
40
40
  # truly serverless apps.
41
41
  #
42
42
  class Client
43
+ # @private
44
+ API_VERSION = ""
45
+
43
46
  # @private
44
47
  DEFAULT_ENDPOINT_TEMPLATE = "firestore.$UNIVERSE_DOMAIN$"
45
48
 
@@ -311,12 +314,13 @@ module Google
311
314
  # Customize the options with defaults
312
315
  call_metadata = @config.rpcs.get_document.metadata.to_h
313
316
 
314
- # Set x-goog-api-client and x-goog-user-project headers
317
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
315
318
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
316
319
  lib_name: @config.lib_name, lib_version: @config.lib_version,
317
320
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
318
321
  transports_version_send: [:rest]
319
322
 
323
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
320
324
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
321
325
 
322
326
  options.apply_defaults timeout: @config.rpcs.get_document.timeout,
@@ -447,12 +451,13 @@ module Google
447
451
  # Customize the options with defaults
448
452
  call_metadata = @config.rpcs.list_documents.metadata.to_h
449
453
 
450
- # Set x-goog-api-client and x-goog-user-project headers
454
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
451
455
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
452
456
  lib_name: @config.lib_name, lib_version: @config.lib_version,
453
457
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
454
458
  transports_version_send: [:rest]
455
459
 
460
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
456
461
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
457
462
 
458
463
  options.apply_defaults timeout: @config.rpcs.list_documents.timeout,
@@ -543,12 +548,13 @@ module Google
543
548
  # Customize the options with defaults
544
549
  call_metadata = @config.rpcs.update_document.metadata.to_h
545
550
 
546
- # Set x-goog-api-client and x-goog-user-project headers
551
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
547
552
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
548
553
  lib_name: @config.lib_name, lib_version: @config.lib_version,
549
554
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
550
555
  transports_version_send: [:rest]
551
556
 
557
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
552
558
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
553
559
 
554
560
  options.apply_defaults timeout: @config.rpcs.update_document.timeout,
@@ -625,12 +631,13 @@ module Google
625
631
  # Customize the options with defaults
626
632
  call_metadata = @config.rpcs.delete_document.metadata.to_h
627
633
 
628
- # Set x-goog-api-client and x-goog-user-project headers
634
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
629
635
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
630
636
  lib_name: @config.lib_name, lib_version: @config.lib_version,
631
637
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
632
638
  transports_version_send: [:rest]
633
639
 
640
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
634
641
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
635
642
 
636
643
  options.apply_defaults timeout: @config.rpcs.delete_document.timeout,
@@ -729,12 +736,13 @@ module Google
729
736
  # Customize the options with defaults
730
737
  call_metadata = @config.rpcs.batch_get_documents.metadata.to_h
731
738
 
732
- # Set x-goog-api-client and x-goog-user-project headers
739
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
733
740
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
734
741
  lib_name: @config.lib_name, lib_version: @config.lib_version,
735
742
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
736
743
  transports_version_send: [:rest]
737
744
 
745
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
738
746
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
739
747
 
740
748
  options.apply_defaults timeout: @config.rpcs.batch_get_documents.timeout,
@@ -816,12 +824,13 @@ module Google
816
824
  # Customize the options with defaults
817
825
  call_metadata = @config.rpcs.begin_transaction.metadata.to_h
818
826
 
819
- # Set x-goog-api-client and x-goog-user-project headers
827
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
820
828
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
821
829
  lib_name: @config.lib_name, lib_version: @config.lib_version,
822
830
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
823
831
  transports_version_send: [:rest]
824
832
 
833
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
825
834
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
826
835
 
827
836
  options.apply_defaults timeout: @config.rpcs.begin_transaction.timeout,
@@ -901,12 +910,13 @@ module Google
901
910
  # Customize the options with defaults
902
911
  call_metadata = @config.rpcs.commit.metadata.to_h
903
912
 
904
- # Set x-goog-api-client and x-goog-user-project headers
913
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
905
914
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
906
915
  lib_name: @config.lib_name, lib_version: @config.lib_version,
907
916
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
908
917
  transports_version_send: [:rest]
909
918
 
919
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
910
920
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
911
921
 
912
922
  options.apply_defaults timeout: @config.rpcs.commit.timeout,
@@ -982,12 +992,13 @@ module Google
982
992
  # Customize the options with defaults
983
993
  call_metadata = @config.rpcs.rollback.metadata.to_h
984
994
 
985
- # Set x-goog-api-client and x-goog-user-project headers
995
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
986
996
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
987
997
  lib_name: @config.lib_name, lib_version: @config.lib_version,
988
998
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
989
999
  transports_version_send: [:rest]
990
1000
 
1001
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
991
1002
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
992
1003
 
993
1004
  options.apply_defaults timeout: @config.rpcs.rollback.timeout,
@@ -1084,12 +1095,13 @@ module Google
1084
1095
  # Customize the options with defaults
1085
1096
  call_metadata = @config.rpcs.run_query.metadata.to_h
1086
1097
 
1087
- # Set x-goog-api-client and x-goog-user-project headers
1098
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1088
1099
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1089
1100
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1090
1101
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
1091
1102
  transports_version_send: [:rest]
1092
1103
 
1104
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1093
1105
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1094
1106
 
1095
1107
  options.apply_defaults timeout: @config.rpcs.run_query.timeout,
@@ -1203,12 +1215,13 @@ module Google
1203
1215
  # Customize the options with defaults
1204
1216
  call_metadata = @config.rpcs.run_aggregation_query.metadata.to_h
1205
1217
 
1206
- # Set x-goog-api-client and x-goog-user-project headers
1218
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1207
1219
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1208
1220
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1209
1221
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
1210
1222
  transports_version_send: [:rest]
1211
1223
 
1224
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1212
1225
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1213
1226
 
1214
1227
  options.apply_defaults timeout: @config.rpcs.run_aggregation_query.timeout,
@@ -1337,12 +1350,13 @@ module Google
1337
1350
  # Customize the options with defaults
1338
1351
  call_metadata = @config.rpcs.partition_query.metadata.to_h
1339
1352
 
1340
- # Set x-goog-api-client and x-goog-user-project headers
1353
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1341
1354
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1342
1355
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1343
1356
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
1344
1357
  transports_version_send: [:rest]
1345
1358
 
1359
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1346
1360
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1347
1361
 
1348
1362
  options.apply_defaults timeout: @config.rpcs.partition_query.timeout,
@@ -1430,12 +1444,13 @@ module Google
1430
1444
  # Customize the options with defaults
1431
1445
  call_metadata = @config.rpcs.list_collection_ids.metadata.to_h
1432
1446
 
1433
- # Set x-goog-api-client and x-goog-user-project headers
1447
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1434
1448
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1435
1449
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1436
1450
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
1437
1451
  transports_version_send: [:rest]
1438
1452
 
1453
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1439
1454
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1440
1455
 
1441
1456
  options.apply_defaults timeout: @config.rpcs.list_collection_ids.timeout,
@@ -1527,12 +1542,13 @@ module Google
1527
1542
  # Customize the options with defaults
1528
1543
  call_metadata = @config.rpcs.batch_write.metadata.to_h
1529
1544
 
1530
- # Set x-goog-api-client and x-goog-user-project headers
1545
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1531
1546
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1532
1547
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1533
1548
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
1534
1549
  transports_version_send: [:rest]
1535
1550
 
1551
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1536
1552
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1537
1553
 
1538
1554
  options.apply_defaults timeout: @config.rpcs.batch_write.timeout,
@@ -1621,12 +1637,13 @@ module Google
1621
1637
  # Customize the options with defaults
1622
1638
  call_metadata = @config.rpcs.create_document.metadata.to_h
1623
1639
 
1624
- # Set x-goog-api-client and x-goog-user-project headers
1640
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
1625
1641
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
1626
1642
  lib_name: @config.lib_name, lib_version: @config.lib_version,
1627
1643
  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
1628
1644
  transports_version_send: [:rest]
1629
1645
 
1646
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
1630
1647
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
1631
1648
 
1632
1649
  options.apply_defaults timeout: @config.rpcs.create_document.timeout,
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Firestore
23
23
  module V1
24
- VERSION = "0.13.0"
24
+ VERSION = "1.0.0"
25
25
  end
26
26
  end
27
27
  end
@@ -9,7 +9,7 @@ require 'google/firestore/v1/document_pb'
9
9
  require 'google/protobuf/wrappers_pb'
10
10
 
11
11
 
12
- descriptor_data = "\n\x1fgoogle/firestore/v1/query.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\"google/firestore/v1/document.proto\x1a\x1egoogle/protobuf/wrappers.proto\"\xbe\x0f\n\x0fStructuredQuery\x12?\n\x06select\x18\x01 \x01(\x0b\x32/.google.firestore.v1.StructuredQuery.Projection\x12\x45\n\x04\x66rom\x18\x02 \x03(\x0b\x32\x37.google.firestore.v1.StructuredQuery.CollectionSelector\x12:\n\x05where\x18\x03 \x01(\x0b\x32+.google.firestore.v1.StructuredQuery.Filter\x12<\n\x08order_by\x18\x04 \x03(\x0b\x32*.google.firestore.v1.StructuredQuery.Order\x12-\n\x08start_at\x18\x07 \x01(\x0b\x32\x1b.google.firestore.v1.Cursor\x12+\n\x06\x65nd_at\x18\x08 \x01(\x0b\x32\x1b.google.firestore.v1.Cursor\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12*\n\x05limit\x18\x05 \x01(\x0b\x32\x1b.google.protobuf.Int32Value\x1a\x44\n\x12\x43ollectionSelector\x12\x15\n\rcollection_id\x18\x02 \x01(\t\x12\x17\n\x0f\x61ll_descendants\x18\x03 \x01(\x08\x1a\xfd\x01\n\x06\x46ilter\x12P\n\x10\x63omposite_filter\x18\x01 \x01(\x0b\x32\x34.google.firestore.v1.StructuredQuery.CompositeFilterH\x00\x12H\n\x0c\x66ield_filter\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.FieldFilterH\x00\x12H\n\x0cunary_filter\x18\x03 \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.UnaryFilterH\x00\x42\r\n\x0b\x66ilter_type\x1a\xd1\x01\n\x0f\x43ompositeFilter\x12I\n\x02op\x18\x01 \x01(\x0e\x32=.google.firestore.v1.StructuredQuery.CompositeFilter.Operator\x12<\n\x07\x66ilters\x18\x02 \x03(\x0b\x32+.google.firestore.v1.StructuredQuery.Filter\"5\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41ND\x10\x01\x12\x06\n\x02OR\x10\x02\x1a\x98\x03\n\x0b\x46ieldFilter\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x12\x45\n\x02op\x18\x02 \x01(\x0e\x32\x39.google.firestore.v1.StructuredQuery.FieldFilter.Operator\x12)\n\x05value\x18\x03 \x01(\x0b\x32\x1a.google.firestore.v1.Value\"\xd2\x01\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\r\n\tLESS_THAN\x10\x01\x12\x16\n\x12LESS_THAN_OR_EQUAL\x10\x02\x12\x10\n\x0cGREATER_THAN\x10\x03\x12\x19\n\x15GREATER_THAN_OR_EQUAL\x10\x04\x12\t\n\x05\x45QUAL\x10\x05\x12\r\n\tNOT_EQUAL\x10\x06\x12\x12\n\x0e\x41RRAY_CONTAINS\x10\x07\x12\x06\n\x02IN\x10\x08\x12\x16\n\x12\x41RRAY_CONTAINS_ANY\x10\t\x12\n\n\x06NOT_IN\x10\n\x1a\x8a\x02\n\x0bUnaryFilter\x12\x45\n\x02op\x18\x01 \x01(\x0e\x32\x39.google.firestore.v1.StructuredQuery.UnaryFilter.Operator\x12\x44\n\x05\x66ield\x18\x02 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceH\x00\"^\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\n\n\x06IS_NAN\x10\x02\x12\x0b\n\x07IS_NULL\x10\x03\x12\x0e\n\nIS_NOT_NAN\x10\x04\x12\x0f\n\x0bIS_NOT_NULL\x10\x05\x42\x0e\n\x0coperand_type\x1a\x8e\x01\n\x05Order\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x12\x41\n\tdirection\x18\x02 \x01(\x0e\x32..google.firestore.v1.StructuredQuery.Direction\x1a$\n\x0e\x46ieldReference\x12\x12\n\nfield_path\x18\x02 \x01(\t\x1aQ\n\nProjection\x12\x43\n\x06\x66ields\x18\x02 \x03(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\"E\n\tDirection\x12\x19\n\x15\x44IRECTION_UNSPECIFIED\x10\x00\x12\r\n\tASCENDING\x10\x01\x12\x0e\n\nDESCENDING\x10\x02\"\xb8\x05\n\x1aStructuredAggregationQuery\x12@\n\x10structured_query\x18\x01 \x01(\x0b\x32$.google.firestore.v1.StructuredQueryH\x00\x12V\n\x0c\x61ggregations\x18\x03 \x03(\x0b\x32;.google.firestore.v1.StructuredAggregationQuery.AggregationB\x03\xe0\x41\x01\x1a\xf1\x03\n\x0b\x41ggregation\x12R\n\x05\x63ount\x18\x01 \x01(\x0b\x32\x41.google.firestore.v1.StructuredAggregationQuery.Aggregation.CountH\x00\x12N\n\x03sum\x18\x02 \x01(\x0b\x32?.google.firestore.v1.StructuredAggregationQuery.Aggregation.SumH\x00\x12N\n\x03\x61vg\x18\x03 \x01(\x0b\x32?.google.firestore.v1.StructuredAggregationQuery.Aggregation.AvgH\x00\x12\x12\n\x05\x61lias\x18\x07 \x01(\tB\x03\xe0\x41\x01\x1a\x38\n\x05\x43ount\x12/\n\x05up_to\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64ValueB\x03\xe0\x41\x01\x1aI\n\x03Sum\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x1aI\n\x03\x41vg\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceB\n\n\x08operatorB\x0c\n\nquery_type\"D\n\x06\x43ursor\x12*\n\x06values\x18\x01 \x03(\x0b\x32\x1a.google.firestore.v1.Value\x12\x0e\n\x06\x62\x65\x66ore\x18\x02 \x01(\x08\x42\xc2\x01\n\x17\x63om.google.firestore.v1B\nQueryProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
12
+ descriptor_data = "\n\x1fgoogle/firestore/v1/query.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\"google/firestore/v1/document.proto\x1a\x1egoogle/protobuf/wrappers.proto\"\x95\x13\n\x0fStructuredQuery\x12?\n\x06select\x18\x01 \x01(\x0b\x32/.google.firestore.v1.StructuredQuery.Projection\x12\x45\n\x04\x66rom\x18\x02 \x03(\x0b\x32\x37.google.firestore.v1.StructuredQuery.CollectionSelector\x12:\n\x05where\x18\x03 \x01(\x0b\x32+.google.firestore.v1.StructuredQuery.Filter\x12<\n\x08order_by\x18\x04 \x03(\x0b\x32*.google.firestore.v1.StructuredQuery.Order\x12-\n\x08start_at\x18\x07 \x01(\x0b\x32\x1b.google.firestore.v1.Cursor\x12+\n\x06\x65nd_at\x18\x08 \x01(\x0b\x32\x1b.google.firestore.v1.Cursor\x12\x0e\n\x06offset\x18\x06 \x01(\x05\x12*\n\x05limit\x18\x05 \x01(\x0b\x32\x1b.google.protobuf.Int32Value\x12K\n\x0c\x66ind_nearest\x18\t \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.FindNearestB\x03\xe0\x41\x01\x1a\x44\n\x12\x43ollectionSelector\x12\x15\n\rcollection_id\x18\x02 \x01(\t\x12\x17\n\x0f\x61ll_descendants\x18\x03 \x01(\x08\x1a\xfd\x01\n\x06\x46ilter\x12P\n\x10\x63omposite_filter\x18\x01 \x01(\x0b\x32\x34.google.firestore.v1.StructuredQuery.CompositeFilterH\x00\x12H\n\x0c\x66ield_filter\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.FieldFilterH\x00\x12H\n\x0cunary_filter\x18\x03 \x01(\x0b\x32\x30.google.firestore.v1.StructuredQuery.UnaryFilterH\x00\x42\r\n\x0b\x66ilter_type\x1a\xd1\x01\n\x0f\x43ompositeFilter\x12I\n\x02op\x18\x01 \x01(\x0e\x32=.google.firestore.v1.StructuredQuery.CompositeFilter.Operator\x12<\n\x07\x66ilters\x18\x02 \x03(\x0b\x32+.google.firestore.v1.StructuredQuery.Filter\"5\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\x07\n\x03\x41ND\x10\x01\x12\x06\n\x02OR\x10\x02\x1a\x98\x03\n\x0b\x46ieldFilter\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x12\x45\n\x02op\x18\x02 \x01(\x0e\x32\x39.google.firestore.v1.StructuredQuery.FieldFilter.Operator\x12)\n\x05value\x18\x03 \x01(\x0b\x32\x1a.google.firestore.v1.Value\"\xd2\x01\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\r\n\tLESS_THAN\x10\x01\x12\x16\n\x12LESS_THAN_OR_EQUAL\x10\x02\x12\x10\n\x0cGREATER_THAN\x10\x03\x12\x19\n\x15GREATER_THAN_OR_EQUAL\x10\x04\x12\t\n\x05\x45QUAL\x10\x05\x12\r\n\tNOT_EQUAL\x10\x06\x12\x12\n\x0e\x41RRAY_CONTAINS\x10\x07\x12\x06\n\x02IN\x10\x08\x12\x16\n\x12\x41RRAY_CONTAINS_ANY\x10\t\x12\n\n\x06NOT_IN\x10\n\x1a\x8a\x02\n\x0bUnaryFilter\x12\x45\n\x02op\x18\x01 \x01(\x0e\x32\x39.google.firestore.v1.StructuredQuery.UnaryFilter.Operator\x12\x44\n\x05\x66ield\x18\x02 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceH\x00\"^\n\x08Operator\x12\x18\n\x14OPERATOR_UNSPECIFIED\x10\x00\x12\n\n\x06IS_NAN\x10\x02\x12\x0b\n\x07IS_NULL\x10\x03\x12\x0e\n\nIS_NOT_NAN\x10\x04\x12\x0f\n\x0bIS_NOT_NULL\x10\x05\x42\x0e\n\x0coperand_type\x1a\x8e\x01\n\x05Order\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x12\x41\n\tdirection\x18\x02 \x01(\x0e\x32..google.firestore.v1.StructuredQuery.Direction\x1a$\n\x0e\x46ieldReference\x12\x12\n\nfield_path\x18\x02 \x01(\t\x1aQ\n\nProjection\x12\x43\n\x06\x66ields\x18\x02 \x03(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x1a\x87\x03\n\x0b\x46indNearest\x12N\n\x0cvector_field\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceB\x03\xe0\x41\x02\x12\x35\n\x0cquery_vector\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.ValueB\x03\xe0\x41\x02\x12_\n\x10\x64istance_measure\x18\x03 \x01(\x0e\x32@.google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasureB\x03\xe0\x41\x02\x12/\n\x05limit\x18\x04 \x01(\x0b\x32\x1b.google.protobuf.Int32ValueB\x03\xe0\x41\x02\"_\n\x0f\x44istanceMeasure\x12 \n\x1c\x44ISTANCE_MEASURE_UNSPECIFIED\x10\x00\x12\r\n\tEUCLIDEAN\x10\x01\x12\n\n\x06\x43OSINE\x10\x02\x12\x0f\n\x0b\x44OT_PRODUCT\x10\x03\"E\n\tDirection\x12\x19\n\x15\x44IRECTION_UNSPECIFIED\x10\x00\x12\r\n\tASCENDING\x10\x01\x12\x0e\n\nDESCENDING\x10\x02\"\xb8\x05\n\x1aStructuredAggregationQuery\x12@\n\x10structured_query\x18\x01 \x01(\x0b\x32$.google.firestore.v1.StructuredQueryH\x00\x12V\n\x0c\x61ggregations\x18\x03 \x03(\x0b\x32;.google.firestore.v1.StructuredAggregationQuery.AggregationB\x03\xe0\x41\x01\x1a\xf1\x03\n\x0b\x41ggregation\x12R\n\x05\x63ount\x18\x01 \x01(\x0b\x32\x41.google.firestore.v1.StructuredAggregationQuery.Aggregation.CountH\x00\x12N\n\x03sum\x18\x02 \x01(\x0b\x32?.google.firestore.v1.StructuredAggregationQuery.Aggregation.SumH\x00\x12N\n\x03\x61vg\x18\x03 \x01(\x0b\x32?.google.firestore.v1.StructuredAggregationQuery.Aggregation.AvgH\x00\x12\x12\n\x05\x61lias\x18\x07 \x01(\tB\x03\xe0\x41\x01\x1a\x38\n\x05\x43ount\x12/\n\x05up_to\x18\x01 \x01(\x0b\x32\x1b.google.protobuf.Int64ValueB\x03\xe0\x41\x01\x1aI\n\x03Sum\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReference\x1aI\n\x03\x41vg\x12\x42\n\x05\x66ield\x18\x01 \x01(\x0b\x32\x33.google.firestore.v1.StructuredQuery.FieldReferenceB\n\n\x08operatorB\x0c\n\nquery_type\"D\n\x06\x43ursor\x12*\n\x06values\x18\x01 \x03(\x0b\x32\x1a.google.firestore.v1.Value\x12\x0e\n\x06\x62\x65\x66ore\x18\x02 \x01(\x08\x42\xc2\x01\n\x17\x63om.google.firestore.v1B\nQueryProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
13
13
 
14
14
  pool = Google::Protobuf::DescriptorPool.generated_pool
15
15
 
@@ -53,6 +53,8 @@ module Google
53
53
  StructuredQuery::Order = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredQuery.Order").msgclass
54
54
  StructuredQuery::FieldReference = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredQuery.FieldReference").msgclass
55
55
  StructuredQuery::Projection = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredQuery.Projection").msgclass
56
+ StructuredQuery::FindNearest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredQuery.FindNearest").msgclass
57
+ StructuredQuery::FindNearest::DistanceMeasure = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure").enummodule
56
58
  StructuredQuery::Direction = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredQuery.Direction").enummodule
57
59
  StructuredAggregationQuery = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredAggregationQuery").msgclass
58
60
  StructuredAggregationQuery::Aggregation = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.StructuredAggregationQuery.Aggregation").msgclass
@@ -128,6 +128,13 @@ module Google
128
128
  # Requires:
129
129
  #
130
130
  # * The value must be greater than or equal to zero if specified.
131
+ # @!attribute [rw] find_nearest
132
+ # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest]
133
+ # Optional. A potential Nearest Neighbors Search.
134
+ #
135
+ # Applies after all other filters and ordering.
136
+ #
137
+ # Finds the closest vector embeddings to the given query vector.
131
138
  class StructuredQuery
132
139
  include ::Google::Protobuf::MessageExts
133
140
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -362,6 +369,52 @@ module Google
362
369
  extend ::Google::Protobuf::MessageExts::ClassMethods
363
370
  end
364
371
 
372
+ # Nearest Neighbors search config.
373
+ # @!attribute [rw] vector_field
374
+ # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FieldReference]
375
+ # Required. An indexed vector field to search upon. Only documents which
376
+ # contain vectors whose dimensionality match the query_vector can be
377
+ # returned.
378
+ # @!attribute [rw] query_vector
379
+ # @return [::Google::Cloud::Firestore::V1::Value]
380
+ # Required. The query vector that we are searching on. Must be a vector of
381
+ # no more than 2048 dimensions.
382
+ # @!attribute [rw] distance_measure
383
+ # @return [::Google::Cloud::Firestore::V1::StructuredQuery::FindNearest::DistanceMeasure]
384
+ # Required. The Distance Measure to use, required.
385
+ # @!attribute [rw] limit
386
+ # @return [::Google::Protobuf::Int32Value]
387
+ # Required. The number of nearest neighbors to return. Must be a positive
388
+ # integer of no more than 1000.
389
+ class FindNearest
390
+ include ::Google::Protobuf::MessageExts
391
+ extend ::Google::Protobuf::MessageExts::ClassMethods
392
+
393
+ # The distance measure to use when comparing vectors.
394
+ module DistanceMeasure
395
+ # Should not be set.
396
+ DISTANCE_MEASURE_UNSPECIFIED = 0
397
+
398
+ # Measures the EUCLIDEAN distance between the vectors. See
399
+ # [Euclidean](https://en.wikipedia.org/wiki/Euclidean_distance) to learn
400
+ # more
401
+ EUCLIDEAN = 1
402
+
403
+ # Compares vectors based on the angle between them, which allows you to
404
+ # measure similarity that isn't based on the vectors magnitude.
405
+ # We recommend using DOT_PRODUCT with unit normalized vectors instead of
406
+ # COSINE distance, which is mathematically equivalent with better
407
+ # performance. See [Cosine
408
+ # Similarity](https://en.wikipedia.org/wiki/Cosine_similarity) to learn
409
+ # more.
410
+ COSINE = 2
411
+
412
+ # Similar to cosine but is affected by the magnitude of the vectors. See
413
+ # [Dot Product](https://en.wikipedia.org/wiki/Dot_product) to learn more.
414
+ DOT_PRODUCT = 3
415
+ end
416
+ end
417
+
365
418
  # A sort direction.
366
419
  module Direction
367
420
  # Unspecified.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-firestore-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.13.0
4
+ version: 1.0.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-22 00:00:00.000000000 Z
11
+ date: 2024-07-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common