google-apis-datastore_v1 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a8cb24c42c83d2e1b7a87b156c4120a041376c18e3854829e10a056af24b0c
-  data.tar.gz: a34072b6ac50b4b918ce0fc8cf5cef752063aef75ca77970a1feeba8b733b32f
+  metadata.gz: 9cae9589ebcb7edb55fea7a66deecd266a8834d539d38cfc6aae70446b55015b
+  data.tar.gz: ceda7925f94b0408aa072ca163d821ae8f20633975f5ae2b94cb86b6535b6ee0
 SHA512:
-  metadata.gz: 83d6118d2ac7523e8b379f3d1b90ed60a6c6268452a244a055c68e51fd0b60ad9b99547e9fb6be57a7966c5f3130b76832d1fc7ecf04c3fbbe3bc70f6cddc1f2
-  data.tar.gz: 9f78662786c6e5f90c9f2753beea0638c08c3e09c746d614017d00960cf1e604efdae5d480056b9f798ab903ffdeff3c915bbb2145af59174f11b041860e4d72
+  metadata.gz: 78200157aec3ba3e1e6a6452d7233c45e444640ded2b7a179394296f60051c0d7a44ab9a732b3484e35d96f60910b17f7f466275cc7b6e064024218e420b2a41
+  data.tar.gz: 522a405a4b50d65f65917aeb95feb1c655ecb6b4c6abe7ca45d3903dc0c0fdab88ff78dd63386c289823d58f1ead00e0c72f691f18bbb3ecfc328192567b8fda

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release history for google-apis-datastore_v1
 
+### v0.20.0 (2022-10-30)
+
+* Regenerated from discovery document revision 20221018
+* Regenerated using generator version 0.11.0
+
 ### v0.19.0 (2022-09-20)
 
 * Regenerated using generator version 0.10.0

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

@@ -22,6 +22,124 @@ module Google
   module Apis
     module DatastoreV1
       
+      # Defines a aggregation that produces a single result.
+      class Aggregation
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Optional name of the property to store the result of the aggregation.
+        # If not provided, Datastore will pick a default name following the format `
+        # property_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1,
+        # COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) OVER ( ... ); `
+        # `` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS
+        # property_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT_UP_TO(4) AS property_2 OVER
+        # ( ... ); ``` Requires: * Must be unique across all aggregation aliases. *
+        # Conform to entity property name limitations.
+        # Corresponds to the JSON property `alias`
+        # @return [String]
+        attr_accessor :alias
+      
+        # Count of entities that match the query. The `COUNT(*)` aggregation function
+        # operates on the entire entity so it does not require a field reference.
+        # Corresponds to the JSON property `count`
+        # @return [Google::Apis::DatastoreV1::Count]
+        attr_accessor :count
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @alias = args[:alias] if args.key?(:alias)
+          @count = args[:count] if args.key?(:count)
+        end
+      end
+      
+      # Datastore query for running an aggregation over a Query.
+      class AggregationQuery
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Series of aggregations to apply over the results of the `
+        # nested_query`. Requires: * A minimum of one and maximum of five aggregations
+        # per query.
+        # Corresponds to the JSON property `aggregations`
+        # @return [Array<Google::Apis::DatastoreV1::Aggregation>]
+        attr_accessor :aggregations
+      
+        # A query for entities.
+        # Corresponds to the JSON property `nestedQuery`
+        # @return [Google::Apis::DatastoreV1::Query]
+        attr_accessor :nested_query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregations = args[:aggregations] if args.key?(:aggregations)
+          @nested_query = args[:nested_query] if args.key?(:nested_query)
+        end
+      end
+      
+      # The result of a single bucket from a Datastore aggregation query. The keys of `
+      # aggregate_properties` are the same for all results in an aggregation query,
+      # unlike entity queries which can have different fields present for each result.
+      class AggregationResult
+        include Google::Apis::Core::Hashable
+      
+        # The result of the aggregation functions, ex: `COUNT(*) AS total_entities`. The
+        # key is the alias assigned to the aggregation function on input and the size of
+        # this map equals the number of aggregation functions in the query.
+        # Corresponds to the JSON property `aggregateProperties`
+        # @return [Hash<String,Google::Apis::DatastoreV1::Value>]
+        attr_accessor :aggregate_properties
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregate_properties = args[:aggregate_properties] if args.key?(:aggregate_properties)
+        end
+      end
+      
+      # A batch of aggregation results produced by an aggregation query.
+      class AggregationResultBatch
+        include Google::Apis::Core::Hashable
+      
+        # The aggregation results for this batch.
+        # Corresponds to the JSON property `aggregationResults`
+        # @return [Array<Google::Apis::DatastoreV1::AggregationResult>]
+        attr_accessor :aggregation_results
+      
+        # The state of the query after the current batch. Only COUNT(*) aggregations are
+        # supported in the initial launch. Therefore, expected result type is limited to
+        # `NO_MORE_RESULTS`.
+        # Corresponds to the JSON property `moreResults`
+        # @return [String]
+        attr_accessor :more_results
+      
+        # Read timestamp this batch was returned from. In a single transaction,
+        # subsequent query result batches for the same query can have a greater
+        # timestamp. Each batch's read timestamp is valid for all preceding batches.
+        # Corresponds to the JSON property `readTime`
+        # @return [String]
+        attr_accessor :read_time
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregation_results = args[:aggregation_results] if args.key?(:aggregation_results)
+          @more_results = args[:more_results] if args.key?(:more_results)
+          @read_time = args[:read_time] if args.key?(:read_time)
+        end
+      end
+      
       # The request for Datastore.AllocateIds.
       class AllocateIdsRequest
         include Google::Apis::Core::Hashable
