google-api-client 0.41.2 → 0.44.0

data/generated/google/apis/firestore_v1beta1/representations.rb

@@ -40,6 +40,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class BatchWriteRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class BatchWriteResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class BeginTransactionRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -280,6 +292,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PartitionQueryRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class PartitionQueryResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Precondition
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -426,6 +450,25 @@ module Google
         end
       end
       
+      class BatchWriteRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :labels, as: 'labels'
+          collection :writes, as: 'writes', class: Google::Apis::FirestoreV1beta1::Write, decorator: Google::Apis::FirestoreV1beta1::Write::Representation
+      
+        end
+      end
+      
+      class BatchWriteResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :status, as: 'status', class: Google::Apis::FirestoreV1beta1::Status, decorator: Google::Apis::FirestoreV1beta1::Status::Representation
+      
+          collection :write_results, as: 'writeResults', class: Google::Apis::FirestoreV1beta1::WriteResult, decorator: Google::Apis::FirestoreV1beta1::WriteResult::Representation
+      
+        end
+      end
+      
       class BeginTransactionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -805,6 +848,26 @@ module Google
         end
       end
       
+      class PartitionQueryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :page_size, as: 'pageSize'
+          property :page_token, as: 'pageToken'
+          property :partition_count, :numeric_string => true, as: 'partitionCount'
+          property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
+      
+        end
+      end
+      
+      class PartitionQueryResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :next_page_token, as: 'nextPageToken'
+          collection :partitions, as: 'partitions', class: Google::Apis::FirestoreV1beta1::Cursor, decorator: Google::Apis::FirestoreV1beta1::Cursor::Representation
+      
+        end
+      end
+      
       class Precondition
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/generated/google/apis/firestore_v1beta1/service.rb

@@ -48,17 +48,16 @@ module Google
           @batch_path = 'batch'
         end
         
-        # Exports a copy of all or a subset of documents from Google Cloud Firestore
-        # to another storage system, such as Google Cloud Storage. Recent updates to
+        # Exports a copy of all or a subset of documents from Google Cloud Firestore to
+        # another storage system, such as Google Cloud Storage. Recent updates to
         # documents may not be reflected in the export. The export occurs in the
-        # background and its progress can be monitored and managed via the
-        # Operation resource that is created. The output of an export may only be
-        # used once the associated operation is done. If an export operation is
-        # cancelled before completion it may leave partial data behind in Google
-        # Cloud Storage.
+        # background and its progress can be monitored and managed via the Operation
+        # resource that is created. The output of an export may only be used once the
+        # associated operation is done. If an export operation is cancelled before
+        # completion it may leave partial data behind in Google Cloud Storage.
         # @param [String] name
-        #   Database to export. Should be of the form:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Database to export. Should be of the form: `projects/`project_id`/databases/`
+        #   database_id``.
         # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ExportDocumentsRequest] google_firestore_admin_v1beta1_export_documents_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -92,11 +91,11 @@ module Google
         # Imports documents into Google Cloud Firestore. Existing documents with the
         # same name are overwritten. The import occurs in the background and its
         # progress can be monitored and managed via the Operation resource that is
-        # created. If an ImportDocuments operation is cancelled, it is possible
-        # that a subset of the data has already been imported to Cloud Firestore.
+        # created. If an ImportDocuments operation is cancelled, it is possible that a
+        # subset of the data has already been imported to Cloud Firestore.
         # @param [String] name
-        #   Database to import into. Should be of the form:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Database to import into. Should be of the form: `projects/`project_id`/
+        #   databases/`database_id``.
         # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1ImportDocumentsRequest] google_firestore_admin_v1beta1_import_documents_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -127,12 +126,11 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Gets multiple documents.
-        # Documents returned by this method are not guaranteed to be returned in the
-        # same order that they were requested.
+        # Gets multiple documents. Documents returned by this method are not guaranteed
+        # to be returned in the same order that they were requested.
         # @param [String] database
