Class: Google::Cloud::Firestore::V1beta1::FirestoreClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/firestore/v1beta1/firestore_client.rb

Overview

The Cloud Firestore service.

This service exposes several types of comparable timestamps:

  • +create_time+ - The time at which a document was created. Changes only when a document is deleted, then re-created. Increases in a strict monotonic fashion.
  • +update_time+ - The time at which a document was last updated. Changes every time a document is modified. Does not change when a write results in no modifications. Increases in a strict monotonic fashion.
  • +read_time+ - The time at which a particular state was observed. Used to denote a consistent snapshot of the database or the time at which a Document was observed to not exist.
  • +commit_time+ - The time at which the writes in a transaction were committed. Any read with an equal or greater +read_time+ is guaranteed to see the effects of the transaction.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"firestore.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT =
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/datastore"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ FirestoreClient

Returns a new instance of FirestoreClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc)

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>)

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash)

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric)

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash)

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc)

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 191

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/firestore/v1beta1/firestore_services_pb"

  credentials ||= Google::Cloud::Firestore::V1beta1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Firestore::V1beta1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-firestore'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!() unless .nil?
  client_config_file = Pathname.new(__dir__).join(
    "firestore_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.firestore.v1beta1.Firestore",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @firestore_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Firestore::V1beta1::Firestore::Stub.method(:new)
  )

  @get_document = Google::Gax.create_api_call(
    @firestore_stub.method(:get_document),
    defaults["get_document"],
    exception_transformer: exception_transformer
  )
  @list_documents = Google::Gax.create_api_call(
    @firestore_stub.method(:list_documents),
    defaults["list_documents"],
    exception_transformer: exception_transformer
  )
  @create_document = Google::Gax.create_api_call(
    @firestore_stub.method(:create_document),
    defaults["create_document"],
    exception_transformer: exception_transformer
  )
  @update_document = Google::Gax.create_api_call(
    @firestore_stub.method(:update_document),
    defaults["update_document"],
    exception_transformer: exception_transformer
  )
  @delete_document = Google::Gax.create_api_call(
    @firestore_stub.method(:delete_document),
    defaults["delete_document"],
    exception_transformer: exception_transformer
  )
  @batch_get_documents = Google::Gax.create_api_call(
    @firestore_stub.method(:batch_get_documents),
    defaults["batch_get_documents"],
    exception_transformer: exception_transformer
  )
  @begin_transaction = Google::Gax.create_api_call(
    @firestore_stub.method(:begin_transaction),
    defaults["begin_transaction"],
    exception_transformer: exception_transformer
  )
  @commit = Google::Gax.create_api_call(
    @firestore_stub.method(:commit),
    defaults["commit"],
    exception_transformer: exception_transformer
  )
  @rollback = Google::Gax.create_api_call(
    @firestore_stub.method(:rollback),
    defaults["rollback"],
    exception_transformer: exception_transformer
  )
  @run_query = Google::Gax.create_api_call(
    @firestore_stub.method(:run_query),
    defaults["run_query"],
    exception_transformer: exception_transformer
  )
  @write = Google::Gax.create_api_call(
    @firestore_stub.method(:write),
    defaults["write"],
    exception_transformer: exception_transformer
  )
  @listen = Google::Gax.create_api_call(
    @firestore_stub.method(:listen),
    defaults["listen"],
    exception_transformer: exception_transformer
  )
  @list_collection_ids = Google::Gax.create_api_call(
    @firestore_stub.method(:list_collection_ids),
    defaults["list_collection_ids"],
    exception_transformer: exception_transformer
  )
end

Instance Attribute Details

#firestore_stubGoogle::Firestore::V1beta1::Firestore::Stub (readonly)

Returns:

  • (Google::Firestore::V1beta1::Firestore::Stub)


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 53

