google-cloud-datastore-v1 0.13.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85c9f1870c8ed556eaaee25c73e83d25284579662823efe527a790da897dc777
-  data.tar.gz: 2588e394d89679f2f4ff9ee540d1c2a88a6cad2c802d585864b46cbe678ddaad
+  metadata.gz: 89c10d23af1fd883f4448dc1d3cc08f8061cbd8427bdb9e8a1e10e697b65f275
+  data.tar.gz: 5b18f2e0631eed54021cd29707cf047b6fade1fdc40f964ffd2a2e58520bc68a
 SHA512:
-  metadata.gz: cd33657286f053d5f45247c8a482e7ccaafc5d0cf5baa43a3400eb45e3f368453ddcdace02121434d437868b5c7bf0b84f54a0d85beae2b7b9ea195a593f995f
-  data.tar.gz: 281e105560a1bc41a6165a6513bea6eacd0c4ebb0ac7033aad23a226471a5ff52e9c8e8ecfde8193d984837120eeed82ff101e7054c61dab0790d9742c81dd44
+  metadata.gz: 3372006c5984b96a6c1271c8f93b47ebcad6e7a2f77a7bacbefc4b7d7a379e2841a456a18203d7192d0a6a36a1514d2ddb9769ea02e711bbe9f2b3be6a4d009d
+  data.tar.gz: 59e633738079594757401444f372c147bf8b6f8e275e7da98140cf225ba85ebae476f89e4137c605306202d31039ab2fca442bef793df734a8465635be61e7a3

data/lib/google/cloud/datastore/v1/datastore/client.rb

@@ -169,7 +169,8 @@ module Google
                 credentials:  credentials,
                 endpoint:     @config.endpoint,
                 channel_args: @config.channel_args,
-                interceptors: @config.interceptors
+                interceptors: @config.interceptors,
+                channel_pool_config: @config.channel_pool
               )
             end
 
@@ -285,7 +286,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil)
+            # @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil, mode: nil)
             #   Pass arguments to `run_query` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -308,6 +309,10 @@ module Google
             #     The query to run.
             #   @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
             #     The GQL query to run. This query must be a non-aggregation query.
+            #   @param mode [::Google::Cloud::Datastore::V1::QueryMode]
+            #     Optional. The mode in which the query request is processed. This field is
+            #     optional, and when not provided, it defaults to `NORMAL` mode where no
+            #     additional statistics will be returned with the query results.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Datastore::V1::RunQueryResponse]
@@ -389,7 +394,7 @@ module Google
             #   @param options [::Gapic::CallOptions, ::Hash]
             #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
             #
-            # @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil)
+            # @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil, mode: nil)
             #   Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
             #   least one keyword argument is required. To specify no parameters, or to keep all
             #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -412,6 +417,10 @@ module Google
             #     The query to run.
             #   @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
             #     The GQL query to run. This query must be an aggregation query.
+            #   @param mode [::Google::Cloud::Datastore::V1::QueryMode]
+            #     Optional. The mode in which the query request is processed. This field is
+            #     optional, and when not provided, it defaults to `NORMAL` mode where no
+            #     additional statistics will be returned with the query results.
             #
             # @yield [response, operation] Access the result along with the RPC operation
             # @yieldparam response [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
@@ -1103,6 +1112,14 @@ module Google
                 end
               end
 
+              ##
+              # Configuration for the channel pool
+              # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+              #
+              def channel_pool
+                @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+              end
+
               ##
               # Configuration RPC class for the Datastore API.
               #

data/lib/google/cloud/datastore/v1/datastore/rest/client.rb

@@ -202,6 +202,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::LookupResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::LookupRequest.new
+              #
+              #   # Call the lookup method.
+              #   result = client.lookup request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::LookupResponse.
+              #   p result
+              #
               def lookup request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -250,7 +266,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil)
+              # @overload run_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, query: nil, gql_query: nil, mode: nil)
               #   Pass arguments to `run_query` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -273,6 +289,10 @@ module Google
               #     The query to run.
               #   @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
               #     The GQL query to run. This query must be a non-aggregation query.
+              #   @param mode [::Google::Cloud::Datastore::V1::QueryMode]
+              #     Optional. The mode in which the query request is processed. This field is
+              #     optional, and when not provided, it defaults to `NORMAL` mode where no
+              #     additional statistics will be returned with the query results.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Datastore::V1::RunQueryResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -280,6 +300,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::RunQueryResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::RunQueryRequest.new
+              #
+              #   # Call the run_query method.
+              #   result = client.run_query request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::RunQueryResponse.
+              #   p result
+              #
               def run_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -328,7 +364,7 @@ module Google
               #   @param options [::Gapic::CallOptions, ::Hash]
               #     Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
               #
