google-cloud-datastore-v1 0.6.0 → 0.8.0

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

@@ -25,6 +25,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] read_options
         #   @return [::Google::Cloud::Datastore::V1::ReadOptions]
         #     The options for this lookup request.
@@ -64,6 +70,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] partition_id
         #   @return [::Google::Cloud::Datastore::V1::PartitionId]
         #     Entities are partitioned into subsets, identified by a partition ID.
@@ -78,13 +90,14 @@ module Google
         #     The query to run.
         # @!attribute [rw] gql_query
         #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
-        #     The GQL query to run.
+        #     The GQL query to run. This query must be a non-aggregation query.
         class RunQueryRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#run_query Datastore.RunQuery}.
+        # The response for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#run_query Datastore.RunQuery}.
         # @!attribute [rw] batch
         #   @return [::Google::Cloud::Datastore::V1::QueryResultBatch]
         #     A batch of query results (always present).
@@ -96,10 +109,61 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
+        # The request for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#run_aggregation_query Datastore.RunAggregationQuery}.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
+        # @!attribute [rw] partition_id
+        #   @return [::Google::Cloud::Datastore::V1::PartitionId]
+        #     Entities are partitioned into subsets, identified by a partition ID.
+        #     Queries are scoped to a single partition.
+        #     This partition ID is normalized with the standard default context
+        #     partition ID.
+        # @!attribute [rw] read_options
+        #   @return [::Google::Cloud::Datastore::V1::ReadOptions]
+        #     The options for this query.
+        # @!attribute [rw] aggregation_query
+        #   @return [::Google::Cloud::Datastore::V1::AggregationQuery]
+        #     The query to run.
+        # @!attribute [rw] gql_query
+        #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
+        #     The GQL query to run. This query must be an aggregation query.
+        class RunAggregationQueryRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#run_aggregation_query Datastore.RunAggregationQuery}.
+        # @!attribute [rw] batch
+        #   @return [::Google::Cloud::Datastore::V1::AggregationResultBatch]
+        #     A batch of aggregation results. Always present.
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::Datastore::V1::AggregationQuery]
+        #     The parsed form of the `GqlQuery` from the request, if it was set.
+        class RunAggregationQueryResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] transaction_options
         #   @return [::Google::Cloud::Datastore::V1::TransactionOptions]
         #     Options for a new transaction.
@@ -108,7 +172,8 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
+        # The response for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     The transaction identifier (always present).
@@ -121,6 +186,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     Required. The transaction identifier, returned by a call to
@@ -130,8 +201,9 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#rollback Datastore.Rollback}.
-        # (an empty message).
+        # The response for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#rollback Datastore.Rollback}. (an empty
+        # message).
         class RollbackResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -141,6 +213,12 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] mode
         #   @return [::Google::Cloud::Datastore::V1::CommitRequest::Mode]
         #     The type of commit to perform. Defaults to `TRANSACTIONAL`.
@@ -200,20 +278,28 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#allocate_ids Datastore.AllocateIds}.
+        # The request for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#allocate_ids Datastore.AllocateIds}.
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] keys
         #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
-        #     Required. A list of keys with incomplete key paths for which to allocate IDs.
-        #     No key may be reserved/read-only.
+        #     Required. A list of keys with incomplete key paths for which to allocate
+        #     IDs. No key may be reserved/read-only.
         class AllocateIdsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#allocate_ids Datastore.AllocateIds}.
+        # The response for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#allocate_ids Datastore.AllocateIds}.
         # @!attribute [rw] keys
         #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
         #     The keys specified in the request (in the same order), each with
@@ -223,23 +309,28 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#reserve_ids Datastore.ReserveIds}.
+        # The request for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#reserve_ids Datastore.ReserveIds}.
         # @!attribute [rw] project_id
         #   @return [::String]
         #     Required. The ID of the project against which to make the request.
         # @!attribute [rw] database_id
         #   @return [::String]
