google-api-client 0.42.0 → 0.42.1

data/generated/google/apis/firestore_v1.rb

@@ -26,7 +26,7 @@ module Google
     # @see https://cloud.google.com/firestore
     module FirestoreV1
       VERSION = 'V1'
-      REVISION = '20200311'
+      REVISION = '20200709'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

data/generated/google/apis/firestore_v1/classes.rb

@@ -138,6 +138,63 @@ module Google
         end
       end
       
+      # The request for Firestore.BatchWrite.
+      class BatchWriteRequest
+        include Google::Apis::Core::Hashable
+      
+        # Labels associated with this batch write.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # The writes to apply.
+        # Method does not apply writes atomically and does not guarantee ordering.
+        # Each write succeeds or fails independently. You cannot write to the same
+        # document more than once per request.
+        # Corresponds to the JSON property `writes`
+        # @return [Array<Google::Apis::FirestoreV1::Write>]
+        attr_accessor :writes
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @labels = args[:labels] if args.key?(:labels)
+          @writes = args[:writes] if args.key?(:writes)
+        end
+      end
+      
+      # The response from Firestore.BatchWrite.
+      class BatchWriteResponse
+        include Google::Apis::Core::Hashable
+      
+        # The status of applying the writes.
+        # This i-th write status corresponds to the i-th write in the
+        # request.
+        # Corresponds to the JSON property `status`
+        # @return [Array<Google::Apis::FirestoreV1::Status>]
+        attr_accessor :status
+      
+        # The result of applying the writes.
+        # This i-th write result corresponds to the i-th write in the
+        # request.
+        # Corresponds to the JSON property `writeResults`
+        # @return [Array<Google::Apis::FirestoreV1::WriteResult>]
+        attr_accessor :write_results
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @status = args[:status] if args.key?(:status)
+          @write_results = args[:write_results] if args.key?(:write_results)
+        end
+      end
+      
       # The request for Firestore.BeginTransaction.
       class BeginTransactionRequest
         include Google::Apis::Core::Hashable
@@ -1792,6 +1849,101 @@ module Google
         end
       end
       
+      # The request for Firestore.PartitionQuery.
+      class PartitionQueryRequest
+        include Google::Apis::Core::Hashable
+      
+        # The maximum number of partitions to return in this call, subject to
+        # `partition_count`.
+        # For example, if `partition_count` = 10 and `page_size` = 8, the first call
+        # to PartitionQuery will return up to 8 partitions and a `next_page_token`
+        # if more results exist. A second call to PartitionQuery will return up to
+        # 2 partitions, to complete the total of 10 specified in `partition_count`.
+        # Corresponds to the JSON property `pageSize`
+        # @return [Fixnum]
+        attr_accessor :page_size
+      
+        # The `next_page_token` value returned from a previous call to
+        # PartitionQuery that may be used to get an additional set of results.
+        # There are no ordering guarantees between sets of results. Thus, using
+        # multiple sets of results will require merging the different result sets.
+        # For example, two subsequent calls using a page_token may return:
+        # * cursor B, cursor M, cursor Q
+        # * cursor A, cursor U, cursor W
+        # To obtain a complete result set ordered with respect to the results of the
+        # query supplied to PartitionQuery, the results sets should be merged:
+        # cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
+        # Corresponds to the JSON property `pageToken`
+        # @return [String]
+        attr_accessor :page_token
+      
+        # The desired maximum number of partition points.
+        # The partitions may be returned across multiple pages of results.
+        # The number must be strictly positive. The actual number of partitions
+        # returned may be fewer.
+        # For example, this may be set to one fewer than the number of parallel
+        # queries to be run, or in running a data pipeline job, one fewer than the
+        # number of workers or compute instances available.
+        # Corresponds to the JSON property `partitionCount`
+        # @return [Fixnum]
+        attr_accessor :partition_count
+      
+        # A Firestore query.
+        # Corresponds to the JSON property `structuredQuery`
+        # @return [Google::Apis::FirestoreV1::StructuredQuery]
+        attr_accessor :structured_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @page_size = args[:page_size] if args.key?(:page_size)
+          @page_token = args[:page_token] if args.key?(:page_token)
+          @partition_count = args[:partition_count] if args.key?(:partition_count)
+          @structured_query = args[:structured_query] if args.key?(:structured_query)
+        end
+      end
+      
+      # The response for Firestore.PartitionQuery.
+      class PartitionQueryResponse
+        include Google::Apis::Core::Hashable
+      
+        # A page token that may be used to request an additional set of results, up
+        # to the number specified by `partition_count` in the PartitionQuery request.
+        # If blank, there are no more results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # Partition results.
+        # Each partition is a split point that can be used by RunQuery as a starting
+        # or end point for the query results. The RunQuery requests must be made with
+        # the same query supplied to this PartitionQuery request. The partition
+        # cursors will be ordered according to same ordering as the results of the
+        # query supplied to PartitionQuery.
+        # For example, if a PartitionQuery request returns partition cursors A and B,
+        # running the following three queries will return the entire result set of
+        # the original query:
+        # * query, end_at A
+        # * query, start_at A, end_at B
+        # * query, start_at B
+        # Corresponds to the JSON property `partitions`
+        # @return [Array<Google::Apis::FirestoreV1::Cursor>]
+        attr_accessor :partitions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @partitions = args[:partitions] if args.key?(:partitions)
+        end
+      end
+      
       # A precondition on a document, used for conditional operations.
       class Precondition
         include Google::Apis::Core::Hashable

