google-apis-datastore_v1beta3 0.31.0 → 0.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1206907b1cb8e762b8e33ece6c3ad37d51ec9674d60423786e330e5179730a63
-  data.tar.gz: f533fb244658025789cd225c0b42d04083bce29d00e6422a77fb6003be4110c9
+  metadata.gz: 80a68b9a779c7753e6a5a9669ccbd9308e959554f1768593d190804cbeacb0a5
+  data.tar.gz: 2289e26e7a31bad715ae0c5ca9928f58d1327f4284a2ac78cb982df4792af06a
 SHA512:
-  metadata.gz: f2143d0c709b759c89826ccab9dfa9d42e753ee84b22d64429efcee8eb499aaa05912035f81af289c5d841c6e0b7e239b29c45004bf393d9633462623f91c4a9
-  data.tar.gz: c7e129055c3171864641b6fffee6962ef5fb097d2bd92c626ece77b294a3c042bc5b48241ebe5d2235b3651b8532948684fb42a47ea9d76bfbc5186fc2b2310c
+  metadata.gz: 4008b5aa4e15cbc96ab1b5e6f8b71e5e6d14b5b5bf28a3693d0ec03e8613a73d60498b2c1df9a7860cdbe25fffc278a24d003807f8d3ef28a75cc95530820e73
+  data.tar.gz: 87c0634b4f8b13c023a0a265fdd2a1e97e2fa5aa216e1312e6d769831b357c126c6b7a1e374ae8d0e473f4f8f7df0abbdc16352975a38bc74fa8a43a21c9a82a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Release history for google-apis-datastore_v1beta3
 
+### v0.32.0 (2024-03-24)
+
+* Regenerated from discovery document revision 20240317
+
 ### v0.31.0 (2024-02-23)
 
 * Regenerated from discovery document revision 20240215

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

@@ -494,6 +494,96 @@ module Google
         end
       end
       
+      # Execution statistics for the query.
+      class ExecutionStats
+        include Google::Apis::Core::Hashable
+      
+        # Debugging statistics from the execution of the query. Note that the debugging
+        # stats are subject to change as Firestore evolves. It could include: ` "
+        # indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details"
+        # : ` "documents_billable": "20", "index_entries_billable": "1000", "
+        # min_query_cost": "0" ` `
+        # Corresponds to the JSON property `debugStats`
+        # @return [Hash<String,Object>]
+        attr_accessor :debug_stats
+      
+        # Total time to execute the query in the backend.
+        # Corresponds to the JSON property `executionDuration`
+        # @return [String]
+        attr_accessor :execution_duration
+      
+        # Total billable read operations.
+        # Corresponds to the JSON property `readOperations`
+        # @return [Fixnum]
+        attr_accessor :read_operations
+      
+        # Total number of results returned, including documents, projections,
+        # aggregation results, keys.
+        # Corresponds to the JSON property `resultsReturned`
+        # @return [Fixnum]
+        attr_accessor :results_returned
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @debug_stats = args[:debug_stats] if args.key?(:debug_stats)
+          @execution_duration = args[:execution_duration] if args.key?(:execution_duration)
+          @read_operations = args[:read_operations] if args.key?(:read_operations)
+          @results_returned = args[:results_returned] if args.key?(:results_returned)
+        end
+      end
+      
+      # Explain metrics for the query.
+      class ExplainMetrics
+        include Google::Apis::Core::Hashable
+      
+        # Execution statistics for the query.
+        # Corresponds to the JSON property `executionStats`
+        # @return [Google::Apis::DatastoreV1beta3::ExecutionStats]
+        attr_accessor :execution_stats
+      
+        # Planning phase information for the query.
+        # Corresponds to the JSON property `planSummary`
+        # @return [Google::Apis::DatastoreV1beta3::PlanSummary]
+        attr_accessor :plan_summary
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @execution_stats = args[:execution_stats] if args.key?(:execution_stats)
+          @plan_summary = args[:plan_summary] if args.key?(:plan_summary)
+        end
+      end
+      
+      # Explain options for the query.
+      class ExplainOptions
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Whether to execute this query. When false (the default), the query
+        # will be planned, returning only metrics from the planning stages. When true,
+        # the query will be planned and executed, returning the full query results along
+        # with both planning and execution stage metrics.
+        # Corresponds to the JSON property `analyze`
+        # @return [Boolean]
+        attr_accessor :analyze
+        alias_method :analyze?, :analyze
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @analyze = args[:analyze] if args.key?(:analyze)
+        end
+      end
+      
       # A holder for any type of filter.
       class Filter
         include Google::Apis::Core::Hashable