-        #     If not empty, the ID of the database against which to make the request.
+        #     The ID of the database against which to make the request.
+        #
+        #     '(default)' is not allowed; please use empty string '' to refer the default
+        #     database.
         # @!attribute [rw] keys
         #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
-        #     Required. A list of keys with complete key paths whose numeric IDs should not be
-        #     auto-allocated.
+        #     Required. A list of keys with complete key paths whose numeric IDs should
+        #     not be auto-allocated.
         class ReserveIdsRequest
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
-        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#reserve_ids Datastore.ReserveIds}.
+        # The response for
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#reserve_ids Datastore.ReserveIds}.
         class ReserveIdsResponse
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -308,7 +399,6 @@ module Google
         # @!attribute [rw] read_consistency
         #   @return [::Google::Cloud::Datastore::V1::ReadOptions::ReadConsistency]
         #     The non-transactional read consistency to use.
-        #     Cannot be set to `STRONG` for global queries.
         # @!attribute [rw] transaction
         #   @return [::String]
         #     The identifier of the transaction in which to read. A
@@ -339,8 +429,10 @@ module Google
         # Options for beginning a new transaction.
         #
         # Transactions can be created explicitly with calls to
-        # {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction} or implicitly by setting
-        # [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction] in read requests.
+        # {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}
+        # or implicitly by setting
+        # [ReadOptions.new_transaction][google.datastore.v1.ReadOptions.new_transaction]
+        # in read requests.
         # @!attribute [rw] read_write
         #   @return [::Google::Cloud::Datastore::V1::TransactionOptions::ReadWrite]
         #     The transaction should allow both reads and writes.

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

@@ -43,6 +43,10 @@ module Google
         # @!attribute [rw] project_id
         #   @return [::String]
         #     The ID of the project to which the entities belong.
+        # @!attribute [rw] database_id
+        #   @return [::String]
+        #     If not empty, the ID of the database to which the entities
+        #     belong.
         # @!attribute [rw] namespace_id
         #   @return [::String]
         #     If not empty, the ID of the namespace to which the entities belong.

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

@@ -116,6 +116,96 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Datastore query for running an aggregation over a {::Google::Cloud::Datastore::V1::Query Query}.
+        # @!attribute [rw] nested_query
+        #   @return [::Google::Cloud::Datastore::V1::Query]
+        #     Nested query for aggregation
+        # @!attribute [rw] aggregations
+        #   @return [::Array<::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation>]
+        #     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.
+        class AggregationQuery
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Defines a aggregation that produces a single result.
+          # @!attribute [rw] count
+          #   @return [::Google::Cloud::Datastore::V1::AggregationQuery::Aggregation::Count]
+          #     Count aggregator.
+          # @!attribute [rw] alias
+          #   @return [::String]
+          #     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_<incremental_id++>`. 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 {::Google::Cloud::Datastore::V1::Entity#properties entity property name} limitations.
+          class Aggregation
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # Count of entities that match the query.
+            #
+            # The `COUNT(*)` aggregation function operates on the entire entity
+            # so it does not require a field reference.
+            # @!attribute [rw] up_to
+            #   @return [::Google::Protobuf::Int64Value]
+            #     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.
+            class Count
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
         # A representation of a kind.
         # @!attribute [rw] name
         #   @return [::String]
@@ -187,7 +277,10 @@ module Google
         # @!attribute [rw] filters
         #   @return [::Array<::Google::Cloud::Datastore::V1::Filter>]
         #     The list of filters to combine.
