firestore_client.rb in google-cloud-firestore-0.24.0

- old
+ new

@@ -17,10 +17,11 @@
 # https://github.com/googleapis/googleapis/blob/master/google/firestore/v1beta1/firestore.proto,
 # 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.
 
+
 require "json"
 require "pathname"
 
 require "google/gax"
 
@@ -49,10 +50,11 @@
         #   to see the effects of the transaction.
         #
         # @!attribute [r] firestore_stub
         #   @return [Google::Firestore::V1beta1::Firestore::Stub]
         class FirestoreClient
+          # @private
           attr_reader :firestore_stub
 
           # The default address of the service.
           SERVICE_ADDRESS = "firestore.googleapis.com".freeze
 
@@ -333,11 +335,11 @@
 
           # Gets a single document.
           #
           # @param name [String]
           #   The resource name of the Document to get. In the format:
-          #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
           # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
           #   The fields to return. If not set, returns all fields.
           #
           #   If the document has a field that is not present in this mask, that field
           #   will not be returned in the response.
@@ -384,12 +386,12 @@
 
           # Lists documents.
           #
           # @param parent [String]
           #   The parent resource name. In the format:
-          #   +projects/{project_id}/databases/{database_id}/documents+ or
-          #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents+ or
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
           #   For example:
           #   +projects/my-project/databases/my-database/documents+ or
           #   +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
           # @param collection_id [String]
           #   The collection ID, relative to +parent+, to list. For example: +chatrooms+
@@ -485,12 +487,12 @@
 
           # Creates a new document.
           #
           # @param parent [String]
           #   The parent resource. For example:
-          #   +projects/{project_id}/databases/{database_id}/documents+ or
-          #   +projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}+
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents+ or
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/chatrooms/\\{chatroom_id}+
           # @param collection_id [String]
           #   The collection ID, relative to +parent+, to list. For example: +chatrooms+.
           # @param document_id [String]
           #   The client-assigned document ID to use for this document.
           #
@@ -617,11 +619,11 @@
 
           # Deletes a document.
           #
           # @param name [String]
           #   The resource name of the Document to delete. In the format:
-          #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
           # @param current_document [Google::Firestore::V1beta1::Precondition | Hash]
           #   An optional precondition on the document.
           #   The request will fail if this is set and not met by the target document.
           #   A hash of the same form as `Google::Firestore::V1beta1::Precondition`
           #   can also be provided.
@@ -658,14 +660,14 @@
           # Documents returned by this method are not guaranteed to be returned in the
           # same order that they were requested.
           #
           # @param database [String]
           #   The database name. In the format:
-          #   +projects/{project_id}/databases/{database_id}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}+.
           # @param documents [Array<String>]
           #   The names of the documents to retrieve. In the format:
-          #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
           #   The request will fail if any of the document is not a child resource of the
           #   given +database+. Duplicate names will be elided.
           # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
           #   The fields to return. If not set, returns all fields.
           #
@@ -728,11 +730,11 @@
 
           # Starts a new transaction.
           #
           # @param database [String]
           #   The database name. In the format:
-          #   +projects/{project_id}/databases/{database_id}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}+.
           # @param options_ [Google::Firestore::V1beta1::TransactionOptions | Hash]
           #   The options for the transaction.
           #   Defaults to a read-write transaction.
           #   A hash of the same form as `Google::Firestore::V1beta1::TransactionOptions`
           #   can also be provided.
@@ -766,11 +768,11 @@
 
           # Commits a transaction, while optionally updating documents.
           #
           # @param database [String]
           #   The database name. In the format:
-          #   +projects/{project_id}/databases/{database_id}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}+.
           # @param writes [Array<Google::Firestore::V1beta1::Write | Hash>]
           #   The writes to apply.
           #
           #   Always executed atomically and in order.
           #   A hash of the same form as `Google::Firestore::V1beta1::Write`
@@ -812,11 +814,11 @@
 
           # Rolls back a transaction.
           #
           # @param database [String]
           #   The database name. In the format:
-          #   +projects/{project_id}/databases/{database_id}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}+.
           # @param transaction [String]
           #   The transaction to roll back.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
@@ -850,12 +852,12 @@
 
           # Runs a query.
           #
           # @param parent [String]
           #   The parent resource name. In the format:
-          #   +projects/{project_id}/databases/{database_id}/documents+ or
-          #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents+ or
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
           #   For example:
           #   +projects/my-project/databases/my-database/documents+ or
           #   +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
           # @param structured_query [Google::Firestore::V1beta1::StructuredQuery | Hash]
           #   A structured query.
@@ -981,10 +983,10 @@
 
           # Lists all the collection IDs underneath a document.
           #
           # @param parent [String]
           #   The parent document. In the format:
-          #   +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+          #   +projects/\\{project_id}/databases/\\{database_id}/documents/\\{document_path}+.
           #   For example:
           #   +projects/my-project/databases/my-database/documents/chatrooms/my-chatroom+
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
           #   response. If page streaming is performed per-resource, this