google-apis-datastore_v1 0.36.0 → 0.37.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5776c7c9788e1a0f7454ef6f724f76cdcc17f1313c88a83b157b9e243a34326
-  data.tar.gz: ace731423800b106d833982bd8e83dcf3cd7bfdb9a0f69bcec5a13d4c306a753
+  metadata.gz: 3c07043cc9f904f59fb22d7ffcd7aaf45263282db0a248745da43eb9b7c7825b
+  data.tar.gz: cafd8e29e105379561e0e5d30d2871a945e41674a29bcfeb1b8b0d85142a8d86
 SHA512:
-  metadata.gz: 8a0cecb4ad8ad8ec687a0df63d95943fad7af7e94bf8cca0a0709cf0a5287a326699bcfa70c60ce5fa3c3bd0d20f14065ef4638993e5f99fea593a88418a4e94
-  data.tar.gz: 47a6512a67a46894d5906a27eb393be21f447d29cbde303f6b7c828a2ae107ec10821ddbe388a527942689584530e908060c425e0775c33f010a5b1ec3d2b33f
+  metadata.gz: 7b972004199f31fc1e51e0391083a9a733164d142887db6c6fd628c6c4ada8de475beacbb43876f20d625e3a5838567f464cfa60c8256c8e1ee319003eb1ce9e
+  data.tar.gz: 24889dd35b04a98256154d513277af5bf271dc553f3f70e011a146970b1ad5352e8cb444efd52ddb244680b1783eecb9f91662367d56bb5def175692d74d1a72

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-datastore_v1
 
+### v0.37.0 (2024-03-24)
+
+* Regenerated from discovery document revision 20240317
+* Regenerated using generator version 0.14.0
+
 ### v0.36.0 (2024-02-23)
 
 * Regenerated from discovery document revision 20240215

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

@@ -539,6 +539,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::DatastoreV1::ExecutionStats]
+        attr_accessor :execution_stats
+      
+        # Planning phase information for the query.
+        # Corresponds to the JSON property `planSummary`
+        # @return [Google::Apis::DatastoreV1::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
@@ -1652,6 +1742,12 @@ module Google
         # @return [Array<Google::Apis::DatastoreV1::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::DatastoreV1::PropertyMask]
+        attr_accessor :property_mask
+      
         # The options shared by read requests.
         # Corresponds to the JSON property `readOptions`
         # @return [Google::Apis::DatastoreV1::ReadOptions]
@@ -1665,6 +1761,7 @@ module Google
         def update!(**args)
           @database_id = args[:database_id] if args.key?(:database_id)
           @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
@@ -1742,6 +1839,12 @@ module Google
         # @return [Google::Apis::DatastoreV1::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::DatastoreV1::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::DatastoreV1::Entity]
@@ -1767,6 +1870,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)
@@ -1906,6 +2010,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
@@ -1957,6 +2082,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
@@ -2339,6 +2489,11 @@ module Google
         # @return [String]
         attr_accessor :database_id
       
+        # Explain options for the query.
+        # Corresponds to the JSON property `explainOptions`
+        # @return [Google::Apis::DatastoreV1::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::DatastoreV1::GqlQuery]
@@ -2371,6 +2526,7 @@ module Google
         def update!(**args)
           @aggregation_query = args[:aggregation_query] if args.key?(:aggregation_query)
           @database_id = args[:database_id] if args.key?(:database_id)
+          @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)
@@ -2386,6 +2542,11 @@ module Google
         # @return [Google::Apis::DatastoreV1::AggregationResultBatch]
         attr_accessor :batch
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::DatastoreV1::ExplainMetrics]
+        attr_accessor :explain_metrics
+      
         # Datastore query for running an aggregation over a Query.
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::AggregationQuery]
@@ -2406,6 +2567,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)
           @transaction = args[:transaction] if args.key?(:transaction)
         end
@@ -2421,6 +2583,11 @@ module Google
         # @return [String]
         attr_accessor :database_id
       
+        # Explain options for the query.
+        # Corresponds to the JSON property `explainOptions`
+        # @return [Google::Apis::DatastoreV1::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::DatastoreV1::GqlQuery]
@@ -2440,6 +2607,12 @@ module Google
         # @return [Google::Apis::DatastoreV1::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::DatastoreV1::PropertyMask]
+        attr_accessor :property_mask
+      
         # A query for entities.
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::Query]
@@ -2457,8 +2630,10 @@ module Google
         # Update properties of this object
         def update!(**args)
           @database_id = args[:database_id] if args.key?(:database_id)
+          @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
@@ -2473,6 +2648,11 @@ module Google
         # @return [Google::Apis::DatastoreV1::QueryResultBatch]
         attr_accessor :batch
       
+        # Explain metrics for the query.
+        # Corresponds to the JSON property `explainMetrics`
+        # @return [Google::Apis::DatastoreV1::ExplainMetrics]
+        attr_accessor :explain_metrics
+      
         # A query for entities.
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::Query]
@@ -2493,6 +2673,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)
           @transaction = args[:transaction] if args.key?(:transaction)
         end

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