-        #     Must contain at least one filter.
+        #
+        #     Requires:
+        #
+        #     * At least one filter is present.
         class CompositeFilter
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/protobuf/duration.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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 Protobuf
+    # A Duration represents a signed, fixed-length span of time represented
+    # as a count of seconds and fractions of seconds at nanosecond
+    # resolution. It is independent of any calendar and concepts like "day"
+    # or "month". It is related to Timestamp in that the difference between
+    # two Timestamp values is a Duration and it can be added or subtracted
+    # from a Timestamp. Range is approximately +-10,000 years.
+    #
+    # # Examples
+    #
+    # Example 1: Compute Duration from two Timestamps in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Timestamp end = ...;
+    #     Duration duration = ...;
+    #
+    #     duration.seconds = end.seconds - start.seconds;
+    #     duration.nanos = end.nanos - start.nanos;
+    #
+    #     if (duration.seconds < 0 && duration.nanos > 0) {
+    #       duration.seconds += 1;
+    #       duration.nanos -= 1000000000;
+    #     } else if (duration.seconds > 0 && duration.nanos < 0) {
+    #       duration.seconds -= 1;
+    #       duration.nanos += 1000000000;
+    #     }
+    #
+    # Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.
+    #
+    #     Timestamp start = ...;
+    #     Duration duration = ...;
+    #     Timestamp end = ...;
+    #
+    #     end.seconds = start.seconds + duration.seconds;
+    #     end.nanos = start.nanos + duration.nanos;
+    #
+    #     if (end.nanos < 0) {
+    #       end.seconds -= 1;
+    #       end.nanos += 1000000000;
+    #     } else if (end.nanos >= 1000000000) {
+    #       end.seconds += 1;
+    #       end.nanos -= 1000000000;
+    #     }
+    #
+    # Example 3: Compute Duration from datetime.timedelta in Python.
+    #
+    #     td = datetime.timedelta(days=3, minutes=10)
+    #     duration = Duration()
+    #     duration.FromTimedelta(td)
+    #
+    # # JSON Mapping
+    #
+    # In JSON format, the Duration type is encoded as a string rather than an
+    # object, where the string ends in the suffix "s" (indicating seconds) and
+    # is preceded by the number of seconds, with nanoseconds expressed as
+    # fractional seconds. For example, 3 seconds with 0 nanoseconds should be
+    # encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
+    # be expressed in JSON format as "3.000000001s", and 3 seconds and 1
+    # microsecond should be expressed in JSON format as "3.000001s".
+    # @!attribute [rw] seconds
+    #   @return [::Integer]
+    #     Signed seconds of the span of time. Must be from -315,576,000,000
+    #     to +315,576,000,000 inclusive. Note: these bounds are computed from:
+    #     60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    # @!attribute [rw] nanos
+    #   @return [::Integer]
+    #     Signed fractions of a second at nanosecond resolution of the span
+    #     of time. Durations less than one second are represented with a 0
+    #     `seconds` field and a positive or negative `nanos` field. For durations
+    #     of one second or more, a non-zero value for the `nanos` field must be
+    #     of the same sign as the `seconds` field. Must be from -999,999,999
+    #     to +999,999,999 inclusive.
+    class Duration
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-datastore-v1
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-02 00:00:00.000000000 Z
+date: 2023-01-16 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.10'
+        version: 0.16.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 0.16.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -175,16 +175,22 @@ files:
 - lib/google/cloud/datastore/v1/datastore/client.rb
 - lib/google/cloud/datastore/v1/datastore/credentials.rb
 - lib/google/cloud/datastore/v1/version.rb
+- lib/google/datastore/v1/aggregation_result_pb.rb
 - lib/google/datastore/v1/datastore_pb.rb
 - lib/google/datastore/v1/datastore_services_pb.rb
 - lib/google/datastore/v1/entity_pb.rb
 - lib/google/datastore/v1/query_pb.rb
 - proto_docs/README.md
+- proto_docs/google/api/client.rb
 - proto_docs/google/api/field_behavior.rb
+- proto_docs/google/api/launch_stage.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/api/routing.rb
+- proto_docs/google/datastore/v1/aggregation_result.rb
 - proto_docs/google/datastore/v1/datastore.rb
 - proto_docs/google/datastore/v1/entity.rb
 - proto_docs/google/datastore/v1/query.rb
+- proto_docs/google/protobuf/duration.rb
 - proto_docs/google/protobuf/struct.rb
 - proto_docs/google/protobuf/timestamp.rb
 - proto_docs/google/protobuf/wrappers.rb
@@ -208,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.14
+rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
 summary: API Client library for the Firestore in Datastore mode V1 API