@@ -240,6 +358,31 @@ module Google
         end
       end
       
+      # Count of entities that match the query. The `COUNT(*)` aggregation function
+      # operates on the entire entity so it does not require a field reference.
+      class Count
+        include Google::Apis::Core::Hashable
+      
+        # Optional. Optional constraint on the maximum number of entities to count. This
+        # provides a way to set an upper bound on the number of entities to scan,
+        # limiting latency and cost. Unspecified is interpreted as no bound. If a zero
+        # value is provided, a count result of zero should always be expected. High-
+        # Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ```
+        # Requires: * Must be non-negative when present.
+        # Corresponds to the JSON property `upTo`
+        # @return [Fixnum]
+        attr_accessor :up_to
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @up_to = args[:up_to] if args.key?(:up_to)
+        end
+      end
+      
       # A generic empty message that you can re-use to avoid defining duplicated empty
       # messages in your APIs. A typical example is to use it as the request or the
       # response type of an API method. For instance: service Foo ` rpc Bar(google.
@@ -2096,6 +2239,84 @@ module Google
         end
       end
       
+      # The request for Datastore.RunAggregationQuery.
+      class RunAggregationQueryRequest
+        include Google::Apis::Core::Hashable
+      
+        # Datastore query for running an aggregation over a Query.
+        # Corresponds to the JSON property `aggregationQuery`
+        # @return [Google::Apis::DatastoreV1::AggregationQuery]
+        attr_accessor :aggregation_query
+      
+        # The ID of the database against which to make the request. '(default)' is not
+        # allowed; please use empty string '' to refer the default database.
+        # Corresponds to the JSON property `databaseId`
+        # @return [String]
+        attr_accessor :database_id
+      
+        # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
+        # Corresponds to the JSON property `gqlQuery`
+        # @return [Google::Apis::DatastoreV1::GqlQuery]
+        attr_accessor :gql_query
+      
+        # A partition ID identifies a grouping of entities. The grouping is always by
+        # project and namespace, however the namespace ID may be empty. A partition ID
+        # contains several dimensions: project ID and namespace ID. Partition dimensions:
+        # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match
+        # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__.
+        # *__`, the partition is reserved/read-only. A reserved/read-only partition ID
+        # is forbidden in certain documented contexts. Foreign partition IDs (in which
+        # the project ID does not match the context project ID ) are discouraged. Reads
+        # and writes of foreign partition IDs may fail if the project is not in an
+        # active state.
+        # Corresponds to the JSON property `partitionId`
+        # @return [Google::Apis::DatastoreV1::PartitionId]
+        attr_accessor :partition_id
+      
+        # The options shared by read requests.
+        # Corresponds to the JSON property `readOptions`
+        # @return [Google::Apis::DatastoreV1::ReadOptions]
+        attr_accessor :read_options
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @aggregation_query = args[:aggregation_query] if args.key?(:aggregation_query)
+          @database_id = args[:database_id] if args.key?(:database_id)
+          @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)
+        end
+      end
+      
+      # The response for Datastore.RunAggregationQuery.
+      class RunAggregationQueryResponse
+        include Google::Apis::Core::Hashable
+      
+        # A batch of aggregation results produced by an aggregation query.
+        # Corresponds to the JSON property `batch`
+        # @return [Google::Apis::DatastoreV1::AggregationResultBatch]
+        attr_accessor :batch
+      
+        # Datastore query for running an aggregation over a Query.
+        # Corresponds to the JSON property `query`
+        # @return [Google::Apis::DatastoreV1::AggregationQuery]
+        attr_accessor :query
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @batch = args[:batch] if args.key?(:batch)
+          @query = args[:query] if args.key?(:query)
+        end
+      end
+      
       # The request for Datastore.RunQuery.
       class RunQueryRequest
         include Google::Apis::Core::Hashable

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.19.0"
+      GEM_VERSION = "0.20.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.10.0"
+      GENERATOR_VERSION = "0.11.0"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20220830"
+      REVISION = "20221018"
     end
   end
 end

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