@@ -1317,6 +1407,12 @@ module Google
         # @return [Array<Google::Apis::DatastoreV1beta3::Key>]
         attr_accessor :keys
       
+        # The set of arbitrarily nested property paths used to restrict an operation to
+        # only a subset of properties in an entity.
+        # Corresponds to the JSON property `propertyMask`
+        # @return [Google::Apis::DatastoreV1beta3::PropertyMask]
+        attr_accessor :property_mask
+      
         # The options shared by read requests.
         # Corresponds to the JSON property `readOptions`
         # @return [Google::Apis::DatastoreV1beta3::ReadOptions]
@@ -1329,6 +1425,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @keys = args[:keys] if args.key?(:keys)
+          @property_mask = args[:property_mask] if args.key?(:property_mask)
           @read_options = args[:read_options] if args.key?(:read_options)
         end
       end
@@ -1397,6 +1494,12 @@ module Google
         # @return [Google::Apis::DatastoreV1beta3::Entity]
         attr_accessor :insert
       
+        # The set of arbitrarily nested property paths used to restrict an operation to
+        # only a subset of properties in an entity.
+        # Corresponds to the JSON property `propertyMask`
+        # @return [Google::Apis::DatastoreV1beta3::PropertyMask]
+        attr_accessor :property_mask
+      
         # A Datastore data object. Must not exceed 1 MiB - 4 bytes.
         # Corresponds to the JSON property `update`
         # @return [Google::Apis::DatastoreV1beta3::Entity]
@@ -1422,6 +1525,7 @@ module Google
           @base_version = args[:base_version] if args.key?(:base_version)
           @delete = args[:delete] if args.key?(:delete)
           @insert = args[:insert] if args.key?(:insert)
+          @property_mask = args[:property_mask] if args.key?(:property_mask)
           @update = args[:update] if args.key?(:update)
           @update_time = args[:update_time] if args.key?(:update_time)
           @upsert = args[:upsert] if args.key?(:upsert)
@@ -1555,6 +1659,27 @@ module Google
         end
       end
       
+      # Planning phase information for the query.
+      class PlanSummary
+        include Google::Apis::Core::Hashable
+      
+        # The indexes selected for the query. For example: [ `"query_scope": "Collection"
+        # , "properties": "(foo ASC, __name__ ASC)"`, `"query_scope": "Collection", "
+        # properties": "(bar ASC, __name__ ASC)"` ]
+        # Corresponds to the JSON property `indexesUsed`
+        # @return [Array<Hash<String,Object>>]
+        attr_accessor :indexes_used
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @indexes_used = args[:indexes_used] if args.key?(:indexes_used)
+        end
+      end
+      
       # A representation of a property in a projection.
       class Projection
         include Google::Apis::Core::Hashable
@@ -1606,6 +1731,31 @@ module Google
         end
       end
       
+      # The set of arbitrarily nested property paths used to restrict an operation to
+      # only a subset of properties in an entity.
+      class PropertyMask
+        include Google::Apis::Core::Hashable
+      
+        # The paths to the properties covered by this mask. A path is a list of property
+        # names separated by dots (`.`), for example `foo.bar` means the property `bar`
+        # inside the entity property `foo` inside the entity associated with this path.
+        # If a property name contains a dot `.` or a backslash `\`, then that name must
+        # be escaped. A path must not be empty, and may not reference a value inside an
+        # array value.
+        # Corresponds to the JSON property `paths`
+        # @return [Array<String>]
+        attr_accessor :paths
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @paths = args[:paths] if args.key?(:paths)
+        end
+      end
+      
       # The desired order for a specific property.
       class PropertyOrder
         include Google::Apis::Core::Hashable
@@ -1967,6 +2117,11 @@ module Google
         # @return [Google::Apis::DatastoreV1beta3::AggregationQuery]
         attr_accessor :aggregation_query
       
+        # Explain options for the query.
+        # Corresponds to the JSON property `explainOptions`
+        # @return [Google::Apis::DatastoreV1beta3::ExplainOptions]
+        attr_accessor :explain_options
+      
         # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
         # Corresponds to the JSON property `gqlQuery`
         # @return [Google::Apis::DatastoreV1beta3::GqlQuery]
@@ -1998,6 +2153,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @aggregation_query = args[:aggregation_query] if args.key?(:aggregation_query)
+          @explain_options = args[:explain_options] if args.key?(:explain_options)
           @gql_query = args[:gql_query] if args.key?(:gql_query)
           @partition_id = args[:partition_id] if args.key?(:partition_id)
           @read_options = args[:read_options] if args.key?(:read_options)