@@ -16,13 +16,13 @@ module Google
   module Apis
     module DatastoreV1
       # Version of the google-apis-datastore_v1 gem
-      GEM_VERSION = "0.36.0"
+      GEM_VERSION = "0.37.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.13.1"
+      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_v1/representations.rb

@@ -124,6 +124,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
       
@@ -346,6 +364,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
       
@@ -358,6 +382,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
       
@@ -629,6 +659,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::DatastoreV1::ExecutionStats, decorator: Google::Apis::DatastoreV1::ExecutionStats::Representation
+      
+          property :plan_summary, as: 'planSummary', class: Google::Apis::DatastoreV1::PlanSummary, decorator: Google::Apis::DatastoreV1::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
@@ -941,6 +998,8 @@ module Google
           property :database_id, as: 'databaseId'
           collection :keys, as: 'keys', class: Google::Apis::DatastoreV1::Key, decorator: Google::Apis::DatastoreV1::Key::Representation
       
+          property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1::PropertyMask, decorator: Google::Apis::DatastoreV1::PropertyMask::Representation
+      
           property :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1::ReadOptions, decorator: Google::Apis::DatastoreV1::ReadOptions::Representation
       
         end
@@ -968,6 +1027,8 @@ module Google
       
           property :insert, as: 'insert', class: Google::Apis::DatastoreV1::Entity, decorator: Google::Apis::DatastoreV1::Entity::Representation
       
+          property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1::PropertyMask, decorator: Google::Apis::DatastoreV1::PropertyMask::Representation
+      
           property :update, as: 'update', class: Google::Apis::DatastoreV1::Entity, decorator: Google::Apis::DatastoreV1::Entity::Representation
       
           property :update_time, as: 'updateTime'
@@ -1006,6 +1067,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
@@ -1025,6 +1093,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
@@ -1136,6 +1211,8 @@ module Google
           property :aggregation_query, as: 'aggregationQuery', class: Google::Apis::DatastoreV1::AggregationQuery, decorator: Google::Apis::DatastoreV1::AggregationQuery::Representation
       
           property :database_id, as: 'databaseId'
+          property :explain_options, as: 'explainOptions', class: Google::Apis::DatastoreV1::ExplainOptions, decorator: Google::Apis::DatastoreV1::ExplainOptions::Representation
+      
           property :gql_query, as: 'gqlQuery', class: Google::Apis::DatastoreV1::GqlQuery, decorator: Google::Apis::DatastoreV1::GqlQuery::Representation
       
           property :partition_id, as: 'partitionId', class: Google::Apis::DatastoreV1::PartitionId, decorator: Google::Apis::DatastoreV1::PartitionId::Representation
@@ -1150,6 +1227,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :batch, as: 'batch', class: Google::Apis::DatastoreV1::AggregationResultBatch, decorator: Google::Apis::DatastoreV1::AggregationResultBatch::Representation
       
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::DatastoreV1::ExplainMetrics, decorator: Google::Apis::DatastoreV1::ExplainMetrics::Representation
+      
           property :query, as: 'query', class: Google::Apis::DatastoreV1::AggregationQuery, decorator: Google::Apis::DatastoreV1::AggregationQuery::Representation
       
           property :transaction, :base64 => true, as: 'transaction'
@@ -1160,10 +1239,14 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :database_id, as: 'databaseId'
+          property :explain_options, as: 'explainOptions', class: Google::Apis::DatastoreV1::ExplainOptions, decorator: Google::Apis::DatastoreV1::ExplainOptions::Representation
+      
           property :gql_query, as: 'gqlQuery', class: Google::Apis::DatastoreV1::GqlQuery, decorator: Google::Apis::DatastoreV1::GqlQuery::Representation
       
           property :partition_id, as: 'partitionId', class: Google::Apis::DatastoreV1::PartitionId, decorator: Google::Apis::DatastoreV1::PartitionId::Representation
       
+          property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1::PropertyMask, decorator: Google::Apis::DatastoreV1::PropertyMask::Representation
+      
           property :query, as: 'query', class: Google::Apis::DatastoreV1::Query, decorator: Google::Apis::DatastoreV1::Query::Representation
       
           property :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1::ReadOptions, decorator: Google::Apis::DatastoreV1::ReadOptions::Representation
@@ -1176,6 +1259,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :batch, as: 'batch', class: Google::Apis::DatastoreV1::QueryResultBatch, decorator: Google::Apis::DatastoreV1::QueryResultBatch::Representation
       
+          property :explain_metrics, as: 'explainMetrics', class: Google::Apis::DatastoreV1::ExplainMetrics, decorator: Google::Apis::DatastoreV1::ExplainMetrics::Representation
+      
           property :query, as: 'query', class: Google::Apis::DatastoreV1::Query, decorator: Google::Apis::DatastoreV1::Query::Representation
       
           property :transaction, :base64 => true, as: 'transaction'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-datastore_v1
 version: !ruby/object:Gem::Version
-  version: 0.36.0
+  version: 0.37.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_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.36.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.37.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datastore_v1
 post_install_message: 
 rdoc_options: []