google-apis-firestore_v1 0.28.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56754b1259d90ecbc12eae2441505aaabf0aabbddc39c7cbd8ecb1d2c7851e41
-  data.tar.gz: e87dffa8f484e736ae95702a9d9704e5feb66f82ef4bd173474d30986e101b12
+  metadata.gz: 8eba1049564a84a181ad74b387ea673d94ae63e2fcd72db165742f8092c14080
+  data.tar.gz: d385e45f249a69d70de4340baf181295c1ef0cf1059b202dd1dfdf3ef985f2a5
 SHA512:
-  metadata.gz: 7a55df4a172bf30a5924ce4c277f640ae39bf5b075e67b48f1e7291d1fec3c297df1886e1c014274e90c3b0863508abd851d46fcfb95bccf0a5a2449126747e6
-  data.tar.gz: 2d0c4b0f9f1715769f528db02013ac2a50ee49f9557f135331f0d46c9abc3e41d19a6bbc480cc00f43a97ecfa1091bc529068f04e76d3ff4e932c0f721b5fe20
+  metadata.gz: bdaff76ddbad8fa52ad886afa1d24f5792ee92497c32c6bbcca946de9dac97ece2832ce165274a329df28cfdb5039d9ff342256e67057bd2210f34c8eb882940
+  data.tar.gz: 224d48cf491bd819767538bd9295e4ed31e6189e817878a2a444af6fd7f011fe63e00951cebe868f49dfaf3ee91a1d203e51462d8fa440e4310a470504b665cc

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-firestore_v1
 
+### v0.30.0 (2022-12-15)
+
+* Regenerated from discovery document revision 20221210
+
+### v0.29.0 (2022-11-04)
+
+* Regenerated from discovery document revision 20221029
+* Regenerated using generator version 0.11.0
+
 ### v0.28.0 (2022-09-28)
 
 * Regenerated from discovery document revision 20220915

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

@@ -1244,6 +1244,11 @@ module Google
       class GoogleFirestoreAdminV1Index
         include Google::Apis::Core::Hashable
       
+        # The API scope supported by this index.
+        # Corresponds to the JSON property `apiScope`
+        # @return [String]
+        attr_accessor :api_scope
+      
         # The fields supported by this index. For composite indexes, this requires a
         # minimum of 2 and a maximum of 100 fields. The last field entry is always for
         # the field path `__name__`. If, on creation, `__name__` was not specified as
@@ -1285,6 +1290,7 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @api_scope = args[:api_scope] if args.key?(:api_scope)
           @fields = args[:fields] if args.key?(:fields)
           @name = args[:name] if args.key?(:name)
           @query_scope = args[:query_scope] if args.key?(:query_scope)
@@ -1814,7 +1820,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.28.0"
+      GEM_VERSION = "0.30.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.10.0"
+      GENERATOR_VERSION = "0.11.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220915"
+      REVISION = "20221210"
     end
   end
 end

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

@@ -894,6 +894,7 @@ module Google
       class GoogleFirestoreAdminV1Index
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :api_scope, as: 'apiScope'
           collection :fields, as: 'fields', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1IndexField::Representation
       
           property :name, as: 'name'

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.28.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2023-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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.28.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.30.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1
 post_install_message: 
 rdoc_options: []