firestore.rb in google-cloud-firestore-1.2.2

- old
+ new

@@ -17,11 +17,11 @@
   module Firestore
     module V1
       # The request for {Google::Firestore::V1::Firestore::GetDocument Firestore::GetDocument}.
       # @!attribute [rw] name
       #   @return [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}`.
       # @!attribute [rw] mask
       #   @return [Google::Firestore::V1::DocumentMask]
       #     The fields to return. If not set, returns all fields.
       #
@@ -37,19 +37,19 @@
       class GetDocumentRequest; end
 
       # The request for {Google::Firestore::V1::Firestore::ListDocuments Firestore::ListDocuments}.
       # @!attribute [rw] parent
       #   @return [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`
       # @!attribute [rw] collection_id
       #   @return [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`.
       # @!attribute [rw] page_size
       #   @return [Integer]
       #     The maximum number of documents to return.
       # @!attribute [rw] page_token
@@ -92,24 +92,24 @@
       class ListDocumentsResponse; end
 
       # The request for {Google::Firestore::V1::Firestore::CreateDocument Firestore::CreateDocument}.
       # @!attribute [rw] parent
       #   @return [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}`
       # @!attribute [rw] collection_id
       #   @return [String]
-      #     The collection ID, relative to `parent`, to list. For example: `chatrooms`.
+      #     Required. The collection ID, relative to `parent`, to list. For example: `chatrooms`.
       # @!attribute [rw] document_id
       #   @return [String]
       #     The client-assigned document ID to use for this document.
       #
       #     Optional. If not specified, an ID will be assigned by the service.
       # @!attribute [rw] document
       #   @return [Google::Firestore::V1::Document]
-      #     The document to create. `name` must not be set.
+      #     Required. The document to create. `name` must not be set.
       # @!attribute [rw] mask
       #   @return [Google::Firestore::V1::DocumentMask]
       #     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
@@ -117,11 +117,11 @@
       class CreateDocumentRequest; end
 
       # The request for {Google::Firestore::V1::Firestore::UpdateDocument Firestore::UpdateDocument}.
       # @!attribute [rw] document
       #   @return [Google::Firestore::V1::Document]
-      #     The updated document.
+      #     Required. The updated document.
       #     Creates the document if it does not already exist.
       # @!attribute [rw] update_mask
       #   @return [Google::Firestore::V1::DocumentMask]
       #     The fields to update.
       #     None of the field paths in the mask may contain a reserved name.
@@ -143,22 +143,22 @@
       class UpdateDocumentRequest; end
 
       # The request for {Google::Firestore::V1::Firestore::DeleteDocument Firestore::DeleteDocument}.
       # @!attribute [rw] name
       #   @return [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}`.
       # @!attribute [rw] current_document
       #   @return [Google::Firestore::V1::Precondition]
       #     An optional precondition on the document.
       #     The request will fail if this is set and not met by the target document.
       class DeleteDocumentRequest; end
 
       # The request for {Google::Firestore::V1::Firestore::BatchGetDocuments Firestore::BatchGetDocuments}.
       # @!attribute [rw] database
       #   @return [String]
-      #     The database name. In the format:
+      #     Required. The database name. In the format:
       #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] documents
       #   @return [Array<String>]
       #     The names of the documents to retrieve. In the format:
       #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
@@ -207,11 +207,11 @@
       class BatchGetDocumentsResponse; end
 
       # The request for {Google::Firestore::V1::Firestore::BeginTransaction Firestore::BeginTransaction}.
       # @!attribute [rw] database
       #   @return [String]
-      #     The database name. In the format:
+      #     Required. The database name. In the format:
       #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] options
       #   @return [Google::Firestore::V1::TransactionOptions]
       #     The options for the transaction.
       #     Defaults to a read-write transaction.
@@ -224,11 +224,11 @@
       class BeginTransactionResponse; end
 
       # The request for {Google::Firestore::V1::Firestore::Commit Firestore::Commit}.
       # @!attribute [rw] database
       #   @return [String]
-      #     The database name. In the format:
+      #     Required. The database name. In the format:
       #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] writes
       #   @return [Array<Google::Firestore::V1::Write>]
       #     The writes to apply.
       #
@@ -251,21 +251,21 @@
       class CommitResponse; end
 
       # The request for {Google::Firestore::V1::Firestore::Rollback Firestore::Rollback}.
       # @!attribute [rw] database
       #   @return [String]
-      #     The database name. In the format:
+      #     Required. The database name. In the format:
       #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] transaction
       #   @return [String]
-      #     The transaction to roll back.
+      #     Required. The transaction to roll back.
       class RollbackRequest; end
 
       # The request for {Google::Firestore::V1::Firestore::RunQuery Firestore::RunQuery}.
       # @!attribute [rw] parent
       #   @return [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`
@@ -323,11 +323,11 @@
       # When resuming a stream, the server first streams any responses later than the
       # given token, then a response containing only an up-to-date token, to use in
       # the next request.
       # @!attribute [rw] database
       #   @return [String]
-      #     The database name. In the format:
+      #     Required. The database name. In the format:
       #     `projects/{project_id}/databases/{database_id}`.
       #     This is only required in the first message.
       # @!attribute [rw] stream_id
       #   @return [String]
       #     The ID of the write stream to resume.
@@ -385,11 +385,11 @@
       class WriteResponse; end
 
       # A request for {Google::Firestore::V1::Firestore::Listen Firestore::Listen}
       # @!attribute [rw] database
       #   @return [String]
-      #     The database name. In the format:
+      #     Required. The database name. In the format:
       #     `projects/{project_id}/databases/{database_id}`.
       # @!attribute [rw] add_target
       #   @return [Google::Firestore::V1::Target]
       #     A target to add to this stream.
       # @!attribute [rw] remove_target
@@ -536,10 +536,10 @@
       end
 
       # The request for {Google::Firestore::V1::Firestore::ListCollectionIds Firestore::ListCollectionIds}.
       # @!attribute [rw] parent
       #   @return [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`
       # @!attribute [rw] page_size
       #   @return [Integer]
\ No newline at end of file