google-cloud-firestore 1.3.0 → 1.4.4

data/lib/google/cloud/firestore/admin/v1/firestore_admin_client_config.json

@@ -7,7 +7,11 @@
           "INTERNAL",
           "UNAVAILABLE"
         ],
-        "non_idempotent": []
+        "non_idempotent": [],
+        "idempotent2": [
+          "DEADLINE_EXCEEDED",
+          "UNAVAILABLE"
+        ]
       },
       "retry_params": {
         "default": {
@@ -21,47 +25,47 @@
         }
       },
       "methods": {
-        "CreateIndex": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "ListIndexes": {
+        "DeleteIndex": {
           "timeout_millis": 60000,
           "retry_codes_name": "idempotent",
           "retry_params_name": "default"
         },
-        "GetIndex": {
+        "UpdateField": {
           "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
+          "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
-        "DeleteIndex": {
+        "CreateIndex": {
           "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
+          "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"
         },
-        "ImportDocuments": {
+        "ListIndexes": {
           "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
+          "retry_codes_name": "idempotent2",
           "retry_params_name": "default"
         },
-        "ExportDocuments": {
+        "GetIndex": {
           "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
+          "retry_codes_name": "idempotent2",
           "retry_params_name": "default"
         },
         "GetField": {
           "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
+          "retry_codes_name": "idempotent2",
           "retry_params_name": "default"
         },
         "ListFields": {
           "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
+          "retry_codes_name": "idempotent2",
           "retry_params_name": "default"
         },
-        "UpdateField": {
+        "ExportDocuments": {
+          "timeout_millis": 60000,
+          "retry_codes_name": "non_idempotent",
+          "retry_params_name": "default"
+        },
+        "ImportDocuments": {
           "timeout_millis": 60000,
           "retry_codes_name": "non_idempotent",
           "retry_params_name": "default"

data/lib/google/cloud/firestore/service.rb

@@ -71,7 +71,10 @@ module Google
         end
 
         def get_documents document_paths, mask: nil, transaction: nil
-          batch_get_args = { mask: document_mask(mask) }
+          batch_get_args = {
+            documents: document_paths,
+            mask:      document_mask(mask)
+          }
           if transaction.is_a? String
             batch_get_args[:transaction] = transaction
           elsif transaction
@@ -80,8 +83,7 @@ module Google
           batch_get_args[:options] = call_options parent: database_path
 
           execute do
-            firestore.batch_get_documents database_path, document_paths,
-                                          batch_get_args
+            firestore.batch_get_documents database_path, **batch_get_args
           end
         end
 
@@ -115,7 +117,7 @@ module Google
           list_args[:options] = call_options parent: database_path
 
           execute do
-            firestore.list_collection_ids parent, list_args
+            firestore.list_collection_ids parent, **list_args
           end
         end
 
@@ -129,7 +131,7 @@ module Google
           run_query_args[:options] = call_options parent: database_path
 
           execute do
-            firestore.run_query path, run_query_args
+            firestore.run_query path, **run_query_args
           end
         end
 
@@ -152,12 +154,14 @@ module Google
         end
 
         def commit writes, transaction: nil
-          commit_args = {}
+          commit_args = {
+            writes: writes
+          }
           commit_args[:transaction] = transaction if transaction
           commit_args[:options] = call_options parent: database_path
 
           execute do
-            firestore.commit database_path, writes, commit_args
+            firestore.commit database_path, **commit_args
           end
         end
 
@@ -170,11 +174,13 @@ module Google
         end
 
         def database_path project_id: project, database_id: "(default)"
-          V1::FirestoreClient.database_root_path project_id, database_id
+          # Originally used V1::FirestoreClient.database_root_path until it was removed in #5405.
+          "projects/#{project_id}/databases/#{database_id}"
         end
 
         def documents_path project_id: project, database_id: "(default)"
-          V1::FirestoreClient.document_root_path project_id, database_id
+          # Originally used V1::FirestoreClient.document_root_path until it was removed in #5405.
+          "projects/#{project_id}/databases/#{database_id}/documents"
         end
 
         def inspect
@@ -189,7 +195,7 @@ module Google
         end
 
         def call_options parent: nil, token: nil
-          Google::Gax::CallOptions.new({
+          Google::Gax::CallOptions.new(**{
             metadata:   default_headers(parent),
             page_token: token
           }.delete_if { |_, v| v.nil? })

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

@@ -80,80 +80,6 @@ module Google
           ].freeze
 
 
-          ANY_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}"
-          )
-
-          private_constant :ANY_PATH_PATH_TEMPLATE
-
-          DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}"
-          )
-
-          private_constant :DATABASE_ROOT_PATH_TEMPLATE
-
-          DOCUMENT_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents/{document_path=**}"
-          )
-
-          private_constant :DOCUMENT_PATH_PATH_TEMPLATE
-
-          DOCUMENT_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents"
-          )
-
-          private_constant :DOCUMENT_ROOT_PATH_TEMPLATE
-
-          # 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
-
-          # 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_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 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
-
           # @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.
@@ -231,6 +157,9 @@ module Google
             google_api_client.freeze
 
             headers = { :"x-goog-api-client" => google_api_client }
+            if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
+              headers[:"x-goog-user-project"] = credentials.quota_project_id
+            end
             headers.merge!(metadata) unless metadata.nil?
             client_config_file = Pathname.new(__dir__).join(
               "firestore_client_config.json"
@@ -390,8 +319,10 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_name = Google::Cloud::Firestore::V1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
-          #   response = firestore_client.get_document(formatted_name)
+          #
+          #   # TODO: Initialize `name`:
+          #   name = ''
+          #   response = firestore_client.get_document(name)
 
           def get_document \
               name,
@@ -468,18 +399,20 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_parent = Google::Cloud::Firestore::V1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
+          #
+          #   # TODO: Initialize `parent`:
+          #   parent = ''
           #
           #   # TODO: Initialize `collection_id`:
           #   collection_id = ''
           #
           #   # Iterate over all results.
-          #   firestore_client.list_documents(formatted_parent, collection_id).each do |element|
+          #   firestore_client.list_documents(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|
+          #   firestore_client.list_documents(parent, collection_id).each_page do |page|
           #     # Process each page at a time.
           #     page.each do |element|
           #       # Process element.
@@ -519,14 +452,14 @@ module Google
           #   `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
           # @param collection_id [String]
           #   Required. 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::V1::Document | Hash]
           #   Required. The document to create. `name` must not be set.
           #   A hash of the same form as `Google::Firestore::V1::Document`
           #   can also be provided.
+          # @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 mask [Google::Firestore::V1::DocumentMask | Hash]
           #   The fields to return. If not set, returns all fields.
           #
@@ -546,31 +479,30 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_parent = Google::Cloud::Firestore::V1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
+          #
+          #   # TODO: Initialize `parent`:
+          #   parent = ''
           #
           #   # 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)
+          #   response = firestore_client.create_document(parent, collection_id, document)
 
           def create_document \
               parent,
               collection_id,
-              document_id,
               document,
+              document_id: nil,
               mask: nil,
               options: nil,
               &block
             req = {
               parent: parent,
               collection_id: collection_id,
-              document_id: document_id,
               document: document,
+              document_id: document_id,
               mask: mask
             }.delete_if { |_, v| v.nil? }
             req = Google::Gax::to_proto(req, Google::Firestore::V1::CreateDocumentRequest)
@@ -621,14 +553,11 @@ module Google
           #
           #   # TODO: Initialize `document`:
           #   document = {}
-          #
-          #   # TODO: Initialize `update_mask`:
-          #   update_mask = {}
-          #   response = firestore_client.update_document(document, update_mask)
+          #   response = firestore_client.update_document(document)
 
           def update_document \
               document,
-              update_mask,
+              update_mask: nil,
               mask: nil,
               current_document: nil,
               options: nil,
@@ -664,8 +593,10 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_name = Google::Cloud::Firestore::V1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
-          #   firestore_client.delete_document(formatted_name)
+          #
+          #   # TODO: Initialize `name`:
+          #   name = ''
+          #   firestore_client.delete_document(name)
 
           def delete_document \
               name,
@@ -726,17 +657,16 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_database = Google::Cloud::Firestore::V1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
           #
-          #   # TODO: Initialize `documents`:
-          #   documents = []
-          #   firestore_client.batch_get_documents(formatted_database, documents).each do |element|
+          #   # TODO: Initialize `database`:
+          #   database = ''
+          #   firestore_client.batch_get_documents(database).each do |element|
           #     # Process element.
           #   end
 
           def batch_get_documents \
               database,
-              documents,
+              documents: nil,
               mask: nil,
               transaction: nil,
               new_transaction: nil,
@@ -776,8 +706,10 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_database = Google::Cloud::Firestore::V1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
-          #   response = firestore_client.begin_transaction(formatted_database)
+          #
+          #   # TODO: Initialize `database`:
+          #   database = ''
+          #   response = firestore_client.begin_transaction(database)
 
           def begin_transaction \
               database,
@@ -817,15 +749,14 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_database = Google::Cloud::Firestore::V1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
           #
-          #   # TODO: Initialize `writes`:
-          #   writes = []
-          #   response = firestore_client.commit(formatted_database, writes)
+          #   # TODO: Initialize `database`:
+          #   database = ''
+          #   response = firestore_client.commit(database)
 
           def commit \
               database,
-              writes,
+              writes: nil,
               transaction: nil,
               options: nil,
               &block
@@ -856,11 +787,13 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_database = Google::Cloud::Firestore::V1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
+          #
+          #   # TODO: Initialize `database`:
+          #   database = ''
           #
           #   # TODO: Initialize `transaction`:
           #   transaction = ''
-          #   firestore_client.rollback(formatted_database, transaction)
+          #   firestore_client.rollback(database, transaction)
 
           def rollback \
               database,
@@ -914,8 +847,10 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_parent = Google::Cloud::Firestore::V1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
-          #   firestore_client.run_query(formatted_parent).each do |element|
+          #
+          #   # TODO: Initialize `parent`:
+          #   parent = ''
+          #   firestore_client.run_query(parent).each do |element|
           #     # Process element.
           #   end
 
@@ -958,8 +893,10 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_database = Google::Cloud::Firestore::V1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
-          #   request = { database: formatted_database }
+          #
+          #   # TODO: Initialize `database`:
+          #   database = ''
+          #   request = { database: database }
           #   requests = [request]
           #   firestore_client.write(requests).each do |element|
           #     # Process element.
@@ -993,8 +930,10 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_database = Google::Cloud::Firestore::V1::FirestoreClient.database_root_path("[PROJECT]", "[DATABASE]")
-          #   request = { database: formatted_database }
+          #
+          #   # TODO: Initialize `database`:
+          #   database = ''
+          #   request = { database: database }
           #   requests = [request]
           #   firestore_client.listen(requests).each do |element|
           #     # Process element.
@@ -1036,15 +975,17 @@ module Google
           #   require "google/cloud/firestore/v1"
           #
           #   firestore_client = Google::Cloud::Firestore::V1.new
-          #   formatted_parent = Google::Cloud::Firestore::V1::FirestoreClient.any_path_path("[PROJECT]", "[DATABASE]", "[DOCUMENT]", "[ANY_PATH]")
+          #
+          #   # TODO: Initialize `parent`:
+          #   parent = ''
           #
           #   # Iterate over all results.
-          #   firestore_client.list_collection_ids(formatted_parent).each do |element|
+          #   firestore_client.list_collection_ids(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|
+          #   firestore_client.list_collection_ids(parent).each_page do |page|
           #     # Process each page at a time.
           #     page.each do |element|
           #       # Process element.