google-cloud-firestore-v1 2.2.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26ca9602d2def8cbdd712ea2cdf7d5c0103f89b267b03a29c0a75f7007d99fb6
-  data.tar.gz: 858b86cc1b8c9923b126e583850cbb9e8fa2420131f26099a2e6482534005fea
+  metadata.gz: e093e52014138cbe0d41965e8b447c1550db10456bcb90bf2b20b810f9ac9a3c
+  data.tar.gz: 2d9f6cabce314792281aa78db89d7d11d9c2d2043245911f64e405711c9d39ae
 SHA512:
-  metadata.gz: 875ca082842a144e401a6c8fe5d2b079db18d9281b94e0c5042e80f2d8baf8ae443a8dec04c80fa385783edc6d3b4ce0f48e2953a1e76783d4c1e24ef21b7fbb
-  data.tar.gz: cd31e0e49b065f033bf707b4db837d788e3be42a604212b0c92eb84f0aac6fc649554409a12f81f069de8a5f11e686edacaf0defe48883fad1bc2dcea6d50027
+  metadata.gz: aa89d63bbae003c47dc13750ad1b449f597c6694dd90795226194563d33103ecafe9d695667de371878617d9d1b263aeea513e2e256f3f2aaa6fa3c7717c966c
+  data.tar.gz: 7388a57edc18cdab5ded1b84c85fa1a3e009bb6586ee0d8980d12d755763dd1aba36da0b89858148cf890059f9c734b0378ce799c0d0114bd5caa53216f6f1b3

data/README.md

@@ -86,7 +86,7 @@ To browse ready to use code samples check [Google Cloud Samples](https://cloud.g
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 3.0+.
+This library is supported on Ruby 3.2+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or

data/lib/google/cloud/firestore/v1/firestore/client.rb

@@ -98,7 +98,7 @@ module Google
 
                 default_config.rpcs.batch_get_documents.timeout = 300.0
                 default_config.rpcs.batch_get_documents.retry_policy = {
-                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
                 }
 
                 default_config.rpcs.begin_transaction.timeout = 60.0
@@ -118,17 +118,22 @@ module Google
 
                 default_config.rpcs.run_query.timeout = 300.0
                 default_config.rpcs.run_query.retry_policy = {
-                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
+                }
+
+                default_config.rpcs.execute_pipeline.timeout = 300.0
+                default_config.rpcs.execute_pipeline.retry_policy = {
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13]
                 }
 
                 default_config.rpcs.run_aggregation_query.timeout = 300.0
                 default_config.rpcs.run_aggregation_query.retry_policy = {
-                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
                 }
 
                 default_config.rpcs.partition_query.timeout = 300.0
                 default_config.rpcs.partition_query.retry_policy = {
-                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
                 }
 
                 default_config.rpcs.write.timeout = 86_400.0
@@ -1236,6 +1241,131 @@ module Google
               raise ::Google::Cloud::Error.from_error(e)
             end
 
