google-apis-firestore_v1 0.29.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef54838ef632922a9329bb1631550cd26a01bdd927ff458229284657e81810e8
-  data.tar.gz: 07ee97b9393f9c5855ea66c91f59084697b3599405aba34cc01eee0d94137cbb
+  metadata.gz: 4224111df8971548652ce2fdfeecad2c43b559bfaff1b9528f117a381e370b37
+  data.tar.gz: 901ceb84c144a5194efbc6dcb3b9db9f4ea32a515ed82be6e4755431dca7ce69
 SHA512:
-  metadata.gz: 875c68e281c57ab21903e3aaf9d08a3ae220f70c88493d744cac24ba6f2d06f6e1c475d46ed09f37e5cf8d68bfd8fe4ec1eae48d1e41f952746c047dc8c7a68f
-  data.tar.gz: cc71211fb81f6b51eb941e33196faac1617d84133f7ceb70a9b5e30205b3ede62d43b0a8163df5526b294cc48e3841801a6e899a5405adb4f6ded5aa70a82325
+  metadata.gz: adc31b6113a7c8e2a85e8be793fdf96d04eeebfded8764a883133aca0fa4c91b04b8e1f7020d56115f679484d7fcde6b79d104e304682029d9022aaa077310d6
+  data.tar.gz: c4efdf83fb74c5ce6e9e404c0a7145b2cca10c7dc5631917132a1af3d5ffc58388b7093aa29c0a02145df0ec29cb996529263d69dbabdb96c3bd66dcf14845d2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1
 
+### v0.31.0 (2023-01-15)
+
+* Regenerated from discovery document revision 20230110
+* Regenerated using generator version 0.11.1
+
+### v0.30.0 (2022-12-15)
+
+* Regenerated from discovery document revision 20221210
+
 ### v0.29.0 (2022-11-04)
 
 * Regenerated from discovery document revision 20221029

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

@@ -1840,7 +1840,8 @@ module Google
         # @return [Array<Google::Apis::FirestoreV1::Document>]
         attr_accessor :documents
       
-        # The next page token.
+        # A token to retrieve the next page of documents. If this field is omitted,
+        # there are no subsequent pages.
         # Corresponds to the JSON property `nextPageToken`
         # @return [String]
         attr_accessor :next_page_token

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.29.0"
+      GEM_VERSION = "0.31.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.11.0"
+      GENERATOR_VERSION = "0.11.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20221029"
+      REVISION = "20230110"
     end
   end
 end

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

@@ -90,6 +90,49 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Deletes a database.
+        # @param [String] name
+        #   Required. A name of the form `projects/`project_id`/databases/`database_id``
+        # @param [Boolean] allow_missing
+        #   If set to true and the Database is not found, the request will succeed but no
+        #   action will be taken.
+        # @param [String] etag
+        #   The current etag of the Database. If an etag is provided and does not match
+        #   the current etag of the database, deletion will be blocked and a
+        #   FAILED_PRECONDITION error will be returned.
+        # @param [Boolean] validate_only
+        #   If set, validate the request and preview the response, but do not actually
+        #   delete the database.
+        # @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::GoogleLongrunningOperation] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::FirestoreV1::GoogleLongrunningOperation]
+        #
+        # @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 delete_project_database(name, allow_missing: nil, etag: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:delete, 'v1/{+name}', options)
+          command.response_representation = Google::Apis::FirestoreV1::GoogleLongrunningOperation::Representation
+          command.response_class = Google::Apis::FirestoreV1::GoogleLongrunningOperation
+          command.params['name'] = name unless name.nil?
+          command.query['allowMissing'] = allow_missing unless allow_missing.nil?
+          command.query['etag'] = etag unless etag.nil?
+          command.query['validateOnly'] = validate_only unless validate_only.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        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
         # documents may not be reflected in the export. The export occurs in the
@@ -822,28 +865,35 @@ module Google
         #   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`.
+        #   Optional. The collection ID, relative to `parent`, to list. For example: `
+        #   chatrooms` or `messages`. This is optional, and when not provided, Firestore
+        #   will list documents from all collections under the provided `parent`.
         # @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`.
+        #   Optional. The optional ordering of the documents to return. For example: `
+        #   priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
+        #   queries but in a string representation. When absent, documents are ordered
+        #   based on `__name__ ASC`.
         # @param [Fixnum] page_size
-        #   The maximum number of documents to return.
+        #   Optional. The maximum number of documents to return in a single response.
+        #   Firestore may return fewer than this value.
         # @param [String] page_token
-        #   The `next_page_token` value returned from a previous List request, if any.
+        #   Optional. A page token, received from a previous `ListDocuments` response.
+        #   Provide this to retrieve the subsequent page. When paginating, all other
+        #   parameters (with the exception of `page_size`) must match the values set in
+        #   the request that generated the page token.
         # @param [String] read_time
-        #   Reads documents as they were at the given time. This may not be older than 270
-        #   seconds.
+        #   Perform the read at the provided 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 document is missing if it does
+        #   not exist, but there are sub-documents nested underneath it. When true, such
+        #   missing documents will be returned with a key but will not have fields, `
+        #   create_time`, or `update_time` set. Requests with `show_missing` may not
+        #   specify `where` or `order_by`.
         # @param [String] transaction
-        #   Reads documents in a transaction.
+        #   Perform the read as part of an already active transaction.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user
@@ -922,28 +972,35 @@ module Google
         #   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`.
+        #   Optional. The collection ID, relative to `parent`, to list. For example: `
+        #   chatrooms` or `messages`. This is optional, and when not provided, Firestore
+        #   will list documents from all collections under the provided `parent`.
         # @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`.
+        #   Optional. The optional ordering of the documents to return. For example: `
+        #   priority desc, __name__ desc`. This mirrors the `ORDER BY` used in Firestore
+        #   queries but in a string representation. When absent, documents are ordered
+        #   based on `__name__ ASC`.
         # @param [Fixnum] page_size
-        #   The maximum number of documents to return.
+        #   Optional. The maximum number of documents to return in a single response.
+        #   Firestore may return fewer than this value.
         # @param [String] page_token
-        #   The `next_page_token` value returned from a previous List request, if any.
+        #   Optional. A page token, received from a previous `ListDocuments` response.
+        #   Provide this to retrieve the subsequent page. When paginating, all other
+        #   parameters (with the exception of `page_size`) must match the values set in
+        #   the request that generated the page token.
         # @param [String] read_time
-        #   Reads documents as they were at the given time. This may not be older than 270
-        #   seconds.
+        #   Perform the read at the provided 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 document is missing if it does
+        #   not exist, but there are sub-documents nested underneath it. When true, such
+        #   missing documents will be returned with a key but will not have fields, `
+        #   create_time`, or `update_time` set. Requests with `show_missing` may not
+        #   specify `where` or `order_by`.
         # @param [String] transaction
-        #   Reads documents in a transaction.
+        #   Perform the read as part of an already active transaction.
         # @param [String] fields
         #   Selector specifying which fields to include in a partial response.
         # @param [String] quota_user

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2023-01-15 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.29.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.31.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1