google-cloud-firestore 0.22.0 → 0.23.0

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/firestore.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -14,17 +14,6 @@
 
 module Google
   module Firestore
-    ##
-    # # Google Cloud Firestore API Contents
-    #
-    # | Class | Description |
-    # | ----- | ----------- |
-    # | [FirestoreClient][] |  |
-    # | [Data Types][] | Data types for Google::Cloud::Firestore::V1beta1 |
-    #
-    # [FirestoreClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-firestore/latest/google/firestore/v1beta1/v1beta1/firestoreclient
-    # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-firestore/latest/google/firestore/v1beta1/v1beta1/datatypes
-    #
     module V1beta1
       # The request for {Google::Firestore::V1beta1::Firestore::GetDocument Firestore::GetDocument}.
       # @!attribute [rw] name

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -138,6 +138,9 @@ module Google
 
             # Equal.
             EQUAL = 5
+
+            # Contains. Requires that the field is an array.
+            ARRAY_CONTAINS = 7
           end
         end
 

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -34,9 +34,10 @@ module Google
       #     The fields to update in this write.
       #
       #     This field can be set only when the operation is +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.
+      #     If the mask is not set for an +update+ and the document exists, any
+      #     existing data will be overwritten.
+      #     If the mask is set and the document on the server has fields not covered by
+      #     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.
       #     The field paths in this mask must not contain a reserved field name.
@@ -55,6 +56,7 @@ module Google
       #   @return [Array<Google::Firestore::V1beta1::DocumentTransform::FieldTransform>]
       #     The list of transformations to apply to the fields of the document, in
       #     order.
+      #     This must not be empty.
       class DocumentTransform
         # A transformation of a field of the document.
         # @!attribute [rw] field_path
@@ -64,13 +66,40 @@ module Google
         # @!attribute [rw] set_to_server_value
         #   @return [Google::Firestore::V1beta1::DocumentTransform::FieldTransform::ServerValue]
         #     Sets the field to the given server value.
+        # @!attribute [rw] append_missing_elements
+        #   @return [Google::Firestore::V1beta1::ArrayValue]
+        #     Append the given elements in order if they are not already present in
+        #     the current field value.
+        #     If the field is not an array, or if the field does not yet exist, it is
+        #     first set to the empty array.
+        #
+        #     Equivalent numbers of different types (e.g. 3L and 3.0) are
+        #     considered equal when checking if a value is missing.
+        #     NaN is equal to NaN, and Null is equal to Null.
+        #     If the input contains multiple equivalent values, only the first will
+        #     be considered.
+        #
+        #     The corresponding transform_result will be the null value.
+        # @!attribute [rw] remove_all_from_array
+        #   @return [Google::Firestore::V1beta1::ArrayValue]
+        #     Remove all of the given elements from the array in the field.
+        #     If the field is not an array, or if the field does not yet exist, it is
+        #     set to the empty array.
+        #
+        #     Equivalent numbers of the different types (e.g. 3L and 3.0) are
+        #     considered equal when deciding whether an element should be removed.
+        #     NaN is equal to NaN, and Null is equal to Null.
+        #     This will remove all equivalent values if there are duplicates.
+        #
+        #     The corresponding transform_result will be the null value.
         class FieldTransform
           # A value that is calculated by the server.
           module ServerValue
             # Unspecified. This value must not be used.
             SERVER_VALUE_UNSPECIFIED = 0
 
-            # The time at which the server processed the request.
+            # The time at which the server processed the request, with millisecond
+            # precision.
             REQUEST_TIME = 1
           end
         end
@@ -92,7 +121,7 @@ module Google
 
       # A {Google::Firestore::V1beta1::Document Document} has changed.
       #
-      # May be the result of multiple {Google::Firestore::V1beta1::Write Writes}, including deletes, that
+      # May be the result of multiple {Google::Firestore::V1beta1::Write writes}, including deletes, that
       # ultimately resulted in a new value for the {Google::Firestore::V1beta1::Document Document}.
       #
       # Multiple {Google::Firestore::V1beta1::DocumentChange DocumentChange} messages may be returned for the same logical
@@ -112,7 +141,7 @@ module Google
 
       # A {Google::Firestore::V1beta1::Document Document} has been deleted.
       #
-      # May be the result of multiple {Google::Firestore::V1beta1::Write Writes}, including updates, the
+      # May be the result of multiple {Google::Firestore::V1beta1::Write writes}, including updates, the
       # last of which deleted the {Google::Firestore::V1beta1::Document Document}.
       #
       # Multiple {Google::Firestore::V1beta1::DocumentDelete DocumentDelete} messages may be returned for the same logical