+            ##
+            # Executes a pipeline query.
+            #
+            # @overload execute_pipeline(request, options = nil)
+            #   Pass arguments to `execute_pipeline` via a request object, either of type
+            #   {::Google::Cloud::Firestore::V1::ExecutePipelineRequest} or an equivalent Hash.
+            #
+            #   @param request [::Google::Cloud::Firestore::V1::ExecutePipelineRequest, ::Hash]
+            #     A request object representing the call parameters. Required. To specify no
+            #     parameters, or to keep all the default parameter values, pass an empty Hash.
+            #   @param options [::Gapic::CallOptions, ::Hash]
+            #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+            #
+            # @overload execute_pipeline(database: nil, structured_pipeline: nil, transaction: nil, new_transaction: nil, read_time: nil, auto_commit_transaction: nil)
+            #   Pass arguments to `execute_pipeline` via keyword arguments. Note that at
+            #   least one keyword argument is required. To specify no parameters, or to keep all
+            #   the default parameter values, pass an empty Hash as a request object (see above).
+            #
+            #   @param database [::String]
+            #     Required. Database identifier, in the form
+            #     `projects/{project}/databases/{database}`.
+            #   @param structured_pipeline [::Google::Cloud::Firestore::V1::StructuredPipeline, ::Hash]
+            #     A pipelined operation.
+            #   @param transaction [::String]
+            #     Run the query within an already active transaction.
+            #
+            #     The value here is the opaque transaction ID to execute the query in.
+            #
+            #     Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+            #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
+            #     Execute the pipeline in a new transaction.
+            #
+            #     The identifier of the newly created transaction will be returned in the
+            #     first response on the stream. This defaults to a read-only transaction.
+            #
+            #     Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+            #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
+            #     Execute the pipeline in a snapshot transaction at the given time.
+            #
+            #     This must be a microsecond precision timestamp within the past one hour,
+            #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+            #     minute timestamp within the past 7 days.
+            #
+            #     Note: The following parameters are mutually exclusive: `read_time`, `transaction`, `new_transaction`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+            #   @param auto_commit_transaction [::Boolean]
+            #     Optional. Automatically commits the transaction after the pipeline has been
+            #     executed. Only permitted in combination with `transaction` or
+            #     `new_transaction`.
+            #
+            # @yield [response, operation] Access the result along with the RPC operation
+            # @yieldparam response [::Enumerable<::Google::Cloud::Firestore::V1::ExecutePipelineResponse>]
+            # @yieldparam operation [::GRPC::ActiveCall::Operation]
+            #
+            # @return [::Enumerable<::Google::Cloud::Firestore::V1::ExecutePipelineResponse>]
+            #
+            # @raise [::Google::Cloud::Error] if the RPC is aborted.
+            #
+            # @example Basic example
+            #   require "google/cloud/firestore/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Firestore::V1::Firestore::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Firestore::V1::ExecutePipelineRequest.new
+            #
+            #   # Call the execute_pipeline method to start streaming.
+            #   output = client.execute_pipeline request
+            #
+            #   # The returned object is a streamed enumerable yielding elements of type
+            #   # ::Google::Cloud::Firestore::V1::ExecutePipelineResponse
+            #   output.each do |current_response|
+            #     p current_response
+            #   end
+            #
+            def execute_pipeline request, options = nil
+              raise ::ArgumentError, "request must be provided" if request.nil?
+
+              request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::V1::ExecutePipelineRequest
+
+              # Converts hash and nil to an options object
+              options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+              # Customize the options with defaults
+              metadata = @config.rpcs.execute_pipeline.metadata.to_h
+
+              # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+              metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                lib_name: @config.lib_name, lib_version: @config.lib_version,
+                gapic_version: ::Google::Cloud::Firestore::V1::VERSION
+              metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+              metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+              header_params = {}
+              if request.database
+                regex_match = %r{^projects/(?<project_id>[^/]+)(?:/.*)?$}.match request.database
+                if regex_match
+                  header_params["project_id"] = regex_match["project_id".to_s]
+                end
+              end
+              if request.database
+                regex_match = %r{^projects/[^/]+/databases/(?<database_id>[^/]+)(?:/.*)?$}.match request.database
+                if regex_match
+                  header_params["database_id"] = regex_match["database_id".to_s]
+                end
+              end
+
+              request_params_header = URI.encode_www_form header_params
+              metadata[:"x-goog-request-params"] ||= request_params_header
+
+              options.apply_defaults timeout:      @config.rpcs.execute_pipeline.timeout,
+                                     metadata:     metadata,
+                                     retry_policy: @config.rpcs.execute_pipeline.retry_policy
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
+                                     retry_policy: @config.retry_policy
+
+              @firestore_stub.call_rpc :execute_pipeline, request, options: options do |response, operation|
+                yield response, operation if block_given?
+              end
+            rescue ::GRPC::BadStatus => e
+              raise ::Google::Cloud::Error.from_error(e)
+            end
+
             ##
             # Runs an aggregation query.
             #
@@ -1686,6 +1816,9 @@ module Google
             #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
             #     For example:
             #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
+            #
+            #     Use `projects/{project_id}/databases/{database_id}/documents` to list
+            #     top-level collections.
             #   @param page_size [::Integer]
             #     The maximum number of results to return.
             #   @param page_token [::String]
