google-cloud-firestore 0.25.0 → 0.25.1

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

@@ -87,17 +87,17 @@ module Google
           ].freeze
 
 
-          DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}"
+          ANY_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}"
           )
 
-          private_constant :DATABASE_ROOT_PATH_TEMPLATE
+          private_constant :ANY_PATH_PATH_TEMPLATE
 
-          DOCUMENT_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents"
+          DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/databases/{database}"
           )
 
-          private_constant :DOCUMENT_ROOT_PATH_TEMPLATE
+          private_constant :DATABASE_ROOT_PATH_TEMPLATE
 
           DOCUMENT_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/databases/{database}/documents/{document_path=**}"
@@ -105,29 +105,33 @@ module Google
 
           private_constant :DOCUMENT_PATH_PATH_TEMPLATE
 
-          ANY_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}"
+          DOCUMENT_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/databases/{database}/documents"
           )
 
-          private_constant :ANY_PATH_PATH_TEMPLATE
+          private_constant :DOCUMENT_ROOT_PATH_TEMPLATE
 
-          # Returns a fully-qualified database_root resource name string.
+          # 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.database_root_path project, database
-            DATABASE_ROOT_PATH_TEMPLATE.render(
+          def self.any_path_path project, database, document, any_path
+            ANY_PATH_PATH_TEMPLATE.render(
               :"project" => project,
-              :"database" => database
+              :"database" => database,
+              :"document" => document,
+              :"any_path" => any_path
             )
           end
 
-          # Returns a fully-qualified document_root resource name string.
+          # Returns a fully-qualified database_root resource name string.
           # @param project [String]
           # @param database [String]
           # @return [String]
-          def self.document_root_path project, database
-            DOCUMENT_ROOT_PATH_TEMPLATE.render(
+          def self.database_root_path project, database
+            DATABASE_ROOT_PATH_TEMPLATE.render(
               :"project" => project,
               :"database" => database
             )
@@ -146,18 +150,14 @@ module Google
             )
           end
 
-          # Returns a fully-qualified any_path resource name string.
+          # Returns a fully-qualified document_root 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(
+          def self.document_root_path project, database
+            DOCUMENT_ROOT_PATH_TEMPLATE.render(
               :"project" => project,
-              :"database" => database,
-              :"document" => document,
-              :"any_path" => any_path
+              :"database" => database
             )
           end
 
@@ -267,7 +267,10 @@ module Google
             @get_document = Google::Gax.create_api_call(
               @firestore_stub.method(:get_document),
               defaults["get_document"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @list_documents = Google::Gax.create_api_call(
               @firestore_stub.method(:list_documents),
@@ -282,37 +285,58 @@ module Google
             @update_document = Google::Gax.create_api_call(
               @firestore_stub.method(:update_document),
               defaults["update_document"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'document.name' => request.document.name}
+              end
             )
             @delete_document = Google::Gax.create_api_call(
               @firestore_stub.method(:delete_document),
               defaults["delete_document"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @batch_get_documents = Google::Gax.create_api_call(
               @firestore_stub.method(:batch_get_documents),
               defaults["batch_get_documents"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @begin_transaction = Google::Gax.create_api_call(
               @firestore_stub.method(:begin_transaction),
               defaults["begin_transaction"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @commit = Google::Gax.create_api_call(
               @firestore_stub.method(:commit),
               defaults["commit"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @rollback = Google::Gax.create_api_call(
               @firestore_stub.method(:rollback),
               defaults["rollback"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @run_query = Google::Gax.create_api_call(
               @firestore_stub.method(:run_query),
               defaults["run_query"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @write = Google::Gax.create_api_call(
               @firestore_stub.method(:write),
@@ -327,7 +351,10 @@ module Google
             @list_collection_ids = Google::Gax.create_api_call(
               @firestore_stub.method(:list_collection_ids),
               defaults["list_collection_ids"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
           end
 

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

@@ -145,6 +145,15 @@ module Google
           end
         end
 
+        # The projection of document's fields to return.
+        # @!attribute [rw] fields
+        #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::FieldReference>]
+        #     The fields to return.
+        #
+        #     If empty, all fields are returned. To only return the name
+        #     of the document, use `['__name__']`.
+        class Projection; end
+
         # A filter with a single operand.
         # @!attribute [rw] op
         #   @return [Google::Firestore::V1beta1::StructuredQuery::UnaryFilter::Operator]
@@ -180,15 +189,6 @@ module Google
         #   @return [String]
         class FieldReference; end
 
-        # The projection of document's fields to return.
-        # @!attribute [rw] fields
-        #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::FieldReference>]
-        #     The fields to return.
-        #
-        #     If empty, all fields are returned. To only return the name
-        #     of the document, use `['__name__']`.
-        class Projection; end
-
         # A sort direction.
         module Direction
           # Unspecified.

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

@@ -26,7 +26,7 @@ module Google
       #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
       # @!attribute [rw] transform
       #   @return [Google::Firestore::V1beta1::DocumentTransform]
-      #     Applies a tranformation to a document.
+      #     Applies a transformation to a document.
       #     At most one `transform` per document is allowed in a given request.
       #     An `update` cannot follow a `transform` on the same document in a given
       #     request.

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

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

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

@@ -15,17 +15,19 @@
 
 module Google
   module Protobuf
-    # A Timestamp represents a point in time independent of any time zone
-    # or calendar, represented as seconds and fractions of seconds at
-    # nanosecond resolution in UTC Epoch time. It is encoded using the
-    # Proleptic Gregorian Calendar which extends the Gregorian calendar
-    # backwards to year one. It is encoded assuming all minutes are 60
-    # seconds long, i.e. leap seconds are "smeared" so that no leap second
-    # table is needed for interpretation. Range is from
-    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
-    # By restricting to that range, we ensure that we can convert to
-    # and from  RFC 3339 date strings.
-    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
+    # A Timestamp represents a point in time independent of any time zone or local
+    # calendar, encoded as a count of seconds and fractions of seconds at
+    # nanosecond resolution. The count is relative to an epoch at UTC midnight on
+    # January 1, 1970, in the proleptic Gregorian calendar which extends the
+    # Gregorian calendar backwards to year one.
+    #
+    # All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
+    # second table is needed for interpretation, using a [24-hour linear
+    # smear](https://developers.google.com/time/smear).
+    #
+    # The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
+    # restricting to that range, we ensure that we can convert to and from [RFC
+    # 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
     #
     # = Examples
     #
@@ -86,12 +88,12 @@ module Google
     # 01:30 UTC on January 15, 2017.
     #
     # In JavaScript, one can convert a Date object to this format using the
-    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString]
+    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
     # method. In Python, a standard `datetime.datetime` object can be converted
     # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
     # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
     # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
-    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
+    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
     # ) to obtain a formatter capable of generating timestamps in this format.
     # @!attribute [rw] seconds
     #   @return [Integer]

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

@@ -15,24 +15,25 @@
 
 module Google
   module Rpc
-    # The `Status` type defines a logical error model that is suitable for different
-    # programming environments, including REST APIs and RPC APIs. It is used by
-    # [gRPC](https://github.com/grpc). The error model is designed to be:
+    # The `Status` type defines a logical error model that is suitable for
+    # different programming environments, including REST APIs and RPC APIs. It is
+    # used by [gRPC](https://github.com/grpc). The error model is designed to be:
     #
     # * Simple to use and understand for most users
     # * Flexible enough to meet unexpected needs
     #
     # = Overview
     #
-    # The `Status` message contains three pieces of data: error code, error message,
-    # and error details. The error code should be an enum value of
-    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
-    # error message should be a developer-facing English message that helps
-    # developers *understand* and *resolve* the error. If a localized user-facing
-    # error message is needed, put the localized message in the error details or
-    # localize it in the client. The optional error details may contain arbitrary
-    # information about the error. There is a predefined set of error detail types
-    # in the package `google.rpc` that can be used for common error conditions.
+    # The `Status` message contains three pieces of data: error code, error
+    # message, and error details. The error code should be an enum value of
+    # {Google::Rpc::Code}, but it may accept additional error codes
+    # if needed.  The error message should be a developer-facing English message
+    # that helps developers *understand* and *resolve* the error. If a localized
+    # user-facing error message is needed, put the localized message in the error
+    # details or localize it in the client. The optional error details may contain
+    # arbitrary information about the error. There is a predefined set of error
+    # detail types in the package `google.rpc` that can be used for common error
+    # conditions.
     #
     # = Language mapping
     #
@@ -69,12 +70,14 @@ module Google
     #   be used directly after any stripping needed for security/privacy reasons.
     # @!attribute [rw] code
     #   @return [Integer]
-    #     The status code, which should be an enum value of {Google::Rpc::Code}.
+    #     The status code, which should be an enum value of
+    #     {Google::Rpc::Code}.
     # @!attribute [rw] message
     #   @return [String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     {Google::Rpc::Status#details} field, or localized by the client.
+    #     {Google::Rpc::Status#details} field, or localized
+    #     by the client.
     # @!attribute [rw] details
     #   @return [Array<Google::Protobuf::Any>]
     #     A list of messages that carry the error details.  There is a common set of

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

@@ -87,17 +87,17 @@ module Google
           ].freeze
 
 
-          DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}"
+          ANY_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}"
           )
 
-          private_constant :DATABASE_ROOT_PATH_TEMPLATE
+          private_constant :ANY_PATH_PATH_TEMPLATE
 
-          DOCUMENT_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents"
+          DATABASE_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/databases/{database}"
           )
 
-          private_constant :DOCUMENT_ROOT_PATH_TEMPLATE
+          private_constant :DATABASE_ROOT_PATH_TEMPLATE
 
           DOCUMENT_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
             "projects/{project}/databases/{database}/documents/{document_path=**}"
@@ -105,29 +105,33 @@ module Google
 
           private_constant :DOCUMENT_PATH_PATH_TEMPLATE
 
-          ANY_PATH_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
-            "projects/{project}/databases/{database}/documents/{document}/{any_path=**}"
+          DOCUMENT_ROOT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+            "projects/{project}/databases/{database}/documents"
           )
 
-          private_constant :ANY_PATH_PATH_TEMPLATE
+          private_constant :DOCUMENT_ROOT_PATH_TEMPLATE
 
-          # Returns a fully-qualified database_root resource name string.
+          # 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.database_root_path project, database
-            DATABASE_ROOT_PATH_TEMPLATE.render(
+          def self.any_path_path project, database, document, any_path
+            ANY_PATH_PATH_TEMPLATE.render(
               :"project" => project,
-              :"database" => database
+              :"database" => database,
+              :"document" => document,
+              :"any_path" => any_path
             )
           end
 
-          # Returns a fully-qualified document_root resource name string.
+          # Returns a fully-qualified database_root resource name string.
           # @param project [String]
           # @param database [String]
           # @return [String]
-          def self.document_root_path project, database
-            DOCUMENT_ROOT_PATH_TEMPLATE.render(
+          def self.database_root_path project, database
+            DATABASE_ROOT_PATH_TEMPLATE.render(
               :"project" => project,
               :"database" => database
             )
@@ -146,18 +150,14 @@ module Google
             )
           end
 
-          # Returns a fully-qualified any_path resource name string.
+          # Returns a fully-qualified document_root 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(
+          def self.document_root_path project, database
+            DOCUMENT_ROOT_PATH_TEMPLATE.render(
               :"project" => project,
-              :"database" => database,
-              :"document" => document,
-              :"any_path" => any_path
+              :"database" => database
             )
           end
 
@@ -267,7 +267,10 @@ module Google
             @get_document = Google::Gax.create_api_call(
               @firestore_stub.method(:get_document),
               defaults["get_document"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @list_documents = Google::Gax.create_api_call(
               @firestore_stub.method(:list_documents),
@@ -282,37 +285,58 @@ module Google
             @update_document = Google::Gax.create_api_call(
               @firestore_stub.method(:update_document),
               defaults["update_document"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'document.name' => request.document.name}
+              end
             )
             @delete_document = Google::Gax.create_api_call(
               @firestore_stub.method(:delete_document),
               defaults["delete_document"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'name' => request.name}
+              end
             )
             @batch_get_documents = Google::Gax.create_api_call(
               @firestore_stub.method(:batch_get_documents),
               defaults["batch_get_documents"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @begin_transaction = Google::Gax.create_api_call(
               @firestore_stub.method(:begin_transaction),
               defaults["begin_transaction"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @commit = Google::Gax.create_api_call(
               @firestore_stub.method(:commit),
               defaults["commit"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @rollback = Google::Gax.create_api_call(
               @firestore_stub.method(:rollback),
               defaults["rollback"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'database' => request.database}
+              end
             )
             @run_query = Google::Gax.create_api_call(
               @firestore_stub.method(:run_query),
               defaults["run_query"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
             @write = Google::Gax.create_api_call(
               @firestore_stub.method(:write),
@@ -327,7 +351,10 @@ module Google
             @list_collection_ids = Google::Gax.create_api_call(
               @firestore_stub.method(:list_collection_ids),
               defaults["list_collection_ids"],
-              exception_transformer: exception_transformer
+              exception_transformer: exception_transformer,
+              params_extractor: proc do |request|
+                {'parent' => request.parent}
+              end
             )
           end