class FirestoreClient
  attr_reader :firestore_stub

  # The default address of the service.
  SERVICE_ADDRESS = "firestore.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  # The default set of gRPC interceptors.
  GRPC_INTERCEPTORS = []

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_documents" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "documents"),
    "list_collection_ids" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "collection_ids")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/datastore"
  ].freeze


  DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/databases/{database}"
  )

  private_constant :DATABASE_ROOT_PATH_TEMPLATE

  DOCUMENT_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/databases/{database}/documents"
  )

  private_constant :DOCUMENT_ROOT_PATH_TEMPLATE

  DOCUMENT_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/databases/{database}/documents/{document_path=**}"
  )

  private_constant :DOCUMENT_PATH_PATH_TEMPLATE

  ANY_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/databases/{database}/documents/{document}/{any_path=**}"
  )

  private_constant :ANY_PATH_PATH_TEMPLATE

  # Returns a fully-qualified database_root resource name string.
  # @param project [String]
  # @param database [String]
  # @return [String]
  def self.database_root_path project, database
    DATABASE_ROOT_PATH_TEMPLATE.render(
      :"project" => project,
      :"database" => database
    )
  end

  # Returns a fully-qualified document_root resource name string.
  # @param project [String]
  # @param database [String]
  # @return [String]
  def self.document_root_path project, database
    DOCUMENT_ROOT_PATH_TEMPLATE.render(
      :"project" => project,
      :"database" => database
    )
  end

  # Returns a fully-qualified document_path resource name string.
  # @param project [String]
  # @param database [String]
  # @param document_path [String]
  # @return [String]
  def self.document_path_path project, database, document_path
    DOCUMENT_PATH_PATH_TEMPLATE.render(
      :"project" => project,
      :"database" => database,
      :"document_path" => document_path
    )
  end

  # Returns a fully-qualified any_path resource name string.
  # @param project [String]
  # @param database [String]
  # @param document [String]
  # @param any_path [String]
  # @return [String]
  def self.any_path_path project, database, document, any_path
    ANY_PATH_PATH_TEMPLATE.render(
      :"project" => project,
      :"database" => database,
      :"document" => document,
      :"any_path" => any_path
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  # @param metadata [Hash]
  #   Default metadata to be sent with each request. This can be overridden on a per call basis.
  # @param exception_transformer [Proc]
  #   An optional proc that intercepts any exceptions raised during an API call to inject
  #   custom error handling.
  def initialize \
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      metadata: nil,
      exception_transformer: nil,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/firestore/v1beta1/firestore_services_pb"

    credentials ||= Google::Cloud::Firestore::V1beta1::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Firestore::V1beta1::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    package_version = Gem.loaded_specs['google-cloud-firestore'].version.version

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    headers.merge!() unless .nil?
    client_config_file = Pathname.new(__dir__).join(
      "firestore_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.firestore.v1beta1.Firestore",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        metadata: headers
      )
    end

    # Allow overriding the service path/port in subclasses.
    service_path = self.class::SERVICE_ADDRESS
    port = self.class::DEFAULT_SERVICE_PORT
    interceptors = self.class::GRPC_INTERCEPTORS
    @firestore_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      interceptors: interceptors,
      &Google::Firestore::V1beta1::Firestore::Stub.method(:new)
    )

    @get_document = Google::Gax.create_api_call(
      @firestore_stub.method(:get_document),
      defaults["get_document"],
      exception_transformer: exception_transformer
    )
    @list_documents = Google::Gax.create_api_call(
      @firestore_stub.method(:list_documents),
      defaults["list_documents"],
      exception_transformer: exception_transformer
    )
    @create_document = Google::Gax.create_api_call(
      @firestore_stub.method(:create_document),
      defaults["create_document"],
      exception_transformer: exception_transformer
    )
    @update_document = Google::Gax.create_api_call(
      @firestore_stub.method(:update_document),
      defaults["update_document"],
      exception_transformer: exception_transformer
    )
    @delete_document = Google::Gax.create_api_call(
      @firestore_stub.method(:delete_document),
      defaults["delete_document"],
      exception_transformer: exception_transformer
    )
    @batch_get_documents = Google::Gax.create_api_call(
      @firestore_stub.method(:batch_get_documents),
      defaults["batch_get_documents"],
      exception_transformer: exception_transformer
    )
    @begin_transaction = Google::Gax.create_api_call(
      @firestore_stub.method(:begin_transaction),
      defaults["begin_transaction"],
      exception_transformer: exception_transformer
    )
    @commit = Google::Gax.create_api_call(
      @firestore_stub.method(:commit),
      defaults["commit"],
      exception_transformer: exception_transformer
    )
    @rollback = Google::Gax.create_api_call(
      @firestore_stub.method(:rollback),
      defaults["rollback"],
      exception_transformer: exception_transformer
    )
    @run_query = Google::Gax.create_api_call(
      @firestore_stub.method(:run_query),
      defaults["run_query"],
      exception_transformer: exception_transformer
    )
    @write = Google::Gax.create_api_call(
      @firestore_stub.method(:write),
      defaults["write"],
      exception_transformer: exception_transformer
    )
    @listen = Google::Gax.create_api_call(
      @firestore_stub.method(:listen),
      defaults["listen"],
      exception_transformer: exception_transformer
    )
    @list_collection_ids = Google::Gax.create_api_call(
      @firestore_stub.method(:list_collection_ids),
      defaults["list_collection_ids"],
      exception_transformer: exception_transformer
    )
  end

  # Service calls

  # Gets a single document.
  #
  # @param name [String]
  #   The resource name of the Document to get. In the format:
  #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
  #   The fields to return. If not set, returns all fields.
  #
  #   If the document has a field that is not present in this mask, that field
  #   will not be returned in the response.
  #   A hash of the same form as `Google::Firestore::V1beta1::DocumentMask`
  #   can also be provided.
  # @param transaction [String]
  #   Reads the document in a transaction.
  # @param read_time [Google::Protobuf::Timestamp | Hash]
  #   Reads the version of the document at the given time.
  #   This may not be older than 60 seconds.
  #   A hash of the same form as `Google::Protobuf::Timestamp`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Firestore::V1beta1::Document]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Firestore::V1beta1::Document]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_name = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
  #   response = firestore_client.get_document(formatted_name)

  def get_document \
      name,
      mask: nil,
      transaction: nil,
      read_time: nil,
      options: nil,
      &block
    req = {
      name: name,
      mask: mask,
      transaction: transaction,
      read_time: read_time
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::GetDocumentRequest)
    @get_document.call(req, options, &block)
  end

  # Lists documents.
  #
  # @param parent [String]
  #   The parent resource name. In the format:
  #   +projects/{project_id}/databases/{database_id}/documents+ or
  #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
  #   For example:
  #   +projects/my-project/databases/my-database/documents+ or
  #   +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
  # @param collection_id [String]
  #   The collection ID, relative to +parent+, to list. For example: +chatrooms+
  #   or +messages+.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param order_by [String]
  #   The order to sort results by. For example: +priority desc, name+.
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
  #   The fields to return. If not set, returns all fields.
  #
  #   If a document has a field that is not present in this mask, that field
  #   will not be returned in the response.
  #   A hash of the same form as `Google::Firestore::V1beta1::DocumentMask`
  #   can also be provided.
  # @param transaction [String]
  #   Reads documents in a transaction.
  # @param read_time [Google::Protobuf::Timestamp | Hash]
  #   Reads documents as they were at the given time.
  #   This may not be older than 60 seconds.
  #   A hash of the same form as `Google::Protobuf::Timestamp`
  #   can also be provided.
  # @param show_missing [true, false]
  #   If the list should show missing documents. A missing document is a
  #   document that does not exist but has sub-documents. These documents will
  #   be returned with a key but will not have fields, {Google::Firestore::V1beta1::Document#create_time Document#create_time},
  #   or {Google::Firestore::V1beta1::Document#update_time Document#update_time} set.
  #
  #   Requests with +show_missing+ may not specify +where+ or
  #   +order_by+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Gax::PagedEnumerable<Google::Firestore::V1beta1::Document>]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Gax::PagedEnumerable<Google::Firestore::V1beta1::Document>]
  #   An enumerable of Google::Firestore::V1beta1::Document instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
  #
  #   # TODO: Initialize +collection_id+:
  #   collection_id = ''
  #
  #   # Iterate over all results.
  #   firestore_client.list_documents(formatted_parent, collection_id).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   firestore_client.list_documents(formatted_parent, collection_id).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_documents \
      parent,
      collection_id,
      page_size: nil,
      order_by: nil,
      mask: nil,
      transaction: nil,
      read_time: nil,
      show_missing: nil,
      options: nil,
      &block
    req = {
      parent: parent,
      collection_id: collection_id,
      page_size: page_size,
      order_by: order_by,
      mask: mask,
      transaction: transaction,
      read_time: read_time,
      show_missing: show_missing
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListDocumentsRequest)
    @list_documents.call(req, options, &block)
  end

  # Creates a new document.
  #
  # @param parent [String]
  #   The parent resource. For example:
  #   +projects/{project_id}/databases/{database_id}/documents+ or
  #   +projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}+
  # @param collection_id [String]
  #   The collection ID, relative to +parent+, to list. For example: +chatrooms+.
  # @param document_id [String]
  #   The client-assigned document ID to use for this document.
  #
  #   Optional. If not specified, an ID will be assigned by the service.
  # @param document [Google::Firestore::V1beta1::Document | Hash]
  #   The document to create. +name+ must not be set.
  #   A hash of the same form as `Google::Firestore::V1beta1::Document`
  #   can also be provided.
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
  #   The fields to return. If not set, returns all fields.
  #
  #   If the document has a field that is not present in this mask, that field
  #   will not be returned in the response.
  #   A hash of the same form as `Google::Firestore::V1beta1::DocumentMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Firestore::V1beta1::Document]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Firestore::V1beta1::Document]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
  #
  #   # TODO: Initialize +collection_id+:
  #   collection_id = ''
  #
  #   # TODO: Initialize +document_id+:
  #   document_id = ''
  #
  #   # TODO: Initialize +document+:
  #   document = {}
  #   response = firestore_client.create_document(formatted_parent, collection_id, document_id, document)

  def create_document \
      parent,
      collection_id,
      document_id,
      document,
      mask: nil,
      options: nil,
      &block
    req = {
      parent: parent,
      collection_id: collection_id,
      document_id: document_id,
      document: document,
      mask: mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CreateDocumentRequest)
    @create_document.call(req, options, &block)
  end

  # Updates or inserts a document.
  #
  # @param document [Google::Firestore::V1beta1::Document | Hash]
  #   The updated document.
  #   Creates the document if it does not already exist.
  #   A hash of the same form as `Google::Firestore::V1beta1::Document`
  #   can also be provided.
  # @param update_mask [Google::Firestore::V1beta1::DocumentMask | Hash]
  #   The fields to update.
  #   None of the field paths in the mask may contain a reserved name.
  #
  #   If the document exists on the server and has fields not referenced in the
  #   mask, they are left unchanged.
  #   Fields referenced in the mask, but not present in the input document, are
  #   deleted from the document on the server.
  #   A hash of the same form as `Google::Firestore::V1beta1::DocumentMask`
  #   can also be provided.
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
  #   The fields to return. If not set, returns all fields.
  #
  #   If the document has a field that is not present in this mask, that field
  #   will not be returned in the response.
  #   A hash of the same form as `Google::Firestore::V1beta1::DocumentMask`
  #   can also be provided.
  # @param current_document [Google::Firestore::V1beta1::Precondition | Hash]
  #   An optional precondition on the document.
  #   The request will fail if this is set and not met by the target document.
  #   A hash of the same form as `Google::Firestore::V1beta1::Precondition`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Firestore::V1beta1::Document]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Firestore::V1beta1::Document]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #
  #   # TODO: Initialize +document+:
  #   document = {}
  #
  #   # TODO: Initialize +update_mask+:
  #   update_mask = {}
  #   response = firestore_client.update_document(document, update_mask)

  def update_document \
      document,
      update_mask,
      mask: nil,
      current_document: nil,
      options: nil,
      &block
    req = {
      document: document,
      update_mask: update_mask,
      mask: mask,
      current_document: current_document
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::UpdateDocumentRequest)
    @update_document.call(req, options, &block)
  end

  # Deletes a document.
  #
  # @param name [String]
  #   The resource name of the Document to delete. In the format:
  #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
  # @param current_document [Google::Firestore::V1beta1::Precondition | Hash]
  #   An optional precondition on the document.
  #   The request will fail if this is set and not met by the target document.
  #   A hash of the same form as `Google::Firestore::V1beta1::Precondition`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result []
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_name = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
  #   firestore_client.delete_document(formatted_name)

  def delete_document \
      name,
      current_document: nil,
      options: nil,
      &block
    req = {
      name: name,
      current_document: current_document
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::DeleteDocumentRequest)
    @delete_document.call(req, options, &block)
    nil
  end

  # Gets multiple documents.
  #
  # Documents returned by this method are not guaranteed to be returned in the
  # same order that they were requested.
  #
  # @param database [String]
  #   The database name. In the format:
  #   +projects/{project_id}/databases/{database_id}+.
  # @param documents [Array<String>]
  #   The names of the documents to retrieve. In the format:
  #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
  #   The request will fail if any of the document is not a child resource of the
  #   given +database+. Duplicate names will be elided.
  # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
  #   The fields to return. If not set, returns all fields.
  #
  #   If a document has a field that is not present in this mask, that field will
  #   not be returned in the response.
  #   A hash of the same form as `Google::Firestore::V1beta1::DocumentMask`
  #   can also be provided.
  # @param transaction [String]
  #   Reads documents in a transaction.
  # @param new_transaction [Google::Firestore::V1beta1::TransactionOptions | Hash]
  #   Starts a new transaction and reads the documents.
  #   Defaults to a read-only transaction.
  #   The new transaction ID will be returned as the first response in the
  #   stream.
  #   A hash of the same form as `Google::Firestore::V1beta1::TransactionOptions`
  #   can also be provided.
  # @param read_time [Google::Protobuf::Timestamp | Hash]
  #   Reads documents as they were at the given time.
  #   This may not be older than 60 seconds.
  #   A hash of the same form as `Google::Protobuf::Timestamp`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Firestore::V1beta1::BatchGetDocumentsResponse>]
  #   An enumerable of Google::Firestore::V1beta1::BatchGetDocumentsResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
  #
  #   # TODO: Initialize +documents+:
  #   documents = []
  #   firestore_client.batch_get_documents(formatted_database, documents).each do |element|
  #     # Process element.
  #   end

  def batch_get_documents \
      database,
      documents,
      mask: nil,
      transaction: nil,
      new_transaction: nil,
      read_time: nil,
      options: nil
    req = {
      database: database,
      documents: documents,
      mask: mask,
      transaction: transaction,
      new_transaction: new_transaction,
      read_time: read_time
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::BatchGetDocumentsRequest)
    @batch_get_documents.call(req, options)
  end

  # Starts a new transaction.
  #
  # @param database [String]
  #   The database name. In the format:
  #   +projects/{project_id}/databases/{database_id}+.
  # @param options_ [Google::Firestore::V1beta1::TransactionOptions | Hash]
  #   The options for the transaction.
  #   Defaults to a read-write transaction.
  #   A hash of the same form as `Google::Firestore::V1beta1::TransactionOptions`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Firestore::V1beta1::BeginTransactionResponse]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Firestore::V1beta1::BeginTransactionResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
  #   response = firestore_client.begin_transaction(formatted_database)

  def begin_transaction \
      database,
      options_: nil,
      options: nil,
      &block
    req = {
      database: database,
      options: options_
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::BeginTransactionRequest)
    @begin_transaction.call(req, options, &block)
  end

  # Commits a transaction, while optionally updating documents.
  #
  # @param database [String]
  #   The database name. In the format:
  #   +projects/{project_id}/databases/{database_id}+.
  # @param writes [Array<Google::Firestore::V1beta1::Write | Hash>]
  #   The writes to apply.
  #
  #   Always executed atomically and in order.
  #   A hash of the same form as `Google::Firestore::V1beta1::Write`
  #   can also be provided.
  # @param transaction [String]
  #   If set, applies all writes in this transaction, and commits it.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Firestore::V1beta1::CommitResponse]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Firestore::V1beta1::CommitResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
  #
  #   # TODO: Initialize +writes+:
  #   writes = []
  #   response = firestore_client.commit(formatted_database, writes)

  def commit \
      database,
      writes,
      transaction: nil,
      options: nil,
      &block
    req = {
      database: database,
      writes: writes,
      transaction: transaction
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CommitRequest)
    @commit.call(req, options, &block)
  end

  # Rolls back a transaction.
  #
  # @param database [String]
  #   The database name. In the format:
  #   +projects/{project_id}/databases/{database_id}+.
  # @param transaction [String]
  #   The transaction to roll back.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result []
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
  #
  #   # TODO: Initialize +transaction+:
  #   transaction = ''
  #   firestore_client.rollback(formatted_database, transaction)

  def rollback \
      database,
      transaction,
      options: nil,
      &block
    req = {
      database: database,
      transaction: transaction
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::RollbackRequest)
    @rollback.call(req, options, &block)
    nil
  end

  # Runs a query.
  #
  # @param parent [String]
  #   The parent resource name. In the format:
  #   +projects/{project_id}/databases/{database_id}/documents+ or
  #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
  #   For example:
  #   +projects/my-project/databases/my-database/documents+ or
  #   +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
  # @param structured_query [Google::Firestore::V1beta1::StructuredQuery | Hash]
  #   A structured query.
  #   A hash of the same form as `Google::Firestore::V1beta1::StructuredQuery`
  #   can also be provided.
  # @param transaction [String]
  #   Reads documents in a transaction.
  # @param new_transaction [Google::Firestore::V1beta1::TransactionOptions | Hash]
  #   Starts a new transaction and reads the documents.
  #   Defaults to a read-only transaction.
  #   The new transaction ID will be returned as the first response in the
  #   stream.
  #   A hash of the same form as `Google::Firestore::V1beta1::TransactionOptions`
  #   can also be provided.
  # @param read_time [Google::Protobuf::Timestamp | Hash]
  #   Reads documents as they were at the given time.
  #   This may not be older than 60 seconds.
  #   A hash of the same form as `Google::Protobuf::Timestamp`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Firestore::V1beta1::RunQueryResponse>]
  #   An enumerable of Google::Firestore::V1beta1::RunQueryResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
  #   firestore_client.run_query(formatted_parent).each do |element|
  #     # Process element.
  #   end

  def run_query \
      parent,
      structured_query: nil,
      transaction: nil,
      new_transaction: nil,
      read_time: nil,
      options: nil
    req = {
      parent: parent,
      structured_query: structured_query,
      transaction: transaction,
      new_transaction: new_transaction,
      read_time: read_time
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::RunQueryRequest)
    @run_query.call(req, options)
  end

  # Streams batches of document updates and deletes, in order.
  #
  # @param reqs [Enumerable<Google::Firestore::V1beta1::WriteRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Firestore::V1beta1::WriteResponse>]
  #   An enumerable of Google::Firestore::V1beta1::WriteResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
  #   request = { database: formatted_database }
  #   requests = [request]
  #   firestore_client.write(requests).each do |element|
  #     # Process element.
  #   end

  def write reqs, options: nil
    request_protos = reqs.lazy.map do |req|
      Google::Gax::to_proto(req, Google::Firestore::V1beta1::WriteRequest)
    end
    @write.call(request_protos, options)
  end

  # Listens to changes.
  #
  # @param reqs [Enumerable<Google::Firestore::V1beta1::ListenRequest>]
  #   The input requests.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Firestore::V1beta1::ListenResponse>]
  #   An enumerable of Google::Firestore::V1beta1::ListenResponse instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  #
  # @note
  #   EXPERIMENTAL:
  #     Streaming requests are still undergoing review.
  #     This method interface might change in the future.
  #
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
  #   request = { database: formatted_database }
  #   requests = [request]
  #   firestore_client.listen(requests).each do |element|
  #     # Process element.
  #   end

  def listen reqs, options: nil
    request_protos = reqs.lazy.map do |req|
      Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListenRequest)
    end
    @listen.call(request_protos, options)
  end

  # Lists all the collection IDs underneath a document.
  #
  # @param parent [String]
  #   The parent document. In the format:
  #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
  #   For example:
  #   +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Gax::PagedEnumerable<String>]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Gax::PagedEnumerable<String>]
  #   An enumerable of String instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/firestore/v1beta1"
  #
  #   firestore_client = Google::Cloud::Firestore::V1beta1.new
  #   formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
  #
  #   # Iterate over all results.
  #   firestore_client.list_collection_ids(formatted_parent).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   firestore_client.list_collection_ids(formatted_parent).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_collection_ids \
      parent,
      page_size: nil,
      options: nil,
      &block
    req = {
      parent: parent,
      page_size: page_size
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListCollectionIdsRequest)
    @list_collection_ids.call(req, options, &block)
  end