@@ -2065,6 +2198,7 @@ module Google
             #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
             #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
             #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+            #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
             #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
             #       trigger a retry.
             #   @return [::Hash]
@@ -2148,6 +2282,7 @@ module Google
               #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #         trigger a retry.
               #
@@ -2198,6 +2333,11 @@ module Google
                 #
                 attr_reader :run_query
                 ##
+                # RPC-specific configuration for `execute_pipeline`
+                # @return [::Gapic::Config::Method]
+                #
+                attr_reader :execute_pipeline
+                ##
                 # RPC-specific configuration for `run_aggregation_query`
                 # @return [::Gapic::Config::Method]
                 #
@@ -2253,6 +2393,8 @@ module Google
                   @rollback = ::Gapic::Config::Method.new rollback_config
                   run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
                   @run_query = ::Gapic::Config::Method.new run_query_config
+                  execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
+                  @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
                   run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
                   @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
                   partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query

data/lib/google/cloud/firestore/v1/firestore/rest/client.rb

@@ -100,7 +100,7 @@ module Google
 
                   default_config.rpcs.batch_get_documents.timeout = 300.0
                   default_config.rpcs.batch_get_documents.retry_policy = {
-                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
                   }
 
                   default_config.rpcs.begin_transaction.timeout = 60.0
@@ -120,17 +120,22 @@ module Google
 
                   default_config.rpcs.run_query.timeout = 300.0
                   default_config.rpcs.run_query.retry_policy = {
-                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
+                  }
+
+                  default_config.rpcs.execute_pipeline.timeout = 300.0
+                  default_config.rpcs.execute_pipeline.retry_policy = {
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13]
                   }
 
                   default_config.rpcs.run_aggregation_query.timeout = 300.0
                   default_config.rpcs.run_aggregation_query.retry_policy = {
-                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
                   }
 
                   default_config.rpcs.partition_query.timeout = 300.0
                   default_config.rpcs.partition_query.retry_policy = {
-                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [8, 14, 13, 4]
+                    initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 13, 4]
                   }
 
                   default_config.rpcs.list_collection_ids.timeout = 60.0
@@ -1160,6 +1165,117 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Executes a pipeline query.
+              #
+              # @overload execute_pipeline(request, options = nil)
+              #   Pass arguments to `execute_pipeline` via a request object, either of type
+              #   {::Google::Cloud::Firestore::V1::ExecutePipelineRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Firestore::V1::ExecutePipelineRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @overload execute_pipeline(database: nil, structured_pipeline: nil, transaction: nil, new_transaction: nil, read_time: nil, auto_commit_transaction: nil)
+              #   Pass arguments to `execute_pipeline` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param database [::String]
+              #     Required. Database identifier, in the form
+              #     `projects/{project}/databases/{database}`.
+              #   @param structured_pipeline [::Google::Cloud::Firestore::V1::StructuredPipeline, ::Hash]
+              #     A pipelined operation.
+              #   @param transaction [::String]
+              #     Run the query within an already active transaction.
+              #
+              #     The value here is the opaque transaction ID to execute the query in.
+              #
+              #     Note: The following parameters are mutually exclusive: `transaction`, `new_transaction`, `read_time`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              #   @param new_transaction [::Google::Cloud::Firestore::V1::TransactionOptions, ::Hash]
+              #     Execute the pipeline in a new transaction.
+              #
+              #     The identifier of the newly created transaction will be returned in the
+              #     first response on the stream. This defaults to a read-only transaction.
+              #
+              #     Note: The following parameters are mutually exclusive: `new_transaction`, `transaction`, `read_time`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              #   @param read_time [::Google::Protobuf::Timestamp, ::Hash]
+              #     Execute the pipeline in a snapshot transaction at the given time.
+              #
+              #     This must be a microsecond precision timestamp within the past one hour,
+              #     or if Point-in-Time Recovery is enabled, can additionally be a whole
+              #     minute timestamp within the past 7 days.
+              #
+              #     Note: The following parameters are mutually exclusive: `read_time`, `transaction`, `new_transaction`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
+              #   @param auto_commit_transaction [::Boolean]
+              #     Optional. Automatically commits the transaction after the pipeline has been
+              #     executed. Only permitted in combination with `transaction` or
+              #     `new_transaction`.
+              # @return [::Enumerable<::Google::Cloud::Firestore::V1::ExecutePipelineResponse>]
+              #
+              # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::V1::Firestore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::V1::ExecutePipelineRequest.new
+              #
+              #   # Call the execute_pipeline method to start streaming.
+              #   output = client.execute_pipeline request
+              #
+              #   # The returned object is a streamed enumerable yielding elements of type
+              #   # ::Google::Cloud::Firestore::V1::ExecutePipelineResponse
+              #   output.each do |current_response|
+              #     p current_response
+              #   end
+              #
+              def execute_pipeline request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::V1::ExecutePipelineRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                call_metadata = @config.rpcs.execute_pipeline.metadata.to_h
+
+                # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
+                call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Firestore::V1::VERSION,
+                  transports_version_send: [:rest]
+
+                call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
+                call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                options.apply_defaults timeout:      @config.rpcs.execute_pipeline.timeout,
+                                       metadata:     call_metadata,
+                                       retry_policy: @config.rpcs.execute_pipeline.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                ::Gapic::Rest::ServerStream.new(
+                  ::Google::Cloud::Firestore::V1::ExecutePipelineResponse,
+                  ::Gapic::Rest::ThreadedEnumerator.new do |in_q, out_q|
+                    @firestore_stub.execute_pipeline request, options do |chunk|
+                      in_q.deq
+                      out_q.enq chunk
+                    end
+                  end
+                )
+              rescue ::Gapic::Rest::Error => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Runs an aggregation query.
               #