-        #   Required. The database name. In the format:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``.
         # @param [Google::Apis::FirestoreV1beta1::BatchGetDocumentsRequest] batch_get_documents_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -163,10 +161,48 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Applies a batch of write operations. The BatchWrite method does not apply the
+        # write operations atomically and can apply them out of order. Method does not
+        # allow more than one write per document. Each write succeeds or fails
+        # independently. See the BatchWriteResponse for the success status of each write.
+        # If you require an atomically applied set of writes, use Commit instead.
+        # @param [String] database
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``.
+        # @param [Google::Apis::FirestoreV1beta1::BatchWriteRequest] batch_write_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirestoreV1beta1::BatchWriteResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1beta1::BatchWriteResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def batch_document_write(database, batch_write_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+database}/documents:batchWrite', options)
+          command.request_representation = Google::Apis::FirestoreV1beta1::BatchWriteRequest::Representation
+          command.request_object = batch_write_request_object
+          command.response_representation = Google::Apis::FirestoreV1beta1::BatchWriteResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1beta1::BatchWriteResponse
+          command.params['database'] = database unless database.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Starts a new transaction.
         # @param [String] database
-        #   Required. The database name. In the format:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``.
         # @param [Google::Apis::FirestoreV1beta1::BeginTransactionRequest] begin_transaction_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -199,8 +235,8 @@ module Google
         
         # Commits a transaction, while optionally updating documents.
         # @param [String] database
-        #   Required. The database name. In the format:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``.
         # @param [Google::Apis::FirestoreV1beta1::CommitRequest] commit_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -233,20 +269,19 @@ module Google
         
         # Creates a new document.
         # @param [String] parent
-        #   Required. The parent resource. For example:
-        #   `projects/`project_id`/databases/`database_id`/documents` or
-        #   `projects/`project_id`/databases/`database_id`/documents/chatrooms/`
-        #   chatroom_id``
+        #   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 [String] collection_id
         #   Required. The collection ID, relative to `parent`, to list. For example: `
         #   chatrooms`.
         # @param [Google::Apis::FirestoreV1beta1::Document] document_object
         # @param [String] document_id
-        #   The client-assigned document ID to use for this document.
-        #   Optional. If not specified, an ID will be assigned by the service.
+        #   The client-assigned document ID to use for this document. Optional. If not
+        #   specified, an ID will be assigned by the service.
         # @param [Array<String>, String] mask_field_paths
-        #   The list of field paths in the mask. See Document.fields for a field
-        #   path syntax reference.
+        #   The list of field paths in the mask. See Document.fields for a field path
+        #   syntax reference.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -281,14 +316,14 @@ module Google
         
         # Deletes a document.
         # @param [String] name
-        #   Required. The resource name of the Document to delete. In the format:
-        #   `projects/`project_id`/databases/`database_id`/documents/`document_path``.
+        #   Required. The resource name of the Document to delete. In the format: `
+        #   projects/`project_id`/databases/`database_id`/documents/`document_path``.
         # @param [Boolean] current_document_exists
-        #   When set to `true`, the target document must exist.
-        #   When set to `false`, the target document must not exist.
+        #   When set to `true`, the target document must exist. When set to `false`, the
+        #   target document must not exist.
         # @param [String] current_document_update_time
-        #   When set, the target document must exist and have been last updated at
-        #   that time.
+        #   When set, the target document must exist and have been last updated at that
+        #   time.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -320,14 +355,14 @@ module Google
         
         # Gets a single document.
         # @param [String] name
-        #   Required. The resource name of the Document to get. In the format:
-        #   `projects/`project_id`/databases/`database_id`/documents/`document_path``.
+        #   Required. The resource name of the Document to get. In the format: `projects/`
+        #   project_id`/databases/`database_id`/documents/`document_path``.
         # @param [Array<String>, String] mask_field_paths
-        #   The list of field paths in the mask. See Document.fields for a field
-        #   path syntax reference.
+        #   The list of field paths in the mask. See Document.fields for a field path
+        #   syntax reference.
         # @param [String] read_time