end

Class Method Details

.any_path_path(project, database, document, any_path) ⇒ String

Returns a fully-qualified any_path resource name string.

Parameters:

  • project (String)
  • database (String)
  • document (String)
  • any_path (String)

Returns:

  • (String)


153
154
155
156
157
158
159
160
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 153

def self.any_path_path project, database, document, any_path
  ANY_PATH_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database,
    :"document" => document,
    :"any_path" => any_path
  )
end

.database_root_path(project, database) ⇒ String

Returns a fully-qualified database_root resource name string.

Parameters:

  • project (String)
  • database (String)

Returns:

  • (String)


116
117
118
119
120
121
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 116

def self.database_root_path project, database
  DATABASE_ROOT_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database
  )
end

.document_path_path(project, database, document_path) ⇒ String

Returns a fully-qualified document_path resource name string.

Parameters:

  • project (String)
  • database (String)
  • document_path (String)

Returns:

  • (String)


139
140
141
142
143
144
145
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 139

def self.document_path_path project, database, document_path
  DOCUMENT_PATH_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database,
    :"document_path" => document_path
  )
end

.document_root_path(project, database) ⇒ String

Returns a fully-qualified document_root resource name string.

Parameters:

  • project (String)
  • database (String)

Returns:

  • (String)


127
128
129
130
131
132
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 127