data/generated/google/apis/firestore_v1/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
       
@@ -334,6 +346,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
       
@@ -480,6 +504,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::FirestoreV1::Write, decorator: Google::Apis::FirestoreV1::Write::Representation
+      
+        end
+      end
+      
+      class BatchWriteResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :status, as: 'status', class: Google::Apis::FirestoreV1::Status, decorator: Google::Apis::FirestoreV1::Status::Representation
+      
+          collection :write_results, as: 'writeResults', class: Google::Apis::FirestoreV1::WriteResult, decorator: Google::Apis::FirestoreV1::WriteResult::Representation
+      
+        end
+      end
+      
       class BeginTransactionRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -950,6 +993,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::FirestoreV1::StructuredQuery, decorator: Google::Apis::FirestoreV1::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::FirestoreV1::Cursor, decorator: Google::Apis::FirestoreV1::Cursor::Representation
+      
+        end
+      end
+      
       class Precondition
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -461,6 +461,46 @@ 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::FirestoreV1::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::FirestoreV1::BatchWriteResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::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, 'v1/{+database}/documents:batchWrite', options)
+          command.request_representation = Google::Apis::FirestoreV1::BatchWriteRequest::Representation
+          command.request_object = batch_write_request_object
+          command.response_representation = Google::Apis::FirestoreV1::BatchWriteResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1::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:
@@ -796,6 +836,44 @@ 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::FirestoreV1::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::FirestoreV1::PartitionQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::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, 'v1/{+parent}:partitionQuery', options)
+          command.request_representation = Google::Apis::FirestoreV1::PartitionQueryRequest::Representation
+          command.request_object = partition_query_request_object
+          command.response_representation = Google::Apis::FirestoreV1::PartitionQueryResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1::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

data/generated/google/apis/firestore_v1beta1.rb

@@ -26,7 +26,7 @@ module Google
     # @see https://cloud.google.com/firestore
     module FirestoreV1beta1
       VERSION = 'V1beta1'
-      REVISION = '20200311'
+      REVISION = '20200709'
 
       # View and manage your data across Google Cloud Platform services
       AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'

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

@@ -138,6 +138,63 @@ module Google
         end
       end
       
+      # The request for Firestore.BatchWrite.
+      class BatchWriteRequest
+        include Google::Apis::Core::Hashable
+      
+        # Labels associated with this batch write.
+        # Corresponds to the JSON property `labels`
+        # @return [Hash<String,String>]
+        attr_accessor :labels
+      
+        # The writes to apply.
+        # Method does not apply writes atomically and does not guarantee ordering.
+        # Each write succeeds or fails independently. You cannot write to the same
+        # document more than once per request.
+        # Corresponds to the JSON property `writes`
+        # @return [Array<Google::Apis::FirestoreV1beta1::Write>]
+        attr_accessor :writes
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @labels = args[:labels] if args.key?(:labels)
+          @writes = args[:writes] if args.key?(:writes)
+        end
+      end
+      
+      # The response from Firestore.BatchWrite.
+      class BatchWriteResponse
+        include Google::Apis::Core::Hashable
+      
+        # The status of applying the writes.
+        # This i-th write status corresponds to the i-th write in the
+        # request.
+        # Corresponds to the JSON property `status`
+        # @return [Array<Google::Apis::FirestoreV1beta1::Status>]
+        attr_accessor :status
+      
+        # The result of applying the writes.
+        # This i-th write result corresponds to the i-th write in the
+        # request.
+        # Corresponds to the JSON property `writeResults`
+        # @return [Array<Google::Apis::FirestoreV1beta1::WriteResult>]
+        attr_accessor :write_results
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @status = args[:status] if args.key?(:status)
+          @write_results = args[:write_results] if args.key?(:write_results)
+        end
+      end
+      
       # The request for Firestore.BeginTransaction.
       class BeginTransactionRequest
         include Google::Apis::Core::Hashable