@@ -2013,6 +2169,11 @@ module Google
         # @return [Google::Apis::DatastoreV1beta3::AggregationResultBatch]
         attr_accessor :batch
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::DatastoreV1beta3::ExplainMetrics]
+        attr_accessor :explain_metrics
+      
         # Datastore query for running an aggregation over a Query.
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1beta3::AggregationQuery]
@@ -2025,6 +2186,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @batch = args[:batch] if args.key?(:batch)
+          @explain_metrics = args[:explain_metrics] if args.key?(:explain_metrics)
           @query = args[:query] if args.key?(:query)
         end
       end
@@ -2033,6 +2195,11 @@ module Google
       class RunQueryRequest
         include Google::Apis::Core::Hashable
       
+        # Explain options for the query.
+        # Corresponds to the JSON property `explainOptions`
+        # @return [Google::Apis::DatastoreV1beta3::ExplainOptions]
+        attr_accessor :explain_options
+      
         # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
         # Corresponds to the JSON property `gqlQuery`
         # @return [Google::Apis::DatastoreV1beta3::GqlQuery]
@@ -2052,6 +2219,12 @@ module Google
         # @return [Google::Apis::DatastoreV1beta3::PartitionId]
         attr_accessor :partition_id
       
+        # The set of arbitrarily nested property paths used to restrict an operation to
+        # only a subset of properties in an entity.
+        # Corresponds to the JSON property `propertyMask`
+        # @return [Google::Apis::DatastoreV1beta3::PropertyMask]
+        attr_accessor :property_mask
+      
         # A query for entities.
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1beta3::Query]
@@ -2068,8 +2241,10 @@ module Google
       
         # Update properties of this object
         def update!(**args)
+          @explain_options = args[:explain_options] if args.key?(:explain_options)
           @gql_query = args[:gql_query] if args.key?(:gql_query)
           @partition_id = args[:partition_id] if args.key?(:partition_id)
+          @property_mask = args[:property_mask] if args.key?(:property_mask)
           @query = args[:query] if args.key?(:query)
           @read_options = args[:read_options] if args.key?(:read_options)
         end
@@ -2084,6 +2259,11 @@ module Google
         # @return [Google::Apis::DatastoreV1beta3::QueryResultBatch]
         attr_accessor :batch
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::DatastoreV1beta3::ExplainMetrics]
+        attr_accessor :explain_metrics
+      
         # A query for entities.
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1beta3::Query]
@@ -2096,6 +2276,7 @@ module Google
         # Update properties of this object
         def update!(**args)
           @batch = args[:batch] if args.key?(:batch)
+          @explain_metrics = args[:explain_metrics] if args.key?(:explain_metrics)
           @query = args[:query] if args.key?(:query)
         end
       end

data/lib/google/apis/datastore_v1beta3/gem_version.rb

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DatastoreV1beta3
       # Version of the google-apis-datastore_v1beta3 gem
-      GEM_VERSION = "0.31.0"
+      GEM_VERSION = "0.32.0"
 
       # Version of the code generator used to generate this client
       GENERATOR_VERSION = "0.14.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240215"
+      REVISION = "20240317"
     end
   end
 end

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

@@ -118,6 +118,24 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class ExecutionStats
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ExplainMetrics
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class ExplainOptions
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Filter
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -298,6 +316,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PlanSummary
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Projection
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -310,6 +334,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PropertyMask
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class PropertyOrder
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -564,6 +594,33 @@ module Google
         end
       end
       
+      class ExecutionStats
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :debug_stats, as: 'debugStats'
+          property :execution_duration, as: 'executionDuration'
+          property :read_operations, :numeric_string => true, as: 'readOperations'
+          property :results_returned, :numeric_string => true, as: 'resultsReturned'
+        end
+      end
+      
+      class ExplainMetrics
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :execution_stats, as: 'executionStats', class: Google::Apis::DatastoreV1beta3::ExecutionStats, decorator: Google::Apis::DatastoreV1beta3::ExecutionStats::Representation
+      
+          property :plan_summary, as: 'planSummary', class: Google::Apis::DatastoreV1beta3::PlanSummary, decorator: Google::Apis::DatastoreV1beta3::PlanSummary::Representation
+      
+        end
+      end
+      
+      class ExplainOptions
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :analyze, as: 'analyze'
+        end
+      end
+      
       class Filter
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -804,6 +861,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           collection :keys, as: 'keys', class: Google::Apis::DatastoreV1beta3::Key, decorator: Google::Apis::DatastoreV1beta3::Key::Representation
       