def self.document_root_path project, database
  DOCUMENT_ROOT_PATH_TEMPLATE.render(
    :"project" => project,
    :"database" => database
  )
end

Instance Method Details

#batch_get_documents(database, documents, mask: nil, transaction: nil, new_transaction: nil, read_time: nil, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::BatchGetDocumentsResponse>

Gets multiple documents.

Documents returned by this method are not guaranteed to be returned in the same order that they were requested.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")

# TODO: Initialize +documents+:
documents = []
firestore_client.batch_get_documents(formatted_database, documents).each do |element|
  # Process element.
end

Parameters:

  • database (String)

    The database name. In the format: +projects/project_id/databases/database_id+.

  • documents (Array<String>)

    The names of the documents to retrieve. In the format: +projects/project_id/databases/database_id/documents/document_path+. The request will fail if any of the document is not a child resource of the given +database+. Duplicate names will be elided.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash)

    The fields to return. If not set, returns all fields.

    If a document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • transaction (String)

    Reads documents in a transaction.

  • new_transaction (Google::Firestore::V1beta1::TransactionOptions | Hash)

    Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. A hash of the same form as Google::Firestore::V1beta1::TransactionOptions can also be provided.

  • read_time (Google::Protobuf::Timestamp | Hash)

    Reads documents as they were at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 709