@@ -22,6 +22,30 @@ module Google
   module Apis
     module DatastoreV1
       
+      class Aggregation
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AggregationQuery
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AggregationResult
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AggregationResultBatch
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class AllocateIdsRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -70,6 +94,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Count
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Empty
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -388,6 +418,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class RunAggregationQueryRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class RunAggregationQueryResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class RunQueryRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -418,6 +460,43 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Aggregation
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :alias, as: 'alias'
+          property :count, as: 'count', class: Google::Apis::DatastoreV1::Count, decorator: Google::Apis::DatastoreV1::Count::Representation
+      
+        end
+      end
+      
+      class AggregationQuery
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :aggregations, as: 'aggregations', class: Google::Apis::DatastoreV1::Aggregation, decorator: Google::Apis::DatastoreV1::Aggregation::Representation
+      
+          property :nested_query, as: 'nestedQuery', class: Google::Apis::DatastoreV1::Query, decorator: Google::Apis::DatastoreV1::Query::Representation
+      
+        end
+      end
+      
+      class AggregationResult
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          hash :aggregate_properties, as: 'aggregateProperties', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
+        end
+      end
+      
+      class AggregationResultBatch
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :aggregation_results, as: 'aggregationResults', class: Google::Apis::DatastoreV1::AggregationResult, decorator: Google::Apis::DatastoreV1::AggregationResult::Representation
+      
+          property :more_results, as: 'moreResults'
+          property :read_time, as: 'readTime'
+        end
+      end
+      
       class AllocateIdsRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -489,6 +568,13 @@ module Google
         end
       end
       
+      class Count
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :up_to, :numeric_string => true, as: 'upTo'
+        end
+      end
+      
       class Empty
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1013,6 +1099,31 @@ module Google
         end
       end
       
+      class RunAggregationQueryRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :aggregation_query, as: 'aggregationQuery', class: Google::Apis::DatastoreV1::AggregationQuery, decorator: Google::Apis::DatastoreV1::AggregationQuery::Representation
+      
+          property :database_id, as: 'databaseId'
+          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 :read_options, as: 'readOptions', class: Google::Apis::DatastoreV1::ReadOptions, decorator: Google::Apis::DatastoreV1::ReadOptions::Representation
+      
+        end
+      end
+      
+      class RunAggregationQueryResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :batch, as: 'batch', class: Google::Apis::DatastoreV1::AggregationResultBatch, decorator: Google::Apis::DatastoreV1::AggregationResultBatch::Representation
+      
+          property :query, as: 'query', class: Google::Apis::DatastoreV1::AggregationQuery, decorator: Google::Apis::DatastoreV1::AggregationQuery::Representation
+      
+        end
+      end
+      
       class RunQueryRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

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

@@ -326,6 +326,39 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
+        # Runs an aggregation query.
+        # @param [String] project_id
+        #   Required. The ID of the project against which to make the request.
+        # @param [Google::Apis::DatastoreV1::RunAggregationQueryRequest] run_aggregation_query_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::DatastoreV1::RunAggregationQueryResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::DatastoreV1::RunAggregationQueryResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def run_project_aggregation_query(project_id, run_aggregation_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1/projects/{projectId}:runAggregationQuery', options)
+          command.request_representation = Google::Apis::DatastoreV1::RunAggregationQueryRequest::Representation
+          command.request_object = run_aggregation_query_request_object
+          command.response_representation = Google::Apis::DatastoreV1::RunAggregationQueryResponse::Representation
+          command.response_class = Google::Apis::DatastoreV1::RunAggregationQueryResponse
+          command.params['projectId'] = project_id unless project_id.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
+        
         # Queries for entities.
         # @param [String] project_id
         #   Required. The ID of the project against which to make the request.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-datastore_v1
 version: !ruby/object:Gem::Version
-  version: 0.19.0
+  version: 0.20.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-26 00:00:00.000000000 Z
+date: 2022-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 0.9.1
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -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.19.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.20.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datastore_v1
 post_install_message: 
 rdoc_options: []