-              # @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil)
+              # @overload run_aggregation_query(project_id: nil, database_id: nil, partition_id: nil, read_options: nil, aggregation_query: nil, gql_query: nil, mode: nil)
               #   Pass arguments to `run_aggregation_query` via keyword arguments. Note that at
               #   least one keyword argument is required. To specify no parameters, or to keep all
               #   the default parameter values, pass an empty Hash as a request object (see above).
@@ -351,6 +387,10 @@ module Google
               #     The query to run.
               #   @param gql_query [::Google::Cloud::Datastore::V1::GqlQuery, ::Hash]
               #     The GQL query to run. This query must be an aggregation query.
+              #   @param mode [::Google::Cloud::Datastore::V1::QueryMode]
+              #     Optional. The mode in which the query request is processed. This field is
+              #     optional, and when not provided, it defaults to `NORMAL` mode where no
+              #     additional statistics will be returned with the query results.
               # @yield [result, operation] Access the result along with the TransportOperation object
               # @yieldparam result [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
               # @yieldparam operation [::Gapic::Rest::TransportOperation]
@@ -358,6 +398,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::RunAggregationQueryResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::RunAggregationQueryRequest.new
+              #
+              #   # Call the run_aggregation_query method.
+              #   result = client.run_aggregation_query request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::RunAggregationQueryResponse.
+              #   p result
+              #
               def run_aggregation_query request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -427,6 +483,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::BeginTransactionResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::BeginTransactionRequest.new
+              #
+              #   # Call the begin_transaction method.
+              #   result = client.begin_transaction request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::BeginTransactionResponse.
+              #   p result
+              #
               def begin_transaction request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -520,6 +592,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::CommitResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::CommitRequest.new
+              #
+              #   # Call the commit method.
+              #   result = client.commit request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::CommitResponse.
+              #   p result
+              #
               def commit request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -590,6 +678,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::RollbackResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::RollbackRequest.new
+              #
+              #   # Call the rollback method.
+              #   result = client.rollback request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::RollbackResponse.
+              #   p result
+              #
               def rollback request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -661,6 +765,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::AllocateIdsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::AllocateIdsRequest.new
+              #
+              #   # Call the allocate_ids method.
+              #   result = client.allocate_ids request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::AllocateIdsResponse.
+              #   p result
+              #
               def allocate_ids request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -732,6 +852,22 @@ module Google
               # @return [::Google::Cloud::Datastore::V1::ReserveIdsResponse]
               #
               # @raise [::Google::Cloud::Error] if the REST call is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/datastore/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Datastore::V1::Datastore::Rest::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Datastore::V1::ReserveIdsRequest.new
+              #
+              #   # Call the reserve_ids method.
+              #   result = client.reserve_ids request
+              #
+              #   # The returned object is of type Google::Cloud::Datastore::V1::ReserveIdsResponse.
+              #   p result
+              #
               def reserve_ids request, options = nil
                 raise ::ArgumentError, "request must be provided" if request.nil?
 

data/lib/google/cloud/datastore/v1/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module Datastore
       module V1
-        VERSION = "0.13.1"
+        VERSION = "0.15.0"
       end
     end
   end

data/lib/google/datastore/v1/datastore_pb.rb

@@ -11,10 +11,11 @@ require 'google/api/routing_pb'
 require 'google/datastore/v1/aggregation_result_pb'
 require 'google/datastore/v1/entity_pb'
 require 'google/datastore/v1/query_pb'
+require 'google/datastore/v1/query_profile_pb'
 require 'google/protobuf/timestamp_pb'
 
 