def batch_get_documents \
    database,
    documents,
    mask: nil,
    transaction: nil,
    new_transaction: nil,
    read_time: nil,
    options: nil
  req = {
    database: database,
    documents: documents,
    mask: mask,
    transaction: transaction,
    new_transaction: new_transaction,
    read_time: read_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::BatchGetDocumentsRequest)
  @batch_get_documents.call(req, options)
end

#begin_transaction(database, options_: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::BeginTransactionResponse

Starts a new transaction.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
response = firestore_client.begin_transaction(formatted_database)

Parameters:

  • database (String)

    The database name. In the format: +projects/project_id/databases/database_id+.

  • options_ (Google::Firestore::V1beta1::TransactionOptions | Hash)

    The options for the transaction. Defaults to a read-write transaction. A hash of the same form as Google::Firestore::V1beta1::TransactionOptions can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



754
755
756
757
758
759
760
761
762
763
764
765
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 754

def begin_transaction \
    database,
    options_: nil,
    options: nil,
    &block
  req = {
    database: database,
    options: options_
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::BeginTransactionRequest)
  @begin_transaction.call(req, options, &block)
end

#commit(database, writes, transaction: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::CommitResponse

Commits a transaction, while optionally updating documents.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")

# TODO: Initialize +writes+:
writes = []
response = firestore_client.commit(formatted_database, writes)