@@ -1430,6 +1487,101 @@ module Google
         end
       end
       
+      # The request for Firestore.PartitionQuery.
+      class PartitionQueryRequest
+        include Google::Apis::Core::Hashable
+      
+        # The maximum number of partitions to return in this call, subject to
+        # `partition_count`.
+        # For example, if `partition_count` = 10 and `page_size` = 8, the first call
+        # to PartitionQuery will return up to 8 partitions and a `next_page_token`
+        # if more results exist. A second call to PartitionQuery will return up to
+        # 2 partitions, to complete the total of 10 specified in `partition_count`.
+        # Corresponds to the JSON property `pageSize`
+        # @return [Fixnum]
+        attr_accessor :page_size
+      
+        # The `next_page_token` value returned from a previous call to
+        # PartitionQuery that may be used to get an additional set of results.
+        # There are no ordering guarantees between sets of results. Thus, using
+        # multiple sets of results will require merging the different result sets.
+        # For example, two subsequent calls using a page_token may return:
+        # * cursor B, cursor M, cursor Q
+        # * cursor A, cursor U, cursor W
+        # To obtain a complete result set ordered with respect to the results of the
+        # query supplied to PartitionQuery, the results sets should be merged:
+        # cursor A, cursor B, cursor M, cursor Q, cursor U, cursor W
+        # Corresponds to the JSON property `pageToken`
+        # @return [String]
+        attr_accessor :page_token
+      
+        # The desired maximum number of partition points.
+        # The partitions may be returned across multiple pages of results.
+        # The number must be strictly positive. The actual number of partitions
+        # returned may be fewer.
+        # For example, this may be set to one fewer than the number of parallel
+        # queries to be run, or in running a data pipeline job, one fewer than the
+        # number of workers or compute instances available.
+        # Corresponds to the JSON property `partitionCount`
+        # @return [Fixnum]
+        attr_accessor :partition_count
+      
+        # A Firestore query.
+        # Corresponds to the JSON property `structuredQuery`
+        # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
+        attr_accessor :structured_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @page_size = args[:page_size] if args.key?(:page_size)
+          @page_token = args[:page_token] if args.key?(:page_token)
+          @partition_count = args[:partition_count] if args.key?(:partition_count)
+          @structured_query = args[:structured_query] if args.key?(:structured_query)
+        end
+      end
+      
+      # The response for Firestore.PartitionQuery.
+      class PartitionQueryResponse
+        include Google::Apis::Core::Hashable
+      
+        # A page token that may be used to request an additional set of results, up
+        # to the number specified by `partition_count` in the PartitionQuery request.
+        # If blank, there are no more results.
+        # Corresponds to the JSON property `nextPageToken`
+        # @return [String]
+        attr_accessor :next_page_token
+      
+        # Partition results.
+        # Each partition is a split point that can be used by RunQuery as a starting
+        # or end point for the query results. The RunQuery requests must be made with
+        # the same query supplied to this PartitionQuery request. The partition
+        # cursors will be ordered according to same ordering as the results of the
+        # query supplied to PartitionQuery.
+        # For example, if a PartitionQuery request returns partition cursors A and B,
+        # running the following three queries will return the entire result set of
+        # the original query:
+        # * query, end_at A
+        # * query, start_at A, end_at B
+        # * query, start_at B
+        # Corresponds to the JSON property `partitions`
+        # @return [Array<Google::Apis::FirestoreV1beta1::Cursor>]
+        attr_accessor :partitions
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
+          @partitions = args[:partitions] if args.key?(:partitions)
+        end
+      end
+      
       # A precondition on a document, used for conditional operations.
       class Precondition
         include Google::Apis::Core::Hashable