-descriptor_data = "\n#google/datastore/v1/datastore.proto\x12\x13google.datastore.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x18google/api/routing.proto\x1a,google/datastore/v1/aggregation_result.proto\x1a google/datastore/v1/entity.proto\x1a\x1fgoogle/datastore/v1/query.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xa2\x01\n\rLookupRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x04keys\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\xe6\x01\n\x0eLookupResponse\x12\x30\n\x05\x66ound\x18\x01 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12\x32\n\x07missing\x18\x02 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12*\n\x08\x64\x65\x66\x65rred\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.Key\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12-\n\tread_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\x9e\x02\n\x0fRunQueryRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cpartition_id\x18\x02 \x01(\x0b\x32 .google.datastore.v1.PartitionId\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x05query\x18\x03 \x01(\x0b\x32\x1a.google.datastore.v1.QueryH\x00\x12\x32\n\tgql_query\x18\x07 \x01(\x0b\x32\x1d.google.datastore.v1.GqlQueryH\x00\x42\x0c\n\nquery_type\"\x88\x01\n\x10RunQueryResponse\x12\x34\n\x05\x62\x61tch\x18\x01 \x01(\x0b\x32%.google.datastore.v1.QueryResultBatch\x12)\n\x05query\x18\x02 \x01(\x0b\x32\x1a.google.datastore.v1.Query\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\"\xc0\x02\n\x1aRunAggregationQueryRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cpartition_id\x18\x02 \x01(\x0b\x32 .google.datastore.v1.PartitionId\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12\x42\n\x11\x61ggregation_query\x18\x03 \x01(\x0b\x32%.google.datastore.v1.AggregationQueryH\x00\x12\x32\n\tgql_query\x18\x07 \x01(\x0b\x32\x1d.google.datastore.v1.GqlQueryH\x00\x42\x0c\n\nquery_type\"\xa4\x01\n\x1bRunAggregationQueryResponse\x12:\n\x05\x62\x61tch\x18\x01 \x01(\x0b\x32+.google.datastore.v1.AggregationResultBatch\x12\x34\n\x05query\x18\x02 \x01(\x0b\x32%.google.datastore.v1.AggregationQuery\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\"\x8d\x01\n\x17\x42\x65ginTransactionRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x44\n\x13transaction_options\x18\n \x01(\x0b\x32\'.google.datastore.v1.TransactionOptions\"/\n\x18\x42\x65ginTransactionResponse\x12\x13\n\x0btransaction\x18\x01 \x01(\x0c\"Y\n\x0fRollbackRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x18\n\x0btransaction\x18\x01 \x01(\x0c\x42\x03\xe0\x41\x02\"\x12\n\x10RollbackResponse\"\xe8\x02\n\rCommitRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x35\n\x04mode\x18\x05 \x01(\x0e\x32\'.google.datastore.v1.CommitRequest.Mode\x12\x15\n\x0btransaction\x18\x01 \x01(\x0cH\x00\x12I\n\x16single_use_transaction\x18\n \x01(\x0b\x32\'.google.datastore.v1.TransactionOptionsH\x00\x12\x30\n\tmutations\x18\x06 \x03(\x0b\x32\x1d.google.datastore.v1.Mutation\"F\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x11\n\rTRANSACTIONAL\x10\x01\x12\x15\n\x11NON_TRANSACTIONAL\x10\x02\x42\x16\n\x14transaction_selector\"\x97\x01\n\x0e\x43ommitResponse\x12=\n\x10mutation_results\x18\x03 \x03(\x0b\x32#.google.datastore.v1.MutationResult\x12\x15\n\rindex_updates\x18\x04 \x01(\x05\x12/\n\x0b\x63ommit_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"o\n\x12\x41llocateIdsRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12+\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"=\n\x13\x41llocateIdsResponse\x12&\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.Key\"n\n\x11ReserveIdsRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12+\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\x14\n\x12ReserveIdsResponse\"\xba\x02\n\x08Mutation\x12-\n\x06insert\x18\x04 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12-\n\x06update\x18\x05 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12-\n\x06upsert\x18\x06 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12*\n\x06\x64\x65lete\x18\x07 \x01(\x0b\x32\x18.google.datastore.v1.KeyH\x00\x12\x16\n\x0c\x62\x61se_version\x18\x08 \x01(\x03H\x01\x12\x31\n\x0bupdate_time\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x01\x42\x0b\n\toperationB\x1d\n\x1b\x63onflict_detection_strategy\"\xc5\x01\n\x0eMutationResult\x12%\n\x03key\x18\x03 \x01(\x0b\x32\x18.google.datastore.v1.Key\x12\x0f\n\x07version\x18\x04 \x01(\x03\x12/\n\x0b\x63reate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x19\n\x11\x63onflict_detected\x18\x05 \x01(\x08\"\xca\x02\n\x0bReadOptions\x12L\n\x10read_consistency\x18\x01 \x01(\x0e\x32\x30.google.datastore.v1.ReadOptions.ReadConsistencyH\x00\x12\x15\n\x0btransaction\x18\x02 \x01(\x0cH\x00\x12\x42\n\x0fnew_transaction\x18\x03 \x01(\x0b\x32\'.google.datastore.v1.TransactionOptionsH\x00\x12/\n\tread_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\"M\n\x0fReadConsistency\x12 \n\x1cREAD_CONSISTENCY_UNSPECIFIED\x10\x00\x12\n\n\x06STRONG\x10\x01\x12\x0c\n\x08\x45VENTUAL\x10\x02\x42\x12\n\x10\x63onsistency_type\"\x92\x02\n\x12TransactionOptions\x12G\n\nread_write\x18\x01 \x01(\x0b\x32\x31.google.datastore.v1.TransactionOptions.ReadWriteH\x00\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.datastore.v1.TransactionOptions.ReadOnlyH\x00\x1a)\n\tReadWrite\x12\x1c\n\x14previous_transaction\x18\x01 \x01(\x0c\x1a\x39\n\x08ReadOnly\x12-\n\tread_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\n\x04mode2\xe1\r\n\tDatastore\x12\xc0\x01\n\x06Lookup\x12\".google.datastore.v1.LookupRequest\x1a#.google.datastore.v1.LookupResponse\"m\x82\xd3\xe4\x93\x02%\" /v1/projects/{project_id}:lookup:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x1cproject_id,read_options,keys\x12\xa9\x01\n\x08RunQuery\x12$.google.datastore.v1.RunQueryRequest\x1a%.google.datastore.v1.RunQueryResponse\"P\x82\xd3\xe4\x93\x02\'\"\"/v1/projects/{project_id}:runQuery:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xd5\x01\n\x13RunAggregationQuery\x12/.google.datastore.v1.RunAggregationQueryRequest\x1a\x30.google.datastore.v1.RunAggregationQueryResponse\"[\x82\xd3\xe4\x93\x02\x32\"-/v1/projects/{project_id}:runAggregationQuery:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xd6\x01\n\x10\x42\x65ginTransaction\x12,.google.datastore.v1.BeginTransactionRequest\x1a-.google.datastore.v1.BeginTransactionResponse\"e\x82\xd3\xe4\x93\x02/\"*/v1/projects/{project_id}:beginTransaction:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\nproject_id\x12\xe6\x01\n\x06\x43ommit\x12\".google.datastore.v1.CommitRequest\x1a#.google.datastore.v1.CommitResponse\"\x92\x01\x82\xd3\xe4\x93\x02%\" /v1/projects/{project_id}:commit:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41%project_id,mode,transaction,mutations\xda\x41\x19project_id,mode,mutations\x12\xc2\x01\n\x08Rollback\x12$.google.datastore.v1.RollbackRequest\x1a%.google.datastore.v1.RollbackResponse\"i\x82\xd3\xe4\x93\x02\'\"\"/v1/projects/{project_id}:rollback:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x16project_id,transaction\x12\xc7\x01\n\x0b\x41llocateIds\x12\'.google.datastore.v1.AllocateIdsRequest\x1a(.google.datastore.v1.AllocateIdsResponse\"e\x82\xd3\xe4\x93\x02*\"%/v1/projects/{project_id}:allocateIds:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x0fproject_id,keys\x12\xc3\x01\n\nReserveIds\x12&.google.datastore.v1.ReserveIdsRequest\x1a\'.google.datastore.v1.ReserveIdsResponse\"d\x82\xd3\xe4\x93\x02)\"$/v1/projects/{project_id}:reserveIds:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x0fproject_id,keys\x1av\xca\x41\x18\x64\x61tastore.googleapis.com\xd2\x41Xhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/datastoreB\xc0\x01\n\x17\x63om.google.datastore.v1B\x0e\x44\x61tastoreProtoP\x01Z<google.golang.org/genproto/googleapis/datastore/v1;datastore\xaa\x02\x19Google.Cloud.Datastore.V1\xca\x02\x19Google\\Cloud\\Datastore\\V1\xea\x02\x1cGoogle::Cloud::Datastore::V1b\x06proto3"
+descriptor_data = "\n#google/datastore/v1/datastore.proto\x12\x13google.datastore.v1\x1a\x1cgoogle/api/annotations.proto\x1a\x17google/api/client.proto\x1a\x1fgoogle/api/field_behavior.proto\x1a\x18google/api/routing.proto\x1a,google/datastore/v1/aggregation_result.proto\x1a google/datastore/v1/entity.proto\x1a\x1fgoogle/datastore/v1/query.proto\x1a\'google/datastore/v1/query_profile.proto\x1a\x1fgoogle/protobuf/timestamp.proto\"\xa2\x01\n\rLookupRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x04keys\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\xe6\x01\n\x0eLookupResponse\x12\x30\n\x05\x66ound\x18\x01 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12\x32\n\x07missing\x18\x02 \x03(\x0b\x32!.google.datastore.v1.EntityResult\x12*\n\x08\x64\x65\x66\x65rred\x18\x03 \x03(\x0b\x32\x18.google.datastore.v1.Key\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12-\n\tread_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"\xd1\x02\n\x0fRunQueryRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cpartition_id\x18\x02 \x01(\x0b\x32 .google.datastore.v1.PartitionId\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12+\n\x05query\x18\x03 \x01(\x0b\x32\x1a.google.datastore.v1.QueryH\x00\x12\x32\n\tgql_query\x18\x07 \x01(\x0b\x32\x1d.google.datastore.v1.GqlQueryH\x00\x12\x31\n\x04mode\x18\x0b \x01(\x0e\x32\x1e.google.datastore.v1.QueryModeB\x03\xe0\x41\x01\x42\x0c\n\nquery_type\"\xbc\x01\n\x10RunQueryResponse\x12\x34\n\x05\x62\x61tch\x18\x01 \x01(\x0b\x32%.google.datastore.v1.QueryResultBatch\x12)\n\x05query\x18\x02 \x01(\x0b\x32\x1a.google.datastore.v1.Query\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12\x32\n\x05stats\x18\x06 \x01(\x0b\x32#.google.datastore.v1.ResultSetStats\"\xf3\x02\n\x1aRunAggregationQueryRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x36\n\x0cpartition_id\x18\x02 \x01(\x0b\x32 .google.datastore.v1.PartitionId\x12\x36\n\x0cread_options\x18\x01 \x01(\x0b\x32 .google.datastore.v1.ReadOptions\x12\x42\n\x11\x61ggregation_query\x18\x03 \x01(\x0b\x32%.google.datastore.v1.AggregationQueryH\x00\x12\x32\n\tgql_query\x18\x07 \x01(\x0b\x32\x1d.google.datastore.v1.GqlQueryH\x00\x12\x31\n\x04mode\x18\n \x01(\x0e\x32\x1e.google.datastore.v1.QueryModeB\x03\xe0\x41\x01\x42\x0c\n\nquery_type\"\xd8\x01\n\x1bRunAggregationQueryResponse\x12:\n\x05\x62\x61tch\x18\x01 \x01(\x0b\x32+.google.datastore.v1.AggregationResultBatch\x12\x34\n\x05query\x18\x02 \x01(\x0b\x32%.google.datastore.v1.AggregationQuery\x12\x13\n\x0btransaction\x18\x05 \x01(\x0c\x12\x32\n\x05stats\x18\x06 \x01(\x0b\x32#.google.datastore.v1.ResultSetStats\"\x8d\x01\n\x17\x42\x65ginTransactionRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x44\n\x13transaction_options\x18\n \x01(\x0b\x32\'.google.datastore.v1.TransactionOptions\"/\n\x18\x42\x65ginTransactionResponse\x12\x13\n\x0btransaction\x18\x01 \x01(\x0c\"Y\n\x0fRollbackRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x18\n\x0btransaction\x18\x01 \x01(\x0c\x42\x03\xe0\x41\x02\"\x12\n\x10RollbackResponse\"\xe8\x02\n\rCommitRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12\x35\n\x04mode\x18\x05 \x01(\x0e\x32\'.google.datastore.v1.CommitRequest.Mode\x12\x15\n\x0btransaction\x18\x01 \x01(\x0cH\x00\x12I\n\x16single_use_transaction\x18\n \x01(\x0b\x32\'.google.datastore.v1.TransactionOptionsH\x00\x12\x30\n\tmutations\x18\x06 \x03(\x0b\x32\x1d.google.datastore.v1.Mutation\"F\n\x04Mode\x12\x14\n\x10MODE_UNSPECIFIED\x10\x00\x12\x11\n\rTRANSACTIONAL\x10\x01\x12\x15\n\x11NON_TRANSACTIONAL\x10\x02\x42\x16\n\x14transaction_selector\"\x97\x01\n\x0e\x43ommitResponse\x12=\n\x10mutation_results\x18\x03 \x03(\x0b\x32#.google.datastore.v1.MutationResult\x12\x15\n\rindex_updates\x18\x04 \x01(\x05\x12/\n\x0b\x63ommit_time\x18\x08 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\"o\n\x12\x41llocateIdsRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12+\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"=\n\x13\x41llocateIdsResponse\x12&\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.Key\"n\n\x11ReserveIdsRequest\x12\x17\n\nproject_id\x18\x08 \x01(\tB\x03\xe0\x41\x02\x12\x13\n\x0b\x64\x61tabase_id\x18\t \x01(\t\x12+\n\x04keys\x18\x01 \x03(\x0b\x32\x18.google.datastore.v1.KeyB\x03\xe0\x41\x02\"\x14\n\x12ReserveIdsResponse\"\xba\x02\n\x08Mutation\x12-\n\x06insert\x18\x04 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12-\n\x06update\x18\x05 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12-\n\x06upsert\x18\x06 \x01(\x0b\x32\x1b.google.datastore.v1.EntityH\x00\x12*\n\x06\x64\x65lete\x18\x07 \x01(\x0b\x32\x18.google.datastore.v1.KeyH\x00\x12\x16\n\x0c\x62\x61se_version\x18\x08 \x01(\x03H\x01\x12\x31\n\x0bupdate_time\x18\x0b \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x01\x42\x0b\n\toperationB\x1d\n\x1b\x63onflict_detection_strategy\"\xc5\x01\n\x0eMutationResult\x12%\n\x03key\x18\x03 \x01(\x0b\x32\x18.google.datastore.v1.Key\x12\x0f\n\x07version\x18\x04 \x01(\x03\x12/\n\x0b\x63reate_time\x18\x07 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12/\n\x0bupdate_time\x18\x06 \x01(\x0b\x32\x1a.google.protobuf.Timestamp\x12\x19\n\x11\x63onflict_detected\x18\x05 \x01(\x08\"\xca\x02\n\x0bReadOptions\x12L\n\x10read_consistency\x18\x01 \x01(\x0e\x32\x30.google.datastore.v1.ReadOptions.ReadConsistencyH\x00\x12\x15\n\x0btransaction\x18\x02 \x01(\x0cH\x00\x12\x42\n\x0fnew_transaction\x18\x03 \x01(\x0b\x32\'.google.datastore.v1.TransactionOptionsH\x00\x12/\n\tread_time\x18\x04 \x01(\x0b\x32\x1a.google.protobuf.TimestampH\x00\"M\n\x0fReadConsistency\x12 \n\x1cREAD_CONSISTENCY_UNSPECIFIED\x10\x00\x12\n\n\x06STRONG\x10\x01\x12\x0c\n\x08\x45VENTUAL\x10\x02\x42\x12\n\x10\x63onsistency_type\"\x92\x02\n\x12TransactionOptions\x12G\n\nread_write\x18\x01 \x01(\x0b\x32\x31.google.datastore.v1.TransactionOptions.ReadWriteH\x00\x12\x45\n\tread_only\x18\x02 \x01(\x0b\x32\x30.google.datastore.v1.TransactionOptions.ReadOnlyH\x00\x1a)\n\tReadWrite\x12\x1c\n\x14previous_transaction\x18\x01 \x01(\x0c\x1a\x39\n\x08ReadOnly\x12-\n\tread_time\x18\x01 \x01(\x0b\x32\x1a.google.protobuf.TimestampB\x06\n\x04mode2\xe1\r\n\tDatastore\x12\xc0\x01\n\x06Lookup\x12\".google.datastore.v1.LookupRequest\x1a#.google.datastore.v1.LookupResponse\"m\x82\xd3\xe4\x93\x02%\" /v1/projects/{project_id}:lookup:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x1cproject_id,read_options,keys\x12\xa9\x01\n\x08RunQuery\x12$.google.datastore.v1.RunQueryRequest\x1a%.google.datastore.v1.RunQueryResponse\"P\x82\xd3\xe4\x93\x02\'\"\"/v1/projects/{project_id}:runQuery:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xd5\x01\n\x13RunAggregationQuery\x12/.google.datastore.v1.RunAggregationQueryRequest\x1a\x30.google.datastore.v1.RunAggregationQueryResponse\"[\x82\xd3\xe4\x93\x02\x32\"-/v1/projects/{project_id}:runAggregationQuery:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\x12\xd6\x01\n\x10\x42\x65ginTransaction\x12,.google.datastore.v1.BeginTransactionRequest\x1a-.google.datastore.v1.BeginTransactionResponse\"e\x82\xd3\xe4\x93\x02/\"*/v1/projects/{project_id}:beginTransaction:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\nproject_id\x12\xe6\x01\n\x06\x43ommit\x12\".google.datastore.v1.CommitRequest\x1a#.google.datastore.v1.CommitResponse\"\x92\x01\x82\xd3\xe4\x93\x02%\" /v1/projects/{project_id}:commit:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41%project_id,mode,transaction,mutations\xda\x41\x19project_id,mode,mutations\x12\xc2\x01\n\x08Rollback\x12$.google.datastore.v1.RollbackRequest\x1a%.google.datastore.v1.RollbackResponse\"i\x82\xd3\xe4\x93\x02\'\"\"/v1/projects/{project_id}:rollback:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x16project_id,transaction\x12\xc7\x01\n\x0b\x41llocateIds\x12\'.google.datastore.v1.AllocateIdsRequest\x1a(.google.datastore.v1.AllocateIdsResponse\"e\x82\xd3\xe4\x93\x02*\"%/v1/projects/{project_id}:allocateIds:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x0fproject_id,keys\x12\xc3\x01\n\nReserveIds\x12&.google.datastore.v1.ReserveIdsRequest\x1a\'.google.datastore.v1.ReserveIdsResponse\"d\x82\xd3\xe4\x93\x02)\"$/v1/projects/{project_id}:reserveIds:\x01*\x8a\xd3\xe4\x93\x02\x1d\x12\x0c\n\nproject_id\x12\r\n\x0b\x64\x61tabase_id\xda\x41\x0fproject_id,keys\x1av\xca\x41\x18\x64\x61tastore.googleapis.com\xd2\x41Xhttps://www.googleapis.com/auth/cloud-platform,https://www.googleapis.com/auth/datastoreB\xc0\x01\n\x17\x63om.google.datastore.v1B\x0e\x44\x61tastoreProtoP\x01Z<google.golang.org/genproto/googleapis/datastore/v1;datastore\xaa\x02\x19Google.Cloud.Datastore.V1\xca\x02\x19Google\\Cloud\\Datastore\\V1\xea\x02\x1cGoogle::Cloud::Datastore::V1b\x06proto3"
 
 pool = Google::Protobuf::DescriptorPool.generated_pool
 
@@ -32,6 +33,7 @@ rescue TypeError => e
     ["google.datastore.v1.Key", "google/datastore/v1/entity.proto"],
     ["google.datastore.v1.EntityResult", "google/datastore/v1/query.proto"],
     ["google.protobuf.Timestamp", "google/protobuf/timestamp.proto"],
+    ["google.datastore.v1.ResultSetStats", "google/datastore/v1/query_profile.proto"],
     ["google.datastore.v1.AggregationResultBatch", "google/datastore/v1/aggregation_result.proto"],
   ]
   imports.each do |type_name, expected_filename|

data/lib/google/datastore/v1/query_profile_pb.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/datastore/v1/query_profile.proto
+
+require 'google/protobuf'
+
+require 'google/protobuf/struct_pb'
+
+
+descriptor_data = "\n\'google/datastore/v1/query_profile.proto\x12\x13google.datastore.v1\x1a\x1cgoogle/protobuf/struct.proto\"7\n\tQueryPlan\x12*\n\tplan_info\x18\x01 \x01(\x0b\x32\x17.google.protobuf.Struct\"r\n\x0eResultSetStats\x12\x32\n\nquery_plan\x18\x01 \x01(\x0b\x32\x1e.google.datastore.v1.QueryPlan\x12,\n\x0bquery_stats\x18\x02 \x01(\x0b\x32\x17.google.protobuf.Struct*.\n\tQueryMode\x12\n\n\x06NORMAL\x10\x00\x12\x08\n\x04PLAN\x10\x01\x12\x0b\n\x07PROFILE\x10\x02\x42\xc3\x01\n\x17\x63om.google.datastore.v1B\x11QueryProfileProtoP\x01Z<google.golang.org/genproto/googleapis/datastore/v1;datastore\xaa\x02\x19Google.Cloud.Datastore.V1\xca\x02\x19Google\\Cloud\\Datastore\\V1\xea\x02\x1cGoogle::Cloud::Datastore::V1b\x06proto3"
+
+pool = Google::Protobuf::DescriptorPool.generated_pool
+
+begin
+  pool.add_serialized_file(descriptor_data)
+rescue TypeError => e
+  # Compatibility code: will be removed in the next major version.
+  require 'google/protobuf/descriptor_pb'
+  parsed = Google::Protobuf::FileDescriptorProto.decode(descriptor_data)
+  parsed.clear_dependency
+  serialized = parsed.class.encode(parsed)
+  file = pool.add_serialized_file(serialized)
+  warn "Warning: Protobuf detected an import path issue while loading generated file #{__FILE__}"
+  imports = [
+    ["google.protobuf.Struct", "google/protobuf/struct.proto"],
+  ]
+  imports.each do |type_name, expected_filename|
+    import_file = pool.lookup(type_name).file_descriptor
+    if import_file.name != expected_filename
+      warn "- #{file.name} imports #{expected_filename}, but that import was loaded as #{import_file.name}"
+    end
+  end
+  warn "Each proto file must use a consistent fully-qualified name."
+  warn "This will become an error in the next major version."
+end
+
+module Google
+  module Cloud
+    module Datastore
+      module V1
+        QueryPlan = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.QueryPlan").msgclass
+        ResultSetStats = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.ResultSetStats").msgclass
+        QueryMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.datastore.v1.QueryMode").enummodule
+      end
+    end
+  end
+end

data/proto_docs/google/api/client.rb

@@ -304,6 +304,19 @@ module Google
     #                seconds: 360 # 6 minutes
     #              total_poll_timeout:
     #                 seconds: 54000 # 90 minutes
+    # @!attribute [rw] auto_populated_fields
+    #   @return [::Array<::String>]
+    #     List of top-level fields of the request message, that should be
+    #     automatically populated by the client libraries based on their
+    #     (google.api.field_info).format. Currently supported format: UUID4.
+    #
+    #     Example of a YAML configuration:
+    #
+    #      publishing:
+    #        method_settings:
+    #          - selector: google.example.v1.ExampleService.CreateExample
+    #            auto_populated_fields:
+    #            - request_id
     class MethodSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/datastore/v1/datastore.rb

@@ -100,6 +100,11 @@ module Google
         # @!attribute [rw] gql_query
         #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
         #     The GQL query to run. This query must be a non-aggregation query.
+        # @!attribute [rw] mode
+        #   @return [::Google::Cloud::Datastore::V1::QueryMode]
+        #     Optional. The mode in which the query request is processed. This field is
+        #     optional, and when not provided, it defaults to `NORMAL` mode where no
+        #     additional statistics will be returned with the query results.
         class RunQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -122,6 +127,12 @@ module Google
         #     {::Google::Cloud::Datastore::V1::ReadOptions#new_transaction ReadOptions.new_transaction}
         #     was set in
         #     {::Google::Cloud::Datastore::V1::RunQueryRequest#read_options RunQueryRequest.read_options}.
+        # @!attribute [rw] stats
+        #   @return [::Google::Cloud::Datastore::V1::ResultSetStats]
+        #     Query plan and execution statistics. Note that the returned stats are
+        #     subject to change as Firestore evolves.
+        #
+        #     This is only present when the request specifies a mode other than `NORMAL`.
         class RunQueryResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -153,6 +164,11 @@ module Google
         # @!attribute [rw] gql_query
         #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
         #     The GQL query to run. This query must be an aggregation query.
+        # @!attribute [rw] mode
+        #   @return [::Google::Cloud::Datastore::V1::QueryMode]
+        #     Optional. The mode in which the query request is processed. This field is
+        #     optional, and when not provided, it defaults to `NORMAL` mode where no
+        #     additional statistics will be returned with the query results.
         class RunAggregationQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -175,6 +191,12 @@ module Google
         #     {::Google::Cloud::Datastore::V1::ReadOptions#new_transaction ReadOptions.new_transaction}
         #     was set in
         #     {::Google::Cloud::Datastore::V1::RunAggregationQueryRequest#read_options RunAggregationQueryRequest.read_options}.
+        # @!attribute [rw] stats
+        #   @return [::Google::Cloud::Datastore::V1::ResultSetStats]
+        #     Query plan and execution statistics. Note that the returned stats are
+        #     subject to change as Firestore evolves.
+        #
+        #     This is only present when the request specifies a mode other than `NORMAL`.
         class RunAggregationQueryResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/datastore/v1/query_profile.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Datastore
+      module V1
+        # Plan for the query.
+        # @!attribute [rw] plan_info
+        #   @return [::Google::Protobuf::Struct]
+        #     Planning phase information for the query. It will include:
+        #
+        #     {
+        #       "indexes_used": [
+        #         \\{"query_scope": "Collection", "properties": "(foo ASC, __name__ ASC)"},
+        #         \\{"query_scope": "Collection", "properties": "(bar ASC, __name__ ASC)"}
+        #       ]
+        #     }
+        class QueryPlan
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Planning and execution statistics for the query.
+        # @!attribute [rw] query_plan
+        #   @return [::Google::Cloud::Datastore::V1::QueryPlan]
+        #     Plan for the query.
+        # @!attribute [rw] query_stats
+        #   @return [::Google::Protobuf::Struct]
+        #     Aggregated statistics from the execution of the query.
+        #
+        #     This will only be present when the request specifies `PROFILE` mode.
+        #     For example, a query will return the statistics including:
+        #
+        #     {
+        #       "results_returned": "20",
+        #       "documents_scanned": "20",
+        #       "indexes_entries_scanned": "10050",
+        #       "total_execution_time": "100.7 msecs"
+        #     }
+        class ResultSetStats
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The mode in which the query request must be processed.
+        module QueryMode
+          # The default mode. Only the query results are returned.
+          NORMAL = 0
+
+          # This mode returns only the query plan, without any results or execution
+          # statistics information.
+          PLAN = 1
+
+          # This mode returns both the query plan and the execution statistics along
+          # with the results.
+          PROFILE = 2
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore-v1
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-04 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -184,6 +184,7 @@ files:
 - lib/google/datastore/v1/datastore_services_pb.rb
 - lib/google/datastore/v1/entity_pb.rb
 - lib/google/datastore/v1/query_pb.rb
+- lib/google/datastore/v1/query_profile_pb.rb
 - proto_docs/README.md
 - proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
@@ -194,6 +195,7 @@ files:
 - proto_docs/google/datastore/v1/datastore.rb
 - proto_docs/google/datastore/v1/entity.rb
 - proto_docs/google/datastore/v1/query.rb
+- proto_docs/google/datastore/v1/query_profile.rb
 - proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/struct.rb
 - proto_docs/google/protobuf/timestamp.rb
@@ -218,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.3
 signing_key: 
 specification_version: 4
 summary: Accesses the schemaless NoSQL database to provide fully managed, robust,