-        #   Reads the version of the document at the given time.
-        #   This may not be older than 270 seconds.
+        #   Reads the version of the document at the given time. This may not be older
+        #   than 270 seconds.
         # @param [String] transaction
         #   Reads the document in a transaction.
         # @param [String] fields
@@ -362,19 +397,17 @@ module Google
         
         # Lists documents.
         # @param [String] parent
-        #   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`
+        #   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 [String] collection_id
         #   Required. The collection ID, relative to `parent`, to list. For example: `
-        #   chatrooms`
-        #   or `messages`.
+        #   chatrooms` or `messages`.
         # @param [Array<String>, String] mask_field_paths
-        #   The list of field paths in the mask. See Document.fields for a field
-        #   path syntax reference.
+        #   The list of field paths in the mask. See Document.fields for a field path
+        #   syntax reference.
         # @param [String] order_by
         #   The order to sort results by. For example: `priority desc, name`.
         # @param [Fixnum] page_size
@@ -382,15 +415,14 @@ module Google
         # @param [String] page_token
         #   The `next_page_token` value returned from a previous List request, if any.
         # @param [String] read_time
-        #   Reads documents as they were at the given time.
-        #   This may not be older than 270 seconds.
+        #   Reads documents as they were at the given time. This may not be older than 270
+        #   seconds.
         # @param [Boolean] show_missing
-        #   If the list should show missing documents. A missing document is a
-        #   document that does not exist but has sub-documents. These documents will
-        #   be returned with a key but will not have fields, Document.create_time,
-        #   or Document.update_time set.
-        #   Requests with `show_missing` may not specify `where` or
-        #   `order_by`.
+        #   If the list should show missing documents. A missing document is a document
+        #   that does not exist but has sub-documents. These documents will be returned
+        #   with a key but will not have fields, Document.create_time, or Document.
+        #   update_time set. Requests with `show_missing` may not specify `where` or `
+        #   order_by`.
         # @param [String] transaction
         #   Reads documents in a transaction.
         # @param [String] fields
@@ -430,10 +462,9 @@ module Google
         
         # Lists all the collection IDs underneath a document.
         # @param [String] parent
-        #   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`
+        #   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 [Google::Apis::FirestoreV1beta1::ListCollectionIdsRequest] list_collection_ids_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -466,8 +497,8 @@ module Google
         
         # Listens to changes.
         # @param [String] database
-        #   Required. The database name. In the format:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``.
         # @param [Google::Apis::FirestoreV1beta1::ListenRequest] listen_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -498,23 +529,60 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Partitions a query by returning partition cursors that can be used to run the
+        # query in parallel. The returned partition cursors are split points that can be
+        # used by RunQuery as starting/end points for the query results.
+        # @param [String] parent
+        #   Required. The parent resource name. In the format: `projects/`project_id`/
+        #   databases/`database_id`/documents`. Document resource names are not supported;
+        #   only database resource names can be specified.
+        # @param [Google::Apis::FirestoreV1beta1::PartitionQueryRequest] partition_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::FirestoreV1beta1::PartitionQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1beta1::PartitionQueryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def partition_document_query(parent, partition_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+parent}:partitionQuery', options)
+          command.request_representation = Google::Apis::FirestoreV1beta1::PartitionQueryRequest::Representation
+          command.request_object = partition_query_request_object
+          command.response_representation = Google::Apis::FirestoreV1beta1::PartitionQueryResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1beta1::PartitionQueryResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Updates or inserts a document.
         # @param [String] name
-        #   The resource name of the document, for example
-        #   `projects/`project_id`/databases/`database_id`/documents/`document_path``.
+        #   The resource name of the document, for example `projects/`project_id`/
+        #   databases/`database_id`/documents/`document_path``.
         # @param [Google::Apis::FirestoreV1beta1::Document] document_object
         # @param [Boolean] current_document_exists
-        #   When set to `true`, the target document must exist.
-        #   When set to `false`, the target document must not exist.
+        #   When set to `true`, the target document must exist. When set to `false`, the
+        #   target document must not exist.
         # @param [String] current_document_update_time
