firestore_client.rb in google-cloud-firestore-1.2.2

- old
+ new

@@ -368,11 +368,11 @@
           # Service calls
 
           # Gets a single document.
           #
           # @param name [String]
-          #   The resource name of the Document to get. In the format:
+          #   Required. The resource name of the Document to get. In the format:
           #   `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
@@ -419,18 +419,18 @@
           end
 
           # Lists documents.
           #
           # @param parent [String]
-          #   The parent resource name. In the format:
+          #   Required. The parent resource name. In the format:
           #   `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`
+          #   Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`
           #   or `messages`.
           # @param page_size [Integer]
           #   The maximum number of resources contained in the underlying API
           #   response. If page streaming is performed per-resource, this
           #   parameter does not affect the return value. If page streaming is
@@ -520,21 +520,21 @@
           end
 
           # Creates a new document.
           #
           # @param parent [String]
-          #   The parent resource. For example:
+          #   Required. The parent resource. For example:
           #   `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`.
+          #   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::V1beta1::Document | Hash]
-          #   The document to create. `name` must not be set.
+          #   Required. The document to create. `name` must not be set.
           #   A hash of the same form as `Google::Firestore::V1beta1::Document`
           #   can also be provided.
           # @param mask [Google::Firestore::V1beta1::DocumentMask | Hash]
           #   The fields to return. If not set, returns all fields.
           #
@@ -586,11 +586,11 @@
           end
 
           # Updates or inserts a document.
           #
           # @param document [Google::Firestore::V1beta1::Document | Hash]
-          #   The updated document.
+          #   Required. The updated document.
           #   Creates the document if it does not already exist.
           #   A hash of the same form as `Google::Firestore::V1beta1::Document`
           #   can also be provided.
           # @param update_mask [Google::Firestore::V1beta1::DocumentMask | Hash]
           #   The fields to update.
@@ -652,11 +652,11 @@
           end
 
           # Deletes a document.
           #
           # @param name [String]
-          #   The resource name of the Document to delete. In the format:
+          #   Required. The resource name of the Document to delete. In the format:
           #   `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`
@@ -693,11 +693,11 @@
           #
           # 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:
+          #   Required. The database name. In the format:
           #   `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}`.
           #   The request will fail if any of the document is not a child resource of the
@@ -763,11 +763,11 @@
           end
 
           # Starts a new transaction.
           #
           # @param database [String]
-          #   The database name. In the format:
+          #   Required. The database name. In the format:
           #   `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`
@@ -801,11 +801,11 @@
           end
 
           # Commits a transaction, while optionally updating documents.
           #
           # @param database [String]
-          #   The database name. In the format:
+          #   Required. The database name. In the format:
           #   `projects/{project_id}/databases/{database_id}`.
           # @param writes [Array<Google::Firestore::V1beta1::Write | Hash>]
           #   The writes to apply.
           #
           #   Always executed atomically and in order.
@@ -847,14 +847,14 @@
           end
 
           # Rolls back a transaction.
           #
           # @param database [String]
-          #   The database name. In the format:
+          #   Required. The database name. In the format:
           #   `projects/{project_id}/databases/{database_id}`.
           # @param transaction [String]
-          #   The transaction to roll back.
+          #   Required. The transaction to roll back.
           # @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 []
@@ -885,11 +885,11 @@
           end
 
           # Runs a query.
           #
           # @param parent [String]
-          #   The parent resource name. In the format:
+          #   Required. The parent resource name. In the format:
           #   `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`
@@ -1016,10 +1016,10 @@
           end
 
           # Lists all the collection IDs underneath a document.
           #
           # @param parent [String]
-          #   The parent document. In the format:
+          #   Required. The parent document. In the format:
           #   `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