google-apis-firestore_v1beta1 0.10.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4adc12463ffd3971bfed3d3550fd263a00706eeed7bf07cc3615cf0777ee68c8
-  data.tar.gz: 8bb35ecb229d158f2e1e0a2614cb218d1d5d9ac2167ec9daf0baea7f418a3d36
+  metadata.gz: 4883f7b025b8f6621073dabf1df6ec289c714836323b821b94d5e62e55a1b887
+  data.tar.gz: 38a7239b4b5113d51be7e713139e79e4d01b052a9a6eb5cfd53e4ec7f6c7b8f0
 SHA512:
-  metadata.gz: 3dbf3764ce963fcf2d67b2bc8c87bc7fbf236a8d95fe01547c5941fb523eb59a57ba50611dd8a7f1e63e2c2ff02616fdba9afdabba14fdc3627ba4017727cc80
-  data.tar.gz: 29032b9e2a50002ff917c434cafe997d75a97407b17f2d3f716319d624e4a690b3e84acbe255a544c2e677f1b034bbd4a60aa10d9a066600e9f19a019a416acc
+  metadata.gz: 69ab6e3f5120b1be23b683506ee12b5a8370852103fce63c46439a9cd2ed0160ef85a36653423dbbff6c6ef514338a968b708e8c8938cd46b3f05cdbee3a3f4e
+  data.tar.gz: acf076581cd85e2b13318abb65a21c07c6db82ac170f5954bd6b5103755a323277cf6e84303d0b9c8a40ebba7c93b40c8cd9121864e2ec654d1fb4929ffad43e

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Release history for google-apis-firestore_v1beta1
 
+### v0.13.0 (2022-03-30)
+
+* Regenerated from discovery document revision 20220319
+
+### v0.12.0 (2022-03-19)
+
+* Regenerated from discovery document revision 20220305
+
+### v0.11.0 (2022-03-04)
+
+* Regenerated from discovery document revision 20220221
+
 ### v0.10.0 (2022-01-21)
 
 * Regenerated from discovery document revision 20220110

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

@@ -598,8 +598,7 @@ module Google
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
-      # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
-      # `Empty` is empty JSON object ````.
+      # protobuf.Empty) returns (google.protobuf.Empty); `
       class Empty
         include Google::Apis::Core::Hashable
       
@@ -1269,6 +1268,12 @@ module Google
         # @return [String]
         attr_accessor :page_token
       
+        # Reads documents as they were at the given time. This may not be older than 270
+        # seconds.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
         def initialize(**args)
            update!(**args)
         end
@@ -1277,6 +1282,7 @@ module Google
         def update!(**args)
           @page_size = args[:page_size] if args.key?(:page_size)
           @page_token = args[:page_token] if args.key?(:page_token)
+          @read_time = args[:read_time] if args.key?(:read_time)
         end
       end
       
@@ -1497,6 +1503,12 @@ module Google
         # @return [Fixnum]
         attr_accessor :partition_count
       
+        # Reads documents as they were at the given time. This may not be older than 270
+        # seconds.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
         # A Firestore query.
         # Corresponds to the JSON property `structuredQuery`
         # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
@@ -1511,6 +1523,7 @@ module Google
           @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)
+          @read_time = args[:read_time] if args.key?(:read_time)
           @structured_query = args[:structured_query] if args.key?(:structured_query)
         end
       end
@@ -1706,7 +1719,8 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::StructuredQuery]
         attr_accessor :structured_query
       
-        # Reads documents in a transaction.
+        # Run the query within an already active transaction. The value here is the
+        # opaque transaction ID to execute the query in.
         # Corresponds to the JSON property `transaction`
         # NOTE: Values are automatically base64 encoded/decoded in the client library.
         # @return [String]
@@ -1734,6 +1748,13 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::Document]
         attr_accessor :document
       
+        # If present, Firestore has completely finished the request and no more
+        # documents will be returned.
+        # Corresponds to the JSON property `done`
+        # @return [Boolean]
+        attr_accessor :done
+        alias_method :done?, :done
+      
         # The time at which the document was read. This may be monotonically increasing;
         # in this case, the previous documents in the result stream are guaranteed not
         # to have changed between their `read_time` and this one. If the query returns
@@ -1764,6 +1785,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @document = args[:document] if args.key?(:document)
+          @done = args[:done] if args.key?(:done)
           @read_time = args[:read_time] if args.key?(:read_time)
           @skipped_results = args[:skipped_results] if args.key?(:skipped_results)
           @transaction = args[:transaction] if args.key?(:transaction)

data/lib/google/apis/firestore_v1beta1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1beta1
       # Version of the google-apis-firestore_v1beta1 gem
-      GEM_VERSION = "0.10.0"
+      GEM_VERSION = "0.13.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.4.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220110"
+      REVISION = "20220319"
     end
   end
 end

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

@@ -797,6 +797,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :page_size, as: 'pageSize'
           property :page_token, as: 'pageToken'
+          property :read_time, as: 'readTime'
         end
       end
       
@@ -866,6 +867,7 @@ module Google
           property :page_size, as: 'pageSize'
           property :page_token, as: 'pageToken'
           property :partition_count, :numeric_string => true, as: 'partitionCount'
+          property :read_time, as: 'readTime'
           property :structured_query, as: 'structuredQuery', class: Google::Apis::FirestoreV1beta1::StructuredQuery, decorator: Google::Apis::FirestoreV1beta1::StructuredQuery::Representation
       
         end
@@ -943,6 +945,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :document, as: 'document', class: Google::Apis::FirestoreV1beta1::Document, decorator: Google::Apis::FirestoreV1beta1::Document::Representation
       
+          property :done, as: 'done'
           property :read_time, as: 'readTime'
           property :skipped_results, as: 'skippedResults'
           property :transaction, :base64 => true, as: 'transaction'

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

@@ -497,6 +497,71 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # 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`
+        # @param [String] collection_id
+        #   Required. The collection ID, relative to `parent`, to list. For example: `
+        #   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.
+        # @param [String] order_by
+        #   The order to sort results by. For example: `priority desc, name`.
+        # @param [Fixnum] page_size
+        #   The maximum number of documents to return.
+        # @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.
+        # @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`.
+        # @param [String] transaction
+        #   Reads documents in a transaction.
+        # @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::ListDocumentsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1beta1::ListDocumentsResponse]
+        #
+        # @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 list_project_database_document_documents(parent, collection_id, mask_field_paths: nil, order_by: nil, page_size: nil, page_token: nil, read_time: nil, show_missing: nil, transaction: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:get, 'v1beta1/{+parent}/{collectionId}', options)
+          command.response_representation = Google::Apis::FirestoreV1beta1::ListDocumentsResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1beta1::ListDocumentsResponse
+          command.params['parent'] = parent unless parent.nil?
+          command.params['collectionId'] = collection_id unless collection_id.nil?
+          command.query['mask.fieldPaths'] = mask_field_paths unless mask_field_paths.nil?
+          command.query['orderBy'] = order_by unless order_by.nil?
+          command.query['pageSize'] = page_size unless page_size.nil?
+          command.query['pageToken'] = page_token unless page_token.nil?
+          command.query['readTime'] = read_time unless read_time.nil?
+          command.query['showMissing'] = show_missing unless show_missing.nil?
+          command.query['transaction'] = transaction unless transaction.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Listens to changes.
         # @param [String] database
         #   Required. The database name. In the format: `projects/`project_id`/databases/`

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-24 00:00:00.000000000 Z
+date: 2022-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.10.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.13.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
 post_install_message: 
 rdoc_options: []