-        #   When set, the target document must exist and have been last updated at
-        #   that time.
+        #   When set, the target document must exist and have been last updated at that
+        #   time.
         # @param [Array<String>, String] mask_field_paths
-        #   The list of field paths in the mask. See Document.fields for a field
-        #   path syntax reference.
+        #   The list of field paths in the mask. See Document.fields for a field path
+        #   syntax reference.
         # @param [Array<String>, String] update_mask_field_paths
-        #   The list of field paths in the mask. See Document.fields for a field
-        #   path syntax reference.
+        #   The list of field paths in the mask. See Document.fields for a field path
+        #   syntax reference.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -550,8 +618,8 @@ module Google
         
         # Rolls back a transaction.
         # @param [String] database
-        #   Required. The database name. In the format:
-        #   `projects/`project_id`/databases/`database_id``.
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``.
         # @param [Google::Apis::FirestoreV1beta1::RollbackRequest] rollback_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -584,12 +652,11 @@ module Google
         
         # Runs a query.
         # @param [String] parent
-        #   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`
+        #   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 [Google::Apis::FirestoreV1beta1::RunQueryRequest] run_query_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -622,9 +689,8 @@ module Google
         
         # Streams batches of document updates and deletes, in order.
         # @param [String] database
-        #   Required. The database name. In the format:
-        #   `projects/`project_id`/databases/`database_id``.
-        #   This is only required in the first message.
+        #   Required. The database name. In the format: `projects/`project_id`/databases/`
+        #   database_id``. This is only required in the first message.
         # @param [Google::Apis::FirestoreV1beta1::WriteRequest] write_request_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -655,20 +721,17 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Creates the specified index.
-        # A newly created index's initial state is `CREATING`. On completion of the
-        # returned google.longrunning.Operation, the state will be `READY`.
-        # If the index already exists, the call will return an `ALREADY_EXISTS`
-        # status.
-        # During creation, the process could result in an error, in which case the
-        # index will move to the `ERROR` state. The process can be recovered by
-        # fixing the data that caused the error, removing the index with
-        # delete, then re-creating the index with
-        # create.
-        # Indexes with a single field cannot be created.
+        # Creates the specified index. A newly created index's initial state is `
+        # CREATING`. On completion of the returned google.longrunning.Operation, the
+        # state will be `READY`. If the index already exists, the call will return an `
+        # ALREADY_EXISTS` status. During creation, the process could result in an error,
+        # in which case the index will move to the `ERROR` state. The process can be
+        # recovered by fixing the data that caused the error, removing the index with
+        # delete, then re-creating the index with create. Indexes with a single field
+        # cannot be created.
         # @param [String] parent
-        #   The name of the database this index will apply to. For example:
-        #   `projects/`project_id`/databases/`database_id``
+        #   The name of the database this index will apply to. For example: `projects/`
+        #   project_id`/databases/`database_id``
         # @param [Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1beta1Index] google_firestore_admin_v1beta1_index_object
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
@@ -701,8 +764,8 @@ module Google
         
         # Deletes an index.
         # @param [String] name
-        #   The index name. For example:
-        #   `projects/`project_id`/databases/`database_id`/indexes/`index_id``
+        #   The index name. For example: `projects/`project_id`/databases/`database_id`/
+        #   indexes/`index_id``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -732,8 +795,8 @@ module Google
         
         # Gets an index.
         # @param [String] name
-        #   The name of the index. For example:
-        #   `projects/`project_id`/databases/`database_id`/indexes/`index_id``
+        #   The name of the index. For example: `projects/`project_id`/databases/`
+        #   database_id`/indexes/`index_id``
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -763,8 +826,7 @@ module Google
         
         # Lists the indexes that match the specified filters.
         # @param [String] parent
-        #   The database name. For example:
-        #   `projects/`project_id`/databases/`database_id``
+        #   The database name. For example: `projects/`project_id`/databases/`database_id``
         # @param [String] filter
         # @param [Fixnum] page_size
         #   The standard List page size.