google-apis-firestore_v1 0.49.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a81fe73706a83c1870ae680959ddf826d1dccbd1e7a07191a0f63786f396f7cf
-  data.tar.gz: b366bbdfe90d80961cff5a474798f851657f12fd6cb8949ce3ac4d4bbf7f9aa4
+  metadata.gz: 252d91b669d888922a66f913e7e20b05385d2b36ea80f18e3a2993ebb5360f16
+  data.tar.gz: 2a3023e21c16e9e98762d30b6c0d0a8c906b3529603d92fefac4e4dce8bfcb69
 SHA512:
-  metadata.gz: 17fcee9454005cd7ffb67c5751a4e7572c13eac10b5e1559b1630cf9096ddff7d2e9c663579184a16793f26d4affe78f3c14ca7f53c04ad63687d0aaf33f188f
-  data.tar.gz: 450eb2b448767b90b8d6fcae7f7822e21efac2c008b0f180d23e782ef5ffbcf24487cddf9d5df4800e0dfb3440691ce595c82dabe648b95fd2865a6f3b16386b
+  metadata.gz: '08243a86a20a9e4bec0d228762ecaff864255eaecd28b5d75d3e4ef8f4831944d18c8f8d6755cb4d9c9affe8a2e42ae0c4515d90b42303a2d7c63828448a8c96'
+  data.tar.gz: 8859eb1ef6beca57103604808ac6204ac72f2bd5c29ba2a4df292ac960212bad554e94b32ec65c3d31fe4d2032ff9610afcb3a6fe8a024c348fbdde828e932b8

data/CHANGELOG.md

@@ -1,8 +1,16 @@
 # Release history for google-apis-firestore_v1
 
-### v0.49.0 (2023-08-03)
+### v0.51.0 (2023-09-10)
 
-* Regenerated from discovery document revision 20230722
+* Regenerated from discovery document revision 20230905
+
+### v0.50.0 (2023-08-13)
+
+* Regenerated from discovery document revision 20230806
+
+### v0.49.0 (2023-08-06)
+
+* Regenerated from discovery document revision 20230729
 
 ### v0.48.0 (2023-07-23)
 

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

@@ -38,12 +38,38 @@ module Google
         # @return [String]
         attr_accessor :alias
       
+        # Average of the values of the requested field. * Only numeric values will be
+        # aggregated. All non-numeric values including `NULL` are skipped. * If the
+        # aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754
+        # standards. * If the aggregated value set is empty, returns `NULL`. * Always
+        # returns the result as a double.
+        # Corresponds to the JSON property `avg`
+        # @return [Google::Apis::FirestoreV1::Avg]
+        attr_accessor :avg
+      
         # Count of documents that match the query. The `COUNT(*)` aggregation function
         # operates on the entire document so it does not require a field reference.
         # Corresponds to the JSON property `count`
         # @return [Google::Apis::FirestoreV1::Count]
         attr_accessor :count
       
+        # Sum of the values of the requested field. * Only numeric values will be
+        # aggregated. All non-numeric values including `NULL` are skipped. * If the
+        # aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754
+        # standards. * If the aggregated value set is empty, returns 0. * Returns a 64-
+        # bit integer if all aggregated numbers are integers and the sum result does not
+        # overflow. Otherwise, the result is returned as a double. Note that even if all
+        # the aggregated values are integers, the result is returned as a double if it
+        # cannot fit within a 64-bit signed integer. When this occurs, the returned
+        # value will lose precision. * When underflow occurs, floating-point aggregation
+        # is non-deterministic. This means that running the same query repeatedly
+        # without any changes to the underlying values could produce slightly different
+        # results each time. In those cases, values should be stored as integers over
+        # floating-point numbers.
+        # Corresponds to the JSON property `sum`
+        # @return [Google::Apis::FirestoreV1::Sum]
+        attr_accessor :sum
+      
         def initialize(**args)
            update!(**args)
         end
@@ -51,7 +77,9 @@ module Google
         # Update properties of this object
         def update!(**args)
           @alias = args[:alias] if args.key?(:alias)
+          @avg = args[:avg] if args.key?(:avg)
           @count = args[:count] if args.key?(:count)
+          @sum = args[:sum] if args.key?(:sum)
         end
       end
       
@@ -97,6 +125,29 @@ module Google
         end
       end
       
+      # Average of the values of the requested field. * Only numeric values will be
+      # aggregated. All non-numeric values including `NULL` are skipped. * If the
+      # aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754
+      # standards. * If the aggregated value set is empty, returns `NULL`. * Always
+      # returns the result as a double.
+      class Avg
+        include Google::Apis::Core::Hashable
+      
+        # A reference to a field in a document, ex: `stats.operations`.
+        # Corresponds to the JSON property `field`
+        # @return [Google::Apis::FirestoreV1::FieldReference]
+        attr_accessor :field
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @field = args[:field] if args.key?(:field)
+        end
+      end
+      
       # The request for Firestore.BatchGetDocuments.
       class BatchGetDocumentsRequest
         include Google::Apis::Core::Hashable
@@ -537,20 +588,7 @@ module Google
         # @return [String]
         attr_accessor :create_time
       
-        # The document's fields. The map keys represent field names. A simple field name
-        # contains only characters `a` to `z`, `A` to `Z`, `0` to `9`, or `_`, and must
-        # not start with `0` to `9`. For example, `foo_bar_17`. Field names matching the
-        # regular expression `__.*__` are reserved. Reserved field names are forbidden
-        # except in certain documented contexts. The map keys, represented as UTF-8,
-        # must not exceed 1,500 bytes and cannot be empty. Field paths may be used in
-        # other contexts to refer to structured fields defined here. For `map_value`,
-        # the field path is represented by the simple or quoted field names of the
-        # containing fields, delimited by `.`. For example, the structured field `"foo" :
-        # ` map_value: ` "x&y" : ` string_value: "hello" ```` would be represented by
-        # the field path `foo.x&y`. Within a field path, a quoted field name starts and
-        # ends with `` ` `` and may contain any character. Some characters, including ``
-        # ` ``, must be escaped using a `\`. For example, `` `x&y` `` represents `x&y`
-        # and `` `bak\`tik` `` represents `` bak`tik ``.
+        # 
         # Corresponds to the JSON property `fields`
         # @return [Hash<String,Google::Apis::FirestoreV1::Value>]
         attr_accessor :fields
@@ -781,7 +819,9 @@ module Google
         # The total count of documents that match target_id. If different from the count
         # of documents in the client that match, the client must manually determine
         # which documents no longer match the target. The client can use the `
-        # unchanged_names` bloom filter to assist with this determination.
+        # unchanged_names` bloom filter to assist with this determination by testing ALL
+        # the document names against the filter; if the document name is NOT in the
+        # filter, it means the document no longer matches the target.
         # Corresponds to the JSON property `count`
         # @return [Fixnum]
         attr_accessor :count
@@ -850,8 +890,9 @@ module Google
       class FieldReference
         include Google::Apis::Core::Hashable
       
-        # The relative path of the document being referenced. Requires: * Conform to
-        # document field name limitations.
+        # A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`)
+        # string of segments, where each segment conforms to document field name
+        # limitations.
         # Corresponds to the JSON property `fieldPath`
         # @return [String]
         attr_accessor :field_path
@@ -953,7 +994,7 @@ module Google
       end
       
       # A Backup of a Cloud Firestore Database. The backup contains all documents and
-      # index configurations for the given database at specific point in time.
+      # index configurations for the given database at a specific point in time.
       class GoogleFirestoreAdminV1Backup
         include Google::Apis::Core::Hashable
       
@@ -1071,6 +1112,19 @@ module Google
         end
       end
       
+      # Metadata related to the create database operation.
+      class GoogleFirestoreAdminV1CreateDatabaseMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Represent a recurring schedule that runs at a specific time every day. The
       # time zone is UTC.
       class GoogleFirestoreAdminV1DailyRecurrence
@@ -1085,8 +1139,7 @@ module Google
         end
       end
       
-      # A Cloud Firestore Database. Currently only one database is allowed per cloud
-      # project; this database must have a `database_id` of '(default)'.
+      # A Cloud Firestore Database.
       class GoogleFirestoreAdminV1Database
         include Google::Apis::Core::Hashable
       
@@ -1204,6 +1257,19 @@ module Google
         end
       end
       
+      # Metadata related to the delete database operation.
+      class GoogleFirestoreAdminV1DeleteDatabaseMetadata
+        include Google::Apis::Core::Hashable
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+        end
+      end
+      
       # Metadata for google.longrunning.Operation results from FirestoreAdmin.
       # ExportDocuments.
       class GoogleFirestoreAdminV1ExportDocumentsMetadata
@@ -1977,6 +2043,12 @@ module Google
         # @return [String]
         attr_accessor :operation_state
       
+        # Describes the progress of the operation. Unit of work is generic and must be
+        # interpreted based on where Progress is used.
+        # Corresponds to the JSON property `progressPercentage`
+        # @return [Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress]
+        attr_accessor :progress_percentage
+      
         # The time the restore was started.
         # Corresponds to the JSON property `startTime`
         # @return [String]
@@ -1992,6 +2064,7 @@ module Google
           @database = args[:database] if args.key?(:database)
           @end_time = args[:end_time] if args.key?(:end_time)
           @operation_state = args[:operation_state] if args.key?(:operation_state)
+          @progress_percentage = args[:progress_percentage] if args.key?(:progress_percentage)
           @start_time = args[:start_time] if args.key?(:start_time)
         end
       end
@@ -2210,13 +2283,13 @@ module Google
         # @return [String]
         attr_accessor :name
       
-        # The normal response of the operation in case of success. If the original
-        # method returns no data on success, such as `Delete`, the response is `google.
-        # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
-        # the response should be the resource. For other methods, the response should
-        # have the type `XxxResponse`, where `Xxx` is the original method name. For
-        # example, if the original method name is `TakeSnapshot()`, the inferred
-        # response type is `TakeSnapshotResponse`.
+        # The normal, successful response of the operation. If the original method
+        # returns no data on success, such as `Delete`, the response is `google.protobuf.
+        # Empty`. If the original method is standard `Get`/`Create`/`Update`, the
+        # response should be the resource. For other methods, the response should have
+        # the type `XxxResponse`, where `Xxx` is the original method name. For example,
+        # if the original method name is `TakeSnapshot()`, the inferred response type is
+        # `TakeSnapshotResponse`.
         # Corresponds to the JSON property `response`
         # @return [Hash<String,Object>]
         attr_accessor :response
@@ -3104,6 +3177,37 @@ module Google
         end
       end
       
+      # Sum of the values of the requested field. * Only numeric values will be
+      # aggregated. All non-numeric values including `NULL` are skipped. * If the
+      # aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754
+      # standards. * If the aggregated value set is empty, returns 0. * Returns a 64-
+      # bit integer if all aggregated numbers are integers and the sum result does not
+      # overflow. Otherwise, the result is returned as a double. Note that even if all
+      # the aggregated values are integers, the result is returned as a double if it
+      # cannot fit within a 64-bit signed integer. When this occurs, the returned
+      # value will lose precision. * When underflow occurs, floating-point aggregation
+      # is non-deterministic. This means that running the same query repeatedly
+      # without any changes to the underlying values could produce slightly different
+      # results each time. In those cases, values should be stored as integers over
+      # floating-point numbers.
+      class Sum
+        include Google::Apis::Core::Hashable
+      
+        # A reference to a field in a document, ex: `stats.operations`.
+        # Corresponds to the JSON property `field`
+        # @return [Google::Apis::FirestoreV1::FieldReference]
+        attr_accessor :field
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @field = args[:field] if args.key?(:field)
+        end
+      end
+      
       # A specification of a set of documents to listen to.
       class Target
         include Google::Apis::Core::Hashable
@@ -3146,7 +3250,17 @@ module Google
         attr_accessor :resume_token
       
         # The target ID that identifies the target on the stream. Must be a positive
-        # number and non-zero.
+        # number and non-zero. If `target_id` is 0 (or unspecified), the server will
+        # assign an ID for this target and return that in a `TargetChange::ADD` event.
+        # Once a target with `target_id=0` is added, all subsequent targets must also
+        # have `target_id=0`. If an `AddTarget` request with `target_id != 0` is sent to
+        # the server after a target with `target_id=0` is added, the server will
+        # immediately send a response with a `TargetChange::Remove` event. Note that if
+        # the client sends multiple `AddTarget` requests without an ID, the order of IDs
+        # returned in `TargetChage.target_ids` are undefined. Therefore, clients should
+        # provide a target ID instead of relying on the server to assign one. If `
+        # target_id` is non-zero, there must not be an existing active target on this
+        # stream with the same ID.
         # Corresponds to the JSON property `targetId`
         # @return [Fixnum]
         attr_accessor :target_id

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.49.0"
+      GEM_VERSION = "0.51.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.12.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20230722"
+      REVISION = "20230905"
     end
   end
 end

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

@@ -40,6 +40,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Avg
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class BatchGetDocumentsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -214,6 +220,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1CreateDatabaseMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1DailyRecurrence
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -226,6 +238,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1DeleteDatabaseMetadata
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1ExportDocumentsMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -550,6 +568,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Sum
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Target
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -608,8 +632,12 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :alias, as: 'alias'
+          property :avg, as: 'avg', class: Google::Apis::FirestoreV1::Avg, decorator: Google::Apis::FirestoreV1::Avg::Representation
+      
           property :count, as: 'count', class: Google::Apis::FirestoreV1::Count, decorator: Google::Apis::FirestoreV1::Count::Representation
       
+          property :sum, as: 'sum', class: Google::Apis::FirestoreV1::Sum, decorator: Google::Apis::FirestoreV1::Sum::Representation
+      
         end
       end
       
@@ -629,6 +657,14 @@ module Google
         end
       end
       
+      class Avg
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :field, as: 'field', class: Google::Apis::FirestoreV1::FieldReference, decorator: Google::Apis::FirestoreV1::FieldReference::Representation
+      
+        end
+      end
+      
       class BatchGetDocumentsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -909,6 +945,12 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1CreateDatabaseMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleFirestoreAdminV1DailyRecurrence
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -935,6 +977,12 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1DeleteDatabaseMetadata
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+        end
+      end
+      
       class GoogleFirestoreAdminV1ExportDocumentsMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1142,6 +1190,8 @@ module Google
           property :database, as: 'database'
           property :end_time, as: 'endTime'
           property :operation_state, as: 'operationState'
+          property :progress_percentage, as: 'progressPercentage', class: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1::GoogleFirestoreAdminV1Progress::Representation
+      
           property :start_time, as: 'startTime'
         end
       end
@@ -1466,6 +1516,14 @@ module Google
         end
       end
       
+      class Sum
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :field, as: 'field', class: Google::Apis::FirestoreV1::FieldReference, decorator: Google::Apis::FirestoreV1::FieldReference::Representation
+      
+        end
+      end
+      
       class Target
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -302,7 +302,7 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Create a new database by restore from an existing backup. The new database
+        # Creates a new database by restoring from an existing backup. The new database
         # must be in the same cloud region or multi-region location as the existing
         # backup. This behaves similar to FirestoreAdmin.CreateDatabase except instead
         # of creating a new empty database, a new database is created with the database
@@ -310,9 +310,7 @@ module Google
         # running operation can be used to track the progress of the restore, with the
         # Operation's metadata field type being the RestoreDatabaseMetadata. The
         # response type is the Database if the restore was successful. The new database
-        # is not readable or writeable until the LRO has completed. Cancelling the
-        # returned operation will stop the restore and delete the in-progress database,
-        # if the restore is still active.
+        # is not readable or writeable until the LRO has completed.
         # @param [String] parent
         #   Required. The project to restore the database in. Format is `projects/`
         #   project_id``.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1
 version: !ruby/object:Gem::Version
-  version: 0.49.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-06 00:00:00.000000000 Z
+date: 2023-09-17 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.49.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1/v0.51.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.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Firestore API V1