+          property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1beta3::PropertyMask, decorator: Google::Apis::DatastoreV1beta3::PropertyMask::Representation
+      
           property :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1beta3::ReadOptions, decorator: Google::Apis::DatastoreV1beta3::ReadOptions::Representation
       
         end
@@ -830,6 +889,8 @@ module Google
       
           property :insert, as: 'insert', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation
       
+          property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1beta3::PropertyMask, decorator: Google::Apis::DatastoreV1beta3::PropertyMask::Representation
+      
           property :update, as: 'update', class: Google::Apis::DatastoreV1beta3::Entity, decorator: Google::Apis::DatastoreV1beta3::Entity::Representation
       
           property :update_time, as: 'updateTime'
@@ -867,6 +928,13 @@ module Google
         end
       end
       
+      class PlanSummary
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :indexes_used, as: 'indexesUsed'
+        end
+      end
+      
       class Projection
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -886,6 +954,13 @@ module Google
         end
       end
       
+      class PropertyMask
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :paths, as: 'paths'
+        end
+      end
+      
       class PropertyOrder
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -993,6 +1068,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :aggregation_query, as: 'aggregationQuery', class: Google::Apis::DatastoreV1beta3::AggregationQuery, decorator: Google::Apis::DatastoreV1beta3::AggregationQuery::Representation
       
+          property :explain_options, as: 'explainOptions', class: Google::Apis::DatastoreV1beta3::ExplainOptions, decorator: Google::Apis::DatastoreV1beta3::ExplainOptions::Representation
+      
           property :gql_query, as: 'gqlQuery', class: Google::Apis::DatastoreV1beta3::GqlQuery, decorator: Google::Apis::DatastoreV1beta3::GqlQuery::Representation
       
           property :partition_id, as: 'partitionId', class: Google::Apis::DatastoreV1beta3::PartitionId, decorator: Google::Apis::DatastoreV1beta3::PartitionId::Representation
@@ -1007,6 +1084,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :batch, as: 'batch', class: Google::Apis::DatastoreV1beta3::AggregationResultBatch, decorator: Google::Apis::DatastoreV1beta3::AggregationResultBatch::Representation
       
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::DatastoreV1beta3::ExplainMetrics, decorator: Google::Apis::DatastoreV1beta3::ExplainMetrics::Representation
+      
           property :query, as: 'query', class: Google::Apis::DatastoreV1beta3::AggregationQuery, decorator: Google::Apis::DatastoreV1beta3::AggregationQuery::Representation
       
         end
@@ -1015,10 +1094,14 @@ module Google
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :explain_options, as: 'explainOptions', class: Google::Apis::DatastoreV1beta3::ExplainOptions, decorator: Google::Apis::DatastoreV1beta3::ExplainOptions::Representation
+      
           property :gql_query, as: 'gqlQuery', class: Google::Apis::DatastoreV1beta3::GqlQuery, decorator: Google::Apis::DatastoreV1beta3::GqlQuery::Representation
       
           property :partition_id, as: 'partitionId', class: Google::Apis::DatastoreV1beta3::PartitionId, decorator: Google::Apis::DatastoreV1beta3::PartitionId::Representation
       
+          property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1beta3::PropertyMask, decorator: Google::Apis::DatastoreV1beta3::PropertyMask::Representation
+      
           property :query, as: 'query', class: Google::Apis::DatastoreV1beta3::Query, decorator: Google::Apis::DatastoreV1beta3::Query::Representation
       
           property :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1beta3::ReadOptions, decorator: Google::Apis::DatastoreV1beta3::ReadOptions::Representation
@@ -1031,6 +1114,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :batch, as: 'batch', class: Google::Apis::DatastoreV1beta3::QueryResultBatch, decorator: Google::Apis::DatastoreV1beta3::QueryResultBatch::Representation
       
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::DatastoreV1beta3::ExplainMetrics, decorator: Google::Apis::DatastoreV1beta3::ExplainMetrics::Representation
+      
           property :query, as: 'query', class: Google::Apis::DatastoreV1beta3::Query, decorator: Google::Apis::DatastoreV1beta3::Query::Representation
       
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-datastore_v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.31.0
+  version: 0.32.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2024-03-24 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-datastore_v1beta3/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1beta3/v0.31.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1beta3/v0.32.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datastore_v1beta3
 post_install_message: 
 rdoc_options: []