Parameters:

  • database (String)

    The database name. In the format: +projects/project_id/databases/database_id+.

  • writes (Array<Google::Firestore::V1beta1::Write | Hash>)

    The writes to apply.

    Always executed atomically and in order. A hash of the same form as Google::Firestore::V1beta1::Write can also be provided.

  • transaction (String)

    If set, applies all writes in this transaction, and commits it.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



798
799
800
801
802
803
804
805
806
807
808
809
810
811
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 798

def commit \
    database,
    writes,
    transaction: nil,
    options: nil,
    &block
  req = {
    database: database,
    writes: writes,
    transaction: transaction
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CommitRequest)
  @commit.call(req, options, &block)
end

#create_document(parent, collection_id, document_id, document, mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::Document

Creates a new document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")

# TODO: Initialize +collection_id+:
collection_id = ''

# TODO: Initialize +document_id+:
document_id = ''

# TODO: Initialize +document+:
document = {}
response = firestore_client.create_document(formatted_parent, collection_id, document_id, document)

Parameters:

  • parent (String)

    The parent resource. For example: +projects/project_id/databases/database_id/documents+ or +projects/project_id/databases/database_id/documents/chatrooms/chatroom_id+

  • collection_id (String)

    The collection ID, relative to +parent+, to list. For example: +chatrooms+.

  • document_id (String)

    The client-assigned document ID to use for this document.

    Optional. If not specified, an ID will be assigned by the service.

  • document (Google::Firestore::V1beta1::Document | Hash)

    The document to create. +name+ must not be set. A hash of the same form as Google::Firestore::V1beta1::Document can also be provided.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash)

    The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 533