@@ -157,7 +186,7 @@ module Google
       #     The target ID to which this filter applies.
       # @!attribute [rw] count
       #   @return [Integer]
-      #     The total count of documents that match {Google::Firestore::V1beta1::ExistenceFilter#target_id Target_id}.
+      #     The total count of documents that match {Google::Firestore::V1beta1::ExistenceFilter#target_id target_id}.
       #
       #     If different from the count of documents in the client that match, the
       #     client must manually determine which documents no longer match the target.

data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/any.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/empty.rb

@@ -0,0 +1,28 @@
+# Copyright 2018 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for +Empty+ is empty JSON object +{}+.
+    class Empty; end
+  end
+end

data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/timestamp.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/wrappers.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/firestore/v1beta1/doc/google/rpc/status.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/google/cloud/firestore/v1beta1/firestore_client.rb

@@ -1,4 +1,4 @@
-# Copyright 2017 Google LLC
+# Copyright 2018 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -18,9 +18,6 @@
 # and updates to that file get reflected here through a refresh process.
 # For the short term, the refresh process will only be runnable by Google
 # engineers.
-#
-# The only allowed edits are to method and file documentation. A 3-way
-# merge preserves those additions if the generated source changes.
 
 require "json"
 require "pathname"
@@ -28,7 +25,7 @@ require "pathname"
 require "google/gax"
 
 require "google/firestore/v1beta1/firestore_pb"
-require "google/cloud/firestore/credentials"
+require "google/cloud/firestore/v1beta1/credentials"
 
 module Google
   module Cloud
@@ -62,6 +59,9 @@ module Google
           # The default port of the service.
           DEFAULT_SERVICE_PORT = 443
 
+          # The default set of gRPC interceptors.
+          GRPC_INTERCEPTORS = []
+
           DEFAULT_TIMEOUT = 30
 
           PAGE_DESCRIPTORS = {
@@ -84,6 +84,7 @@ module Google
             "https://www.googleapis.com/auth/datastore"
           ].freeze
 
+
           DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/databases/{database}"
           )
@@ -182,16 +183,18 @@ module Google
           #   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 \
-              service_path: SERVICE_ADDRESS,
-              port: DEFAULT_SERVICE_PORT,
-              channel: nil,
-              chan_creds: nil,
-              updater_proc: nil,
               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
@@ -200,21 +203,10 @@ module Google
             require "google/gax/grpc"
             require "google/firestore/v1beta1/firestore_services_pb"
 
-            if channel || chan_creds || updater_proc
-              warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
-                "on 2017/09/08"
-              credentials ||= channel
-              credentials ||= chan_creds
-              credentials ||= updater_proc
-            end
-            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
-              warn "`service_path` and `port` parameters are deprecated and will be removed"
-            end
-
-            credentials ||= Google::Cloud::Firestore::Credentials.default
+            credentials ||= Google::Cloud::Firestore::V1beta1::Credentials.default
 
             if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::Firestore::Credentials.new(credentials).updater_proc
+              updater_proc = Google::Cloud::Firestore::V1beta1::Credentials.new(credentials).updater_proc
             end
             if credentials.is_a?(GRPC::Core::Channel)
               channel = credentials
@@ -229,13 +221,16 @@ module Google
               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/0.6.8 gax/#{Google::Gax::VERSION}"
+            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!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "firestore_client_config.json"
             )
@@ -248,9 +243,14 @@ module Google
                 timeout,
                 page_descriptors: PAGE_DESCRIPTORS,
                 errors: Google::Gax::Grpc::API_ERRORS,
-                kwargs: headers
+                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,
@@ -258,60 +258,74 @@ module Google
               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"]