@@ -1440,6 +1556,9 @@ module Google
               #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
               #     For example:
               #     `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
+              #
+              #     Use `projects/{project_id}/databases/{database_id}/documents` to list
+              #     top-level collections.
               #   @param page_size [::Integer]
               #     The maximum number of results to return.
               #   @param page_token [::String]
@@ -1769,6 +1888,7 @@ module Google
               #    *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
               #    *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
               #    *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+              #    *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
               #    *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
               #       trigger a retry.
               #   @return [::Hash]
@@ -1841,6 +1961,7 @@ module Google
                 #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
                 #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
                 #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
+                #      *  `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
                 #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
                 #         trigger a retry.
                 #
@@ -1891,6 +2012,11 @@ module Google
                   #
                   attr_reader :run_query
                   ##
+                  # RPC-specific configuration for `execute_pipeline`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :execute_pipeline
+                  ##
                   # RPC-specific configuration for `run_aggregation_query`
                   # @return [::Gapic::Config::Method]
                   #
@@ -1936,6 +2062,8 @@ module Google
                     @rollback = ::Gapic::Config::Method.new rollback_config
                     run_query_config = parent_rpcs.run_query if parent_rpcs.respond_to? :run_query
                     @run_query = ::Gapic::Config::Method.new run_query_config
+                    execute_pipeline_config = parent_rpcs.execute_pipeline if parent_rpcs.respond_to? :execute_pipeline
+                    @execute_pipeline = ::Gapic::Config::Method.new execute_pipeline_config
                     run_aggregation_query_config = parent_rpcs.run_aggregation_query if parent_rpcs.respond_to? :run_aggregation_query
                     @run_aggregation_query = ::Gapic::Config::Method.new run_aggregation_query_config
                     partition_query_config = parent_rpcs.partition_query if parent_rpcs.respond_to? :partition_query

data/lib/google/cloud/firestore/v1/firestore/rest/service_stub.rb

@@ -421,6 +421,40 @@ module Google
                 ::Gapic::Rest::TransportOperation.new response
               end
 