def create_document \
    parent,
    collection_id,
    document_id,
    document,
    mask: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    collection_id: collection_id,
    document_id: document_id,
    document: document,
    mask: mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CreateDocumentRequest)
  @create_document.call(req, options, &block)
end

#delete_document(name, current_document: nil, options: nil) {|result, operation| ... } ⇒ Object

Deletes a document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_name = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
firestore_client.delete_document(formatted_name)

Parameters:

  • name (String)

    The resource name of the Document to delete. In the format: +projects/project_id/databases/database_id/documents/document_path+.

  • current_document (Google::Firestore::V1beta1::Precondition | Hash)

    An optional precondition on the document. The request will fail if this is set and not met by the target document. A hash of the same form as Google::Firestore::V1beta1::Precondition can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



642
643
644
645
646
647
648
649
650
651
652
653
654
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 642

def delete_document \
    name,
    current_document: nil,
    options: nil,
    &block
  req = {
    name: name,
    current_document: current_document
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::DeleteDocumentRequest)
  @delete_document.call(req, options, &block)
  nil
end

#get_document(name, mask: nil, transaction: nil, read_time: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::Document

Gets a single document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_name = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
response = firestore_client.get_document(formatted_name)

Parameters:

  • name (String)

    The resource name of the Document to get. In the format: +projects/project_id/databases/database_id/documents/document_path+.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash)

    The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • transaction (String)

    Reads the document in a transaction.

  • read_time (Google::Protobuf::Timestamp | Hash)

    Reads the version of the document at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 368

def get_document \
    name,
    mask: nil,
    transaction: nil,
    read_time: nil,
    options: nil,
    &block
  req = {
    name: name,
    mask: mask,
    transaction: transaction,
    read_time: read_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::GetDocumentRequest)
  @get_document.call(req, options, &block)
end

#list_collection_ids(parent, page_size: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<String>

Lists all the collection IDs underneath a document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")

# Iterate over all results.
firestore_client.list_collection_ids(formatted_parent).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
firestore_client.list_collection_ids(formatted_parent).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String)

    The parent document. In the format: +projects/project_id/databases/database_id/documents/document_path+. For example: +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+

  • page_size (Integer)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result (Google::Gax::PagedEnumerable<String>)
  • operation (GRPC::ActiveCall::Operation)

Returns:

  • (Google::Gax::PagedEnumerable<String>)

    An enumerable of String instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 1026

def list_collection_ids \
    parent,
    page_size: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    page_size: page_size
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListCollectionIdsRequest)
  @list_collection_ids.call(req, options, &block)
end

#list_documents(parent, collection_id, page_size: nil, order_by: nil, mask: nil, transaction: nil, read_time: nil, show_missing: nil, options: nil) {|result, operation| ... } ⇒ Google::Gax::PagedEnumerable<Google::Firestore::V1beta1::Document>

Lists documents.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")

# TODO: Initialize +collection_id+:
collection_id = ''

# Iterate over all results.
firestore_client.list_documents(formatted_parent, collection_id).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
firestore_client.list_documents(formatted_parent, collection_id).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • parent (String)

    The parent resource name. In the format: +projects/project_id/databases/database_id/documents+ or +projects/project_id/databases/database_id/documents/document_path+. For example: +projects/my-project/databases/my-database/documents+ or +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+

  • collection_id (String)

    The collection ID, relative to +parent+, to list. For example: +chatrooms+ or +messages+.

  • page_size (Integer)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • order_by (String)

    The order to sort results by. For example: +priority desc, name+.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash)

    The fields to return. If not set, returns all fields.

    If a document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • transaction (String)

    Reads documents in a transaction.

  • read_time (Google::Protobuf::Timestamp | Hash)

    Reads documents as they were at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • show_missing (true, false)

    If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document#create_time, or Document#update_time set.

    Requests with +show_missing+ may not specify +where+ or +order_by+.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

  • (Google::Gax::PagedEnumerable<Google::Firestore::V1beta1::Document>)

    An enumerable of Google::Firestore::V1beta1::Document instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 461

def list_documents \
    parent,
    collection_id,
    page_size: nil,
    order_by: nil,
    mask: nil,
    transaction: nil,
    read_time: nil,
    show_missing: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    collection_id: collection_id,
    page_size: page_size,
    order_by: order_by,
    mask: mask,
    transaction: transaction,
    read_time: read_time,
    show_missing: show_missing
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListDocumentsRequest)
  @list_documents.call(req, options, &block)
end

#listen(reqs, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::ListenResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

