google-apis-firestore_v1 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c160c56a7c1ddeb85ab0e05f37ddb96a194981f9bc27add2bf68f5b5d924ed8
-  data.tar.gz: d4543ef8d5a795f6a8d6929fa9d28e3f36da569e6f0786de3b74696bc8da4b9c
+  metadata.gz: 30df2136b7f0ba850511529d6d7ca84e4eed7a1e28a4a0468e82989f811a196b
+  data.tar.gz: ccb786ca708df82e438115d72816b8ab4a865e2da813becd01d4e8ed34fdfdec
 SHA512:
-  metadata.gz: 220fef5f10d035c66723ae572931295b4904cb2692b0dc7a46aa86a2be0efa327d806141efa93d8017d66d9db8968ec2b229cdfccb052adda3a8efb1f6572e96
-  data.tar.gz: 3ee90a65234e19c33bef5f32acf19ef999a31355700b376c108b1938a897c11eca2d59511146ac406a53b7796d982377722e856db0ce1277a86324c95a9c4690
+  metadata.gz: f4669a85f20327eb3e29333c10c95a9ba5890bdd22e9c4cb97f85a0d272c7b47a5919e86fe11cc2d5e432468e1b702d872c190b6f2d3e73408f7a65c94accffc
+  data.tar.gz: 29dfbaf5dee03ed335364a1040bf538b04167221c7c54ddaf9ca44e916ac6ead3f466aff0f077df08ad7f4797c3e382d1fa1866a7a91d80e24ba52e6d4eb58fd

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-firestore_v1
 
+### v0.17.0 (2022-03-19)
+
+* Regenerated from discovery document revision 20220305
+
 ### v0.16.0 (2022-03-04)
 
 * Regenerated from discovery document revision 20220221

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

@@ -780,6 +780,11 @@ module Google
       class GoogleFirestoreAdminV1Database
         include Google::Apis::Core::Hashable
       
+        # The App Engine integration mode to use for this database.
+        # Corresponds to the JSON property `appEngineIntegrationMode`
+        # @return [String]
+        attr_accessor :app_engine_integration_mode
+      
         # The concurrency control mode to use for this database.
         # Corresponds to the JSON property `concurrencyMode`
         # @return [String]
@@ -792,6 +797,15 @@ module Google
         # @return [String]
         attr_accessor :etag
       
+        # Output only. The key_prefix for this database. This key_prefix is used, in
+        # combination with the project id ("~") to construct the application id that is
+        # returned from the Cloud Datastore APIs in Google App Engine first generation
+        # runtimes. This value may be empty in which case the appid to use for URL-
+        # encoded keys is the project_id (eg: foo instead of v~foo).
+        # Corresponds to the JSON property `keyPrefix`
+        # @return [String]
+        attr_accessor :key_prefix
+      
         # The location of the database. Available databases are listed at https://cloud.
         # google.com/firestore/docs/locations.
         # Corresponds to the JSON property `locationId`
@@ -816,8 +830,10 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @app_engine_integration_mode = args[:app_engine_integration_mode] if args.key?(:app_engine_integration_mode)
           @concurrency_mode = args[:concurrency_mode] if args.key?(:concurrency_mode)
           @etag = args[:etag] if args.key?(:etag)
+          @key_prefix = args[:key_prefix] if args.key?(:key_prefix)
           @location_id = args[:location_id] if args.key?(:location_id)
           @name = args[:name] if args.key?(:name)
           @type = args[:type] if args.key?(:type)
@@ -2144,6 +2160,13 @@ module Google
         # @return [Google::Apis::FirestoreV1::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
@@ -2174,6 +2197,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_v1/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module FirestoreV1
       # Version of the google-apis-firestore_v1 gem
-      GEM_VERSION = "0.16.0"
+      GEM_VERSION = "0.17.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 = "20220221"
+      REVISION = "20220305"
     end
   end
 end

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

@@ -727,8 +727,10 @@ module Google
       class GoogleFirestoreAdminV1Database
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :app_engine_integration_mode, as: 'appEngineIntegrationMode'
           property :concurrency_mode, as: 'concurrencyMode'
           property :etag, as: 'etag'
+          property :key_prefix, as: 'keyPrefix'
           property :location_id, as: 'locationId'
           property :name, as: 'name'
           property :type, as: 'type'
@@ -1119,6 +1121,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :document, as: 'document', class: Google::Apis::FirestoreV1::Document, decorator: Google::Apis::FirestoreV1::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_v1/service.rb

@@ -874,6 +874,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::FirestoreV1::ListDocumentsResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::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, 'v1/{+parent}/{collectionId}', options)
+          command.response_representation = Google::Apis::FirestoreV1::ListDocumentsResponse::Representation
+          command.response_class = Google::Apis::FirestoreV1::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_v1
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-07 00:00:00.000000000 Z
+date: 2022-03-21 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_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.16.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.17.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []