google-apis-firestore_v1beta1 0.29.0 → 0.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc4c4e013da5c7cb5cf24776f3ee291edf189ec082b06172992d521fcafc9b52
-  data.tar.gz: 19b39132dc9f4a0665771bc21e3718359bb9f25833478d25eda8de0e05074333
+  metadata.gz: dcacca90d087af63291d5060dddfd7a8a13daeac36edee54ad07d702d837af7e
+  data.tar.gz: b0a968d6398b25ac389b53c75f688142d6c1927f62ff7edb5f6cefc8aea8e575
 SHA512:
-  metadata.gz: 5f9393db1a195b540e333a45ee45aa3904ff2e127871a12a815e6b554603da23f801623763920f4d04fa0a720f530f2c9138087563cca52dc3a0daebce6df3ed
-  data.tar.gz: d73708c8cb653c9aa54938b4bb688c796b43332c65b11e77386a52cd9df6af49b49e78b486e820e54e390eaae93c8116ae2f5d08ef03212b623d801dd7e8dbdc
+  metadata.gz: 6f878beb243741d59f031852800e03fda0e5dbec3793d9aa06e59d82987a11e7f82918c8cb854b60aa860368c5e23b6738f490ad7356c3a1206404f08ffc155c
+  data.tar.gz: 9b99e3d036f996a8c2ea2c5312071546972796988a85c9fe332a1b3cdbd5c1ed7c16823bfc0ed3d102573b9454237f6afb1f8763996f9ea812aefecc9bdffab5

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Release history for google-apis-firestore_v1beta1
 
+### v0.31.0 (2023-08-06)
+
+* Regenerated from discovery document revision 20230729
+
+### v0.30.0 (2023-07-23)
+
+* Regenerated from discovery document revision 20230716
+
 ### v0.29.0 (2023-07-02)
 
 * Regenerated from discovery document revision 20230621

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

@@ -38,12 +38,36 @@ 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`. * 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::FirestoreV1beta1::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::FirestoreV1beta1::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`. * If the aggregated value set
+        # is empty, returns 0. * Returns a 64-bit integer if the sum result is an
+        # integer value and 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::FirestoreV1beta1::Sum]
+        attr_accessor :sum
+      
         def initialize(**args)
            update!(**args)
         end
@@ -51,7 +75,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 +123,28 @@ 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`. * 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::FirestoreV1beta1::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
@@ -122,8 +170,9 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
         attr_accessor :new_transaction
       
-        # Reads documents as they were at the given time. This may not be older than 270
-        # seconds.
+        # Reads documents as they were at the given time. This must be a microsecond
+        # precision timestamp within the past one hour, or if Point-in-Time Recovery is
+        # enabled, can additionally be a whole minute timestamp within the past 7 days.
         # Corresponds to the JSON property `readTime`
         # @return [String]
         attr_accessor :read_time
@@ -780,7 +829,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
@@ -951,6 +1002,32 @@ module Google
         end
       end
       
+      # Describes the progress of the operation. Unit of work is generic and must be
+      # interpreted based on where Progress is used.
+      class GoogleFirestoreAdminV1Progress
+        include Google::Apis::Core::Hashable
+      
+        # The amount of work completed.
+        # Corresponds to the JSON property `completedWork`
+        # @return [Fixnum]
+        attr_accessor :completed_work
+      
+        # The amount of work estimated.
+        # Corresponds to the JSON property `estimatedWork`
+        # @return [Fixnum]
+        attr_accessor :estimated_work
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @completed_work = args[:completed_work] if args.key?(:completed_work)
+          @estimated_work = args[:estimated_work] if args.key?(:estimated_work)
+        end
+      end
+      
       # Metadata for the long-running operation from the RestoreDatabase request.
       class GoogleFirestoreAdminV1RestoreDatabaseMetadata
         include Google::Apis::Core::Hashable
@@ -975,6 +1052,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::FirestoreV1beta1::GoogleFirestoreAdminV1Progress]
+        attr_accessor :progress_percentage
+      
         # The time the restore was started.
         # Corresponds to the JSON property `startTime`
         # @return [String]
@@ -990,6 +1073,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
@@ -1488,8 +1572,9 @@ 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.
+        # Reads documents as they were at the given time. This must be a microsecond
+        # precision timestamp within the past one hour, or if Point-in-Time Recovery is
+        # enabled, can additionally be a whole minute timestamp within the past 7 days.
         # Corresponds to the JSON property `readTime`
         # @return [String]
         attr_accessor :read_time
@@ -1724,8 +1809,9 @@ 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.
+        # Reads documents as they were at the given time. This must be a microsecond
+        # precision timestamp within the past one hour, or if Point-in-Time Recovery is
+        # enabled, can additionally be a whole minute timestamp within the past 7 days.
         # Corresponds to the JSON property `readTime`
         # @return [String]
         attr_accessor :read_time
@@ -1865,7 +1951,9 @@ module Google
       class ReadOnly
         include Google::Apis::Core::Hashable
       
-        # Reads documents at the given time. This may not be older than 60 seconds.
+        # Reads documents at the given time. This must be a microsecond precision
+        # timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
+        # can additionally be a whole minute timestamp within the past 7 days.
         # Corresponds to the JSON property `readTime`
         # @return [String]
         attr_accessor :read_time
@@ -1931,8 +2019,9 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
         attr_accessor :new_transaction
       
-        # Executes the query at the given timestamp. Requires: * Cannot be more than 270
-        # seconds in the past.
+        # Executes the query at the given timestamp. This must be a microsecond
+        # precision timestamp within the past one hour, or if Point-in-Time Recovery is
+        # enabled, can additionally be a whole minute timestamp within the past 7 days.
         # Corresponds to the JSON property `readTime`
         # @return [String]
         attr_accessor :read_time
@@ -2010,8 +2099,9 @@ module Google
         # @return [Google::Apis::FirestoreV1beta1::TransactionOptions]
         attr_accessor :new_transaction
       
-        # Reads documents as they were at the given time. This may not be older than 270
-        # seconds.
+        # Reads documents as they were at the given time. This must be a microsecond
+        # precision timestamp within the past one hour, or if Point-in-Time Recovery is
+        # enabled, can additionally be a whole minute timestamp within the past 7 days.
         # Corresponds to the JSON property `readTime`
         # @return [String]
         attr_accessor :read_time
@@ -2237,6 +2327,36 @@ 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`. * If the aggregated value set
+      # is empty, returns 0. * Returns a 64-bit integer if the sum result is an
+      # integer value and 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::FirestoreV1beta1::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

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.29.0"
+      GEM_VERSION = "0.31.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 = "20230621"
+      REVISION = "20230729"
     end
   end
 end

data/lib/google/apis/firestore_v1beta1/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
       
@@ -202,6 +208,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class GoogleFirestoreAdminV1Progress
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleFirestoreAdminV1RestoreDatabaseMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -424,6 +436,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
       
@@ -482,8 +500,12 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :alias, as: 'alias'
+          property :avg, as: 'avg', class: Google::Apis::FirestoreV1beta1::Avg, decorator: Google::Apis::FirestoreV1beta1::Avg::Representation
+      
           property :count, as: 'count', class: Google::Apis::FirestoreV1beta1::Count, decorator: Google::Apis::FirestoreV1beta1::Count::Representation
       
+          property :sum, as: 'sum', class: Google::Apis::FirestoreV1beta1::Sum, decorator: Google::Apis::FirestoreV1beta1::Sum::Representation
+      
         end
       end
       
@@ -503,6 +525,14 @@ module Google
         end
       end
       
+      class Avg
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :field, as: 'field', class: Google::Apis::FirestoreV1beta1::FieldReference, decorator: Google::Apis::FirestoreV1beta1::FieldReference::Representation
+      
+        end
+      end
+      
       class BatchGetDocumentsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -755,6 +785,14 @@ module Google
         end
       end
       
+      class GoogleFirestoreAdminV1Progress
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :completed_work, :numeric_string => true, as: 'completedWork'
+          property :estimated_work, :numeric_string => true, as: 'estimatedWork'
+        end
+      end
+      
       class GoogleFirestoreAdminV1RestoreDatabaseMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -762,6 +800,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::FirestoreV1beta1::GoogleFirestoreAdminV1Progress, decorator: Google::Apis::FirestoreV1beta1::GoogleFirestoreAdminV1Progress::Representation
+      
           property :start_time, as: 'startTime'
         end
       end
@@ -1121,6 +1161,14 @@ module Google
         end
       end
       
+      class Sum
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :field, as: 'field', class: Google::Apis::FirestoreV1beta1::FieldReference, decorator: Google::Apis::FirestoreV1beta1::FieldReference::Representation
+      
+        end
+      end
+      
       class Target
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -363,8 +363,10 @@ module Google
         #   The list of field paths in the mask. See Document.fields for a field path
         #   syntax reference.
         # @param [String] read_time
-        #   Reads the version of the document at the given time. This may not be older
-        #   than 270 seconds.
+        #   Reads the version of the document at the given time. This must be a
+        #   microsecond precision timestamp within the past one hour, or if Point-in-Time
+        #   Recovery is enabled, can additionally be a whole minute timestamp within the
+        #   past 7 days.
         # @param [String] transaction
         #   Reads the document in a transaction.
         # @param [String] fields
@@ -425,7 +427,9 @@ module Google
         #   parameters (with the exception of `page_size`) must match the values set in
         #   the request that generated the page token.
         # @param [String] read_time
-        #   Perform the read at the provided time. This may not be older than 270 seconds.
+        #   Perform the read at the provided time. This must be a microsecond precision
+        #   timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
+        #   can additionally be a whole minute timestamp within the past 7 days.
         # @param [Boolean] show_missing
         #   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
@@ -532,7 +536,9 @@ module Google
         #   parameters (with the exception of `page_size`) must match the values set in
         #   the request that generated the page token.
         # @param [String] read_time
-        #   Perform the read at the provided time. This may not be older than 270 seconds.
+        #   Perform the read at the provided time. This must be a microsecond precision
+        #   timestamp within the past one hour, or if Point-in-Time Recovery is enabled,
+        #   can additionally be a whole minute timestamp within the past 7 days.
         # @param [Boolean] show_missing
         #   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-firestore_v1beta1
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.31.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2023-08-06 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.29.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-firestore_v1beta1/v0.31.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-firestore_v1beta1
 post_install_message: 
 rdoc_options: []