Listens to changes.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
request = { database: formatted_database }
requests = [request]
firestore_client.listen(requests).each do |element|
  # Process element.
end

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



975
976
977
978
979
980
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 975

def listen reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListenRequest)
  end
  @listen.call(request_protos, options)
end

#rollback(database, transaction, options: nil) {|result, operation| ... } ⇒ Object

Rolls back a transaction.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")

# TODO: Initialize +transaction+:
transaction = ''
firestore_client.rollback(formatted_database, transaction)

Parameters:

  • database (String)

    The database name. In the format: +projects/project_id/databases/database_id+.

  • transaction (String)

    The transaction to roll back.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

  • result

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



837
838
839
840
841
842
843
844
845
846
847
848
849
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 837

def rollback \
    database,
    transaction,
    options: nil,
    &block
  req = {
    database: database,
    transaction: transaction
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::RollbackRequest)
  @rollback.call(req, options, &block)
  nil
end

#run_query(parent, structured_query: nil, transaction: nil, new_transaction: nil, read_time: nil, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::RunQueryResponse>

Runs a query.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_parent = Google::Cloud::Firestore::V1beta1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
firestore_client.run_query(formatted_parent).each do |element|
  # Process element.
end

Parameters:

  • parent (String)

    The parent resource name. In the format: +projects/project_id/databases/database_id/documents+ or +projects/project_id/databases/database_id/documents/document_path+. For example: +projects/my-project/databases/my-database/documents+ or +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+

  • structured_query (Google::Firestore::V1beta1::StructuredQuery | Hash)

    A structured query. A hash of the same form as Google::Firestore::V1beta1::StructuredQuery can also be provided.

  • transaction (String)

    Reads documents in a transaction.

  • new_transaction (Google::Firestore::V1beta1::TransactionOptions | Hash)

    Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream. A hash of the same form as Google::Firestore::V1beta1::TransactionOptions can also be provided.

  • read_time (Google::Protobuf::Timestamp | Hash)

    Reads documents as they were at the given time. This may not be older than 60 seconds. A hash of the same form as Google::Protobuf::Timestamp can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 894

def run_query \
    parent,
    structured_query: nil,
    transaction: nil,
    new_transaction: nil,
    read_time: nil,
    options: nil
  req = {
    parent: parent,
    structured_query: structured_query,
    transaction: transaction,
    new_transaction: new_transaction,
    read_time: read_time
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::RunQueryRequest)
  @run_query.call(req, options)
end

#update_document(document, update_mask, mask: nil, current_document: nil, options: nil) {|result, operation| ... } ⇒ Google::Firestore::V1beta1::Document

Updates or inserts a document.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new

# TODO: Initialize +document+:
document = {}

# TODO: Initialize +update_mask+:
update_mask = {}
response = firestore_client.update_document(document, update_mask)

Parameters:

  • document (Google::Firestore::V1beta1::Document | Hash)

    The updated document. Creates the document if it does not already exist. A hash of the same form as Google::Firestore::V1beta1::Document can also be provided.

  • update_mask (Google::Firestore::V1beta1::DocumentMask | Hash)

    The fields to update. None of the field paths in the mask may contain a reserved name.

    If the document exists on the server and has fields not referenced in the mask, they are left unchanged. Fields referenced in the mask, but not present in the input document, are deleted from the document on the server. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • mask (Google::Firestore::V1beta1::DocumentMask | Hash)

    The fields to return. If not set, returns all fields.

    If the document has a field that is not present in this mask, that field will not be returned in the response. A hash of the same form as Google::Firestore::V1beta1::DocumentMask can also be provided.

  • current_document (Google::Firestore::V1beta1::Precondition | Hash)

    An optional precondition on the document. The request will fail if this is set and not met by the target document. A hash of the same form as Google::Firestore::V1beta1::Precondition can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Yields:

  • (result, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 601

def update_document \
    document,
    update_mask,
    mask: nil,
    current_document: nil,
    options: nil,
    &block
  req = {
    document: document,
    update_mask: update_mask,
    mask: mask,
    current_document: current_document
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::UpdateDocumentRequest)
  @update_document.call(req, options, &block)
end

#write(reqs, options: nil) ⇒ Enumerable<Google::Firestore::V1beta1::WriteResponse>

Note:

EXPERIMENTAL: Streaming requests are still undergoing review. This method interface might change in the future.

Streams batches of document updates and deletes, in order.

Examples:

require "google/cloud/firestore/v1beta1"

firestore_client = Google::Cloud::Firestore::V1beta1.new
formatted_database = Google::Cloud::Firestore::V1beta1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
request = { database: formatted_database }
requests = [request]
firestore_client.write(requests).each do |element|
  # Process element.
end

Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



940
941
942
943
944
945
# File 'lib/google/cloud/firestore/v1beta1/firestore_client.rb', line 940

def write reqs, options: nil
  request_protos = reqs.lazy.map do |req|
    Google::Gax::to_proto(req, Google::Firestore::V1beta1::WriteRequest)
  end
  @write.call(request_protos, options)
end