+              defaults["get_document"],
+              exception_transformer: exception_transformer
             )
             @list_documents = Google::Gax.create_api_call(
               @firestore_stub.method(:list_documents),
-              defaults["list_documents"]
+              defaults["list_documents"],
+              exception_transformer: exception_transformer
             )
             @create_document = Google::Gax.create_api_call(
               @firestore_stub.method(:create_document),
-              defaults["create_document"]
+              defaults["create_document"],
+              exception_transformer: exception_transformer
             )
             @update_document = Google::Gax.create_api_call(
               @firestore_stub.method(:update_document),
-              defaults["update_document"]
+              defaults["update_document"],
+              exception_transformer: exception_transformer
             )
             @delete_document = Google::Gax.create_api_call(
               @firestore_stub.method(:delete_document),
-              defaults["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"]
+              defaults["batch_get_documents"],
+              exception_transformer: exception_transformer
             )
             @begin_transaction = Google::Gax.create_api_call(
               @firestore_stub.method(:begin_transaction),
-              defaults["begin_transaction"]
+              defaults["begin_transaction"],
+              exception_transformer: exception_transformer
             )
             @commit = Google::Gax.create_api_call(
               @firestore_stub.method(:commit),
-              defaults["commit"]
+              defaults["commit"],
+              exception_transformer: exception_transformer
             )
             @rollback = Google::Gax.create_api_call(
               @firestore_stub.method(:rollback),
-              defaults["rollback"]
+              defaults["rollback"],
+              exception_transformer: exception_transformer
             )
             @run_query = Google::Gax.create_api_call(
               @firestore_stub.method(:run_query),
-              defaults["run_query"]
+              defaults["run_query"],
+              exception_transformer: exception_transformer
             )
             @write = Google::Gax.create_api_call(
               @firestore_stub.method(:write),
-              defaults["write"]
+              defaults["write"],
+              exception_transformer: exception_transformer
             )
             @listen = Google::Gax.create_api_call(
               @firestore_stub.method(:listen),
-              defaults["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"]
+              defaults["list_collection_ids"],
+              exception_transformer: exception_transformer
             )
           end
 
@@ -339,6 +353,9 @@ module Google
           # @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
@@ -353,7 +370,8 @@ module Google
               mask: nil,
               transaction: nil,
               read_time: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               name: name,
               mask: mask,
@@ -361,7 +379,7 @@ module Google
               read_time: read_time
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::GetDocumentRequest)
-            @get_document.call(req, options)
+            @get_document.call(req, options, &block)
           end
 
           # Lists documents.
@@ -409,6 +427,9 @@ module Google
           # @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
@@ -420,6 +441,8 @@ module Google
           #
           #   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.
@@ -444,7 +467,8 @@ module Google
               transaction: nil,
               read_time: nil,
               show_missing: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               parent: parent,
               collection_id: collection_id,
@@ -456,7 +480,7 @@ module Google
               show_missing: show_missing
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::ListDocumentsRequest)
-            @list_documents.call(req, options)
+            @list_documents.call(req, options, &block)
           end
 
           # Creates a new document.
@@ -485,6 +509,9 @@ module Google
           # @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
@@ -492,8 +519,14 @@ module Google
           #
           #   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)
 
@@ -503,7 +536,8 @@ module Google
               document_id,
               document,
               mask: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               parent: parent,
               collection_id: collection_id,
@@ -512,7 +546,7 @@ module Google
               mask: mask
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::CreateDocumentRequest)
-            @create_document.call(req, options)
+            @create_document.call(req, options, &block)
           end
 
           # Updates or inserts a document.
@@ -547,13 +581,20 @@ module Google
           # @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)
 
@@ -562,7 +603,8 @@ module Google
               update_mask,
               mask: nil,
               current_document: nil,
-              options: nil
+              options: nil,
+              &block
             req = {
               document: document,
               update_mask: update_mask,
@@ -570,7 +612,7 @@ module Google
               current_document: current_document
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Firestore::V1beta1::UpdateDocumentRequest)
-            @update_document.call(req, options)
+            @update_document.call(req, options, &block)
           end
 
           # Deletes a document.
@@ -586,6 +628,9 @@ module Google
           # @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"
@@ -597,13 +642,14 @@ module Google
           def delete_document \
               name,
               current_document: nil,
-              options: 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)
+            @delete_document.call(req, options, &block)
             nil
           end
 
@@ -653,6 +699,8 @@ module Google
           #
           #   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.
@@ -691,6 +739,9 @@ module Google
           # @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
@@ -703,13 +754,14 @@ module Google
           def begin_transaction \
               database,
               options_: nil,
-              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)
+            @begin_transaction.call(req, options, &block)
           end
 
           # Commits a transaction, while optionally updating documents.
@@ -728,6 +780,9 @@ module Google
           # @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
@@ -735,6 +790,8 @@ module Google
           #
           #   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)
 
@@ -742,14 +799,15 @@ module Google
               database,
               writes,
               transaction: nil,
-              options: 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)
+            @commit.call(req, options, &block)
           end
 
           # Rolls back a transaction.
@@ -762,25 +820,31 @@ module Google
           # @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
+              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)
+            @rollback.call(req, options, &block)
             nil
           end
 
@@ -931,6 +995,9 @@ module Google
           # @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
@@ -959,13 +1026,14 @@ module Google
           def list_collection_ids \
               parent,
               page_size: nil,
-              options: 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)
+            @list_collection_ids.call(req, options, &block)
           end
         end
       end