+              ##
+              # Baseline implementation for the execute_pipeline REST call
+              #
+              # @param request_pb [::Google::Cloud::Firestore::V1::ExecutePipelineRequest]
+              #   A request object representing the call parameters. Required.
+              # @param options [::Gapic::CallOptions]
+              #   Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
+              #
+              # @yieldparam chunk [::String] The chunk of data received during server streaming.
+              #
+              # @return [::Gapic::Rest::TransportOperation]
+              def execute_pipeline(request_pb, options = nil, &)
+                raise ::ArgumentError, "request must be provided" if request_pb.nil?
+
+                verb, uri, query_string_params, body = ServiceStub.transcode_execute_pipeline_request request_pb
+                query_string_params = if query_string_params.any?
+                                        query_string_params.to_h { |p| p.split "=", 2 }
+                                      else
+                                        {}
+                                      end
+
+                response = @client_stub.make_http_request(
+                  verb,
+                  uri: uri,
+                  body: body || "",
+                  params: query_string_params,
+                  method_name: "execute_pipeline",
+                  options: options,
+                  is_server_streaming: true,
+                  &
+                )
+                ::Gapic::Rest::TransportOperation.new response
+              end
+
               ##
               # Baseline implementation for the run_aggregation_query REST call
               #
@@ -827,6 +861,28 @@ module Google
                 transcoder.transcode request_pb
               end
 
+              ##
+              # @private
+              #
+              # GRPC transcoding helper method for the execute_pipeline REST call
+              #
+              # @param request_pb [::Google::Cloud::Firestore::V1::ExecutePipelineRequest]
+              #   A request object representing the call parameters. Required.
+              # @return [Array(String, [String, nil], Hash{String => String})]
+              #   Uri, Body, Query string parameters
+              def self.transcode_execute_pipeline_request request_pb
+                transcoder = Gapic::Rest::GrpcTranscoder.new
+                                                        .with_bindings(
+                                                          uri_method: :post,
+                                                          uri_template: "/v1/{database}/documents:executePipeline",
+                                                          body: "*",
+                                                          matches: [
+                                                            ["database", %r{^projects/[^/]+/databases/[^/]+/?$}, false]
+                                                          ]
+                                                        )
+                transcoder.transcode request_pb
+              end
+
               ##
               # @private
               #

data/lib/google/cloud/firestore/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Firestore
       module V1
-        VERSION = "2.2.1"
+        VERSION = "2.4.0"
       end
     end
   end

data/lib/google/firestore/v1/aggregation_result_pb.rb

@@ -9,30 +9,8 @@ require 'google/firestore/v1/document_pb'
 
 descriptor_data = "\n,google/firestore/v1/aggregation_result.proto\x12\x13google.firestore.v1\x1a\"google/firestore/v1/document.proto\"\xbe\x01\n\x11\x41ggregationResult\x12U\n\x10\x61ggregate_fields\x18\x02 \x03(\x0b\x32;.google.firestore.v1.AggregationResult.AggregateFieldsEntry\x1aR\n\x14\x41ggregateFieldsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12)\n\x05value\x18\x02 \x01(\x0b\x32\x1a.google.firestore.v1.Value:\x02\x38\x01\x42\xce\x01\n\x17\x63om.google.firestore.v1B\x16\x41ggregationResultProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
 
-pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-    ["google.firestore.v1.Value", "google/firestore/v1/document.proto"],
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
 
 module Google
   module Cloud

data/lib/google/firestore/v1/bloom_filter_pb.rb

@@ -7,29 +7,8 @@ require 'google/protobuf'
 
 descriptor_data = "\n&google/firestore/v1/bloom_filter.proto\x12\x13google.firestore.v1\".\n\x0b\x42itSequence\x12\x0e\n\x06\x62itmap\x18\x01 \x01(\x0c\x12\x0f\n\x07padding\x18\x02 \x01(\x05\"Q\n\x0b\x42loomFilter\x12.\n\x04\x62its\x18\x01 \x01(\x0b\x32 .google.firestore.v1.BitSequence\x12\x12\n\nhash_count\x18\x02 \x01(\x05\x42\xc8\x01\n\x17\x63om.google.firestore.v1B\x10\x42loomFilterProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
 
-pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
 
 module Google
   module Cloud

data/lib/google/firestore/v1/common_pb.rb

@@ -4,35 +4,14 @@
 
 require 'google/protobuf'
 
+require 'google/api/field_behavior_pb'
 require 'google/protobuf/timestamp_pb'
 
 
-descriptor_data = "\n google/firestore/v1/common.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/protobuf/timestamp.proto\"#\n\x0c\x44ocumentMask\x12\x13\n\x0b\x66ield_paths\x18\x01 \x03(\t\"e\n\x0cPrecondition\x12\x10\n\x06\x65xists\x18\x01 \x01(\x08H\x00\x12\x31\n\x0bupdate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x10\n\x0e\x63ondition_type\"\xa9\x02\n\x12TransactionOptions\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.TransactionOptions.ReadOnlyH\x00\x12G\n\nread_write\x18\x03 \x01(\x0b\x32\x31.google.firestore.v1.TransactionOptions.ReadWriteH\x00\x1a&\n\tReadWrite\x12\x19\n\x11retry_transaction\x18\x01 \x01(\x0c\x1aS\n\x08ReadOnly\x12/\n\tread_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x16\n\x14\x63onsistency_selectorB\x06\n\x04modeB\xc3\x01\n\x17\x63om.google.firestore.v1B\x0b\x43ommonProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
+descriptor_data = "\n google/firestore/v1/common.proto\x12\x13google.firestore.v1\x1a\x1fgoogle/api/field_behavior.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"#\n\x0c\x44ocumentMask\x12\x13\n\x0b\x66ield_paths\x18\x01 \x03(\t\"e\n\x0cPrecondition\x12\x10\n\x06\x65xists\x18\x01 \x01(\x08H\x00\x12\x31\n\x0bupdate_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x10\n\x0e\x63ondition_type\"\xd7\x03\n\x12TransactionOptions\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.firestore.v1.TransactionOptions.ReadOnlyH\x00\x12G\n\nread_write\x18\x03 \x01(\x0b\x32\x31.google.firestore.v1.TransactionOptions.ReadWriteH\x00\x1a~\n\tReadWrite\x12\x19\n\x11retry_transaction\x18\x01 \x01(\x0c\x12V\n\x10\x63oncurrency_mode\x18\x02 \x01(\x0e\x32\x37.google.firestore.v1.TransactionOptions.ConcurrencyModeB\x03\xe0\x41\x01\x1aS\n\x08ReadOnly\x12/\n\tread_time\x18\x02 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\x42\x16\n\x14\x63onsistency_selector\"T\n\x0f\x43oncurrencyMode\x12 \n\x1c\x43ONCURRENCY_MODE_UNSPECIFIED\x10\x00\x12\x0e\n\nOPTIMISTIC\x10\x01\x12\x0f\n\x0bPESSIMISTIC\x10\x02\x42\x06\n\x04modeB\xc3\x01\n\x17\x63om.google.firestore.v1B\x0b\x43ommonProtoP\x01Z;cloud.google.com/go/firestore/apiv1/firestorepb;firestorepb\xa2\x02\x04GCFS\xaa\x02\x19Google.Cloud.Firestore.V1\xca\x02\x19Google\\Cloud\\Firestore\\V1\xea\x02\x1cGoogle::Cloud::Firestore::V1b\x06proto3"
 
-pool = Google::Protobuf::DescriptorPool.generated_pool
-
-begin
-  pool.add_serialized_file(descriptor_data)
-rescue TypeError
-  # Compatibility code: will be removed in the next major version.
-  require 'google/protobuf/descriptor_pb'
-  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
-  parsed.clear_dependency
-  serialized = parsed.class.encode(parsed)
-  file = pool.add_serialized_file(serialized)
-  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
-  imports = [
-    ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
-  ]
-  imports.each do |type_name, expected_filename|
-    import_file = pool.lookup(type_name).file_descriptor
-    if import_file.name != expected_filename
-      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
-    end
-  end
-  warn "Each proto file must use a consistent fully-qualified name."
-  warn "This will become an error in the next major version."
-end
+pool = ::Google::Protobuf::DescriptorPool.generated_pool
+pool.add_serialized_file(descriptor_data)
 
 module Google
   module Cloud
@@ -43,6 +22,7 @@ module Google
         TransactionOptions = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions").msgclass
         TransactionOptions::ReadWrite = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions.ReadWrite").msgclass
         TransactionOptions::ReadOnly = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions.ReadOnly").msgclass
+        TransactionOptions::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.v1.TransactionOptions.ConcurrencyMode").enummodule
       end
     end
   end