google-apis-datastore_v1 0.38.0 → 0.40.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e3e24d9ab67d083ae2b294ce049c40f1d017b0019cf750771876132af95fcc4
-  data.tar.gz: 49069a3e3c143b52ec6524ea4fb947061ef0ed2cae511a93e8bdc5d586bc5af4
+  metadata.gz: 3948fb01c0e464276aa4b17a4344ea876f15d8a10ded3c0536bf4d8ba1d4ec85
+  data.tar.gz: 99caa454d159919e03b173038ee3c015a4f60ef14293f2f706aeaff166dbdb71
 SHA512:
-  metadata.gz: 57ad4d171ead6e441457c88827d4b87e8e38a0f782ecc01c5b1fe7b8a56b5a775208be073d2a68c33be91702a4d2a6a06a5c26d9559f574662212b0e6be5e4cf
-  data.tar.gz: 1eaeb92ba96fb9a99e0b1b87a641cde5a02ffb17bccf0bedf113fc2e7be36d19f8a487d99c39deaa4243d5d58941d01dc2780237dd889fd2945430178de59d98
+  metadata.gz: 8f3317a8ac15315ad8eddb7d91202631446f5f7ebdf8729ad6c191bc64c68fe59412aad48442d7e053294babc56f2efedc3fede8cbdfbd9b95410967a8f67660
+  data.tar.gz: 70975e6ae0581b75dae441657dc8df94e40cd2aa646b1687e4473b45bc9f481a75afd70de80f75a8c8f28670bd4fd43ab03ca6ca97f977f56807ef11caf83a4f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Release history for google-apis-datastore_v1
 
+### v0.40.0 (2024-11-03)
+
+* Regenerated from discovery document revision 20241018
+
+### v0.39.0 (2024-10-20)
+
+* Regenerated from discovery document revision 20241008
+* Regenerated using generator version 0.15.1
+
 ### v0.38.0 (2024-05-19)
 
 * Regenerated using generator version 0.15.0

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

@@ -94,7 +94,9 @@ module Google
         # @return [Array<Google::Apis::DatastoreV1::Aggregation>]
         attr_accessor :aggregations
       
-        # A query for entities.
+        # A query for entities. The query stages are executed in the following order: 1.
+        # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+        # limit 7. find_nearest
         # Corresponds to the JSON property `nestedQuery`
         # @return [Google::Apis::DatastoreV1::Query]
         attr_accessor :nested_query
@@ -654,6 +656,66 @@ module Google
         end
       end
       
+      # Nearest Neighbors search config. The ordering provided by FindNearest
+      # supersedes the order_by stage. If multiple documents have the same vector
+      # distance, the returned document order is not guaranteed to be stable between
+      # queries.
+      class FindNearest
+        include Google::Apis::Core::Hashable
+      
+        # Required. The Distance Measure to use, required.
+        # Corresponds to the JSON property `distanceMeasure`
+        # @return [String]
+        attr_accessor :distance_measure
+      
+        # Optional. Optional name of the field to output the result of the vector
+        # distance calculation. Must conform to entity property limitations.
+        # Corresponds to the JSON property `distanceResultProperty`
+        # @return [String]
+        attr_accessor :distance_result_property
+      
+        # Optional. Option to specify a threshold for which no less similar documents
+        # will be returned. The behavior of the specified `distance_measure` will affect
+        # the meaning of the distance threshold. Since DOT_PRODUCT distances increase
+        # when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN,
+        # COSINE: WHERE distance <= distance_threshold * For DOT_PRODUCT: WHERE
+        # distance >= distance_threshold
+        # Corresponds to the JSON property `distanceThreshold`
+        # @return [Float]
+        attr_accessor :distance_threshold
+      
+        # Required. The number of nearest neighbors to return. Must be a positive
+        # integer of no more than 100.
+        # Corresponds to the JSON property `limit`
+        # @return [Fixnum]
+        attr_accessor :limit
+      
+        # A message that can hold any of the supported value types and associated
+        # metadata.
+        # Corresponds to the JSON property `queryVector`
+        # @return [Google::Apis::DatastoreV1::Value]
+        attr_accessor :query_vector
+      
+        # A reference to a property relative to the kind expressions.
+        # Corresponds to the JSON property `vectorProperty`
+        # @return [Google::Apis::DatastoreV1::PropertyReference]
+        attr_accessor :vector_property
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @distance_measure = args[:distance_measure] if args.key?(:distance_measure)
+          @distance_result_property = args[:distance_result_property] if args.key?(:distance_result_property)
+          @distance_threshold = args[:distance_threshold] if args.key?(:distance_threshold)
+          @limit = args[:limit] if args.key?(:limit)
+          @query_vector = args[:query_vector] if args.key?(:query_vector)
+          @vector_property = args[:vector_property] if args.key?(:vector_property)
+        end
+      end
+      
       # Metadata common to all Datastore Admin operations.
       class GoogleDatastoreAdminV1CommonMetadata
         include Google::Apis::Core::Hashable
@@ -1827,6 +1889,12 @@ module Google
         # @return [Fixnum]
         attr_accessor :base_version
       
+        # The strategy to use when a conflict is detected. Defaults to `SERVER_VALUE`.
+        # If this is set, then `conflict_detection_strategy` must also be set.
+        # Corresponds to the JSON property `conflictResolutionStrategy`
+        # @return [String]
+        attr_accessor :conflict_resolution_strategy
+      
         # A unique identifier for an entity. If a key's partition ID or any of its path
         # kinds or names are reserved/read-only, the key is reserved/read-only. A
         # reserved/read-only key is forbidden in certain documented contexts.
@@ -1845,6 +1913,14 @@ module Google
         # @return [Google::Apis::DatastoreV1::PropertyMask]
         attr_accessor :property_mask
       
+        # Optional. The transforms to perform on the entity. This field can be set only
+        # when the operation is `insert`, `update`, or `upsert`. If present, the
+        # transforms are be applied to the entity regardless of the property mask, in
+        # order, after the operation.
+        # Corresponds to the JSON property `propertyTransforms`
+        # @return [Array<Google::Apis::DatastoreV1::PropertyTransform>]
+        attr_accessor :property_transforms
+      
         # A Datastore data object. Must not exceed 1 MiB - 4 bytes.
         # Corresponds to the JSON property `update`
         # @return [Google::Apis::DatastoreV1::Entity]
@@ -1868,9 +1944,11 @@ module Google
         # Update properties of this object
         def update!(**args)
           @base_version = args[:base_version] if args.key?(:base_version)
+          @conflict_resolution_strategy = args[:conflict_resolution_strategy] if args.key?(:conflict_resolution_strategy)
           @delete = args[:delete] if args.key?(:delete)
           @insert = args[:insert] if args.key?(:insert)
           @property_mask = args[:property_mask] if args.key?(:property_mask)
+          @property_transforms = args[:property_transforms] if args.key?(:property_transforms)
           @update = args[:update] if args.key?(:update)
           @update_time = args[:update_time] if args.key?(:update_time)
           @upsert = args[:upsert] if args.key?(:upsert)
@@ -1900,6 +1978,12 @@ module Google
         # @return [Google::Apis::DatastoreV1::Key]
         attr_accessor :key
       
+        # The results of applying each PropertyTransform, in the same order of the
+        # request.
+        # Corresponds to the JSON property `transformResults`
+        # @return [Array<Google::Apis::DatastoreV1::Value>]
+        attr_accessor :transform_results
+      
         # The update time of the entity on the server after processing the mutation. If
         # the mutation doesn't change anything on the server, then the timestamp will be
         # the update timestamp of the current entity. This field will not be set after a
@@ -1926,6 +2010,7 @@ module Google
           @conflict_detected = args[:conflict_detected] if args.key?(:conflict_detected)
           @create_time = args[:create_time] if args.key?(:create_time)
           @key = args[:key] if args.key?(:key)
+          @transform_results = args[:transform_results] if args.key?(:transform_results)
           @update_time = args[:update_time] if args.key?(:update_time)
           @version = args[:version] if args.key?(:version)
         end
@@ -2152,7 +2237,71 @@ module Google
         end
       end
       
-      # A query for entities.
+      # A transformation of an entity property.
+      class PropertyTransform
+        include Google::Apis::Core::Hashable
+      
+        # An array value.
+        # Corresponds to the JSON property `appendMissingElements`
+        # @return [Google::Apis::DatastoreV1::ArrayValue]
+        attr_accessor :append_missing_elements
+      
+        # A message that can hold any of the supported value types and associated
+        # metadata.
+        # Corresponds to the JSON property `increment`
+        # @return [Google::Apis::DatastoreV1::Value]
+        attr_accessor :increment
+      
+        # A message that can hold any of the supported value types and associated
+        # metadata.
+        # Corresponds to the JSON property `maximum`
+        # @return [Google::Apis::DatastoreV1::Value]
+        attr_accessor :maximum
+      
+        # A message that can hold any of the supported value types and associated
+        # metadata.
+        # Corresponds to the JSON property `minimum`
+        # @return [Google::Apis::DatastoreV1::Value]
+        attr_accessor :minimum
+      
+        # Optional. The name of the property. Property paths (a list of property names
+        # separated by dots (`.`)) may be used to refer to properties inside entity
+        # values. For example `foo.bar` means the property `bar` inside the entity
+        # property `foo`. If a property name contains a dot `.` or a backlslash `\`,
+        # then that name must be escaped.
+        # Corresponds to the JSON property `property`
+        # @return [String]
+        attr_accessor :property
+      
+        # An array value.
+        # Corresponds to the JSON property `removeAllFromArray`
+        # @return [Google::Apis::DatastoreV1::ArrayValue]
+        attr_accessor :remove_all_from_array
+      
+        # Sets the property to the given server value.
+        # Corresponds to the JSON property `setToServerValue`
+        # @return [String]
+        attr_accessor :set_to_server_value
+      
+        def initialize(**args)
+           update!(**args)
+        end
+      
+        # Update properties of this object
+        def update!(**args)
+          @append_missing_elements = args[:append_missing_elements] if args.key?(:append_missing_elements)
+          @increment = args[:increment] if args.key?(:increment)
+          @maximum = args[:maximum] if args.key?(:maximum)
+          @minimum = args[:minimum] if args.key?(:minimum)
+          @property = args[:property] if args.key?(:property)
+          @remove_all_from_array = args[:remove_all_from_array] if args.key?(:remove_all_from_array)
+          @set_to_server_value = args[:set_to_server_value] if args.key?(:set_to_server_value)
+        end
+      end
+      
+      # A query for entities. The query stages are executed in the following order: 1.
+      # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+      # limit 7. find_nearest
       class Query
         include Google::Apis::Core::Hashable
       
@@ -2178,6 +2327,14 @@ module Google
         # @return [Google::Apis::DatastoreV1::Filter]
         attr_accessor :filter
       
+        # Nearest Neighbors search config. The ordering provided by FindNearest
+        # supersedes the order_by stage. If multiple documents have the same vector
+        # distance, the returned document order is not guaranteed to be stable between
+        # queries.
+        # Corresponds to the JSON property `findNearest`
+        # @return [Google::Apis::DatastoreV1::FindNearest]
+        attr_accessor :find_nearest
+      
         # The kinds to query (if empty, returns entities of all kinds). Currently at
         # most 1 kind may be specified.
         # Corresponds to the JSON property `kind`
@@ -2223,6 +2380,7 @@ module Google
           @distinct_on = args[:distinct_on] if args.key?(:distinct_on)
           @end_cursor = args[:end_cursor] if args.key?(:end_cursor)
           @filter = args[:filter] if args.key?(:filter)
+          @find_nearest = args[:find_nearest] if args.key?(:find_nearest)
           @kind = args[:kind] if args.key?(:kind)
           @limit = args[:limit] if args.key?(:limit)
           @offset = args[:offset] if args.key?(:offset)
@@ -2613,7 +2771,9 @@ module Google
         # @return [Google::Apis::DatastoreV1::PropertyMask]
         attr_accessor :property_mask
       
-        # A query for entities.
+        # A query for entities. The query stages are executed in the following order: 1.
+        # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+        # limit 7. find_nearest
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::Query]
         attr_accessor :query
@@ -2653,7 +2813,9 @@ module Google
         # @return [Google::Apis::DatastoreV1::ExplainMetrics]
         attr_accessor :explain_metrics
       
-        # A query for entities.
+        # A query for entities. The query stages are executed in the following order: 1.
+        # kind 2. filter 3. projection 4. order + start_cursor + end_cursor 5. offset 6.
+        # limit 7. find_nearest
         # Corresponds to the JSON property `query`
         # @return [Google::Apis::DatastoreV1::Query]
         attr_accessor :query

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.38.0"
+      GEM_VERSION = "0.40.0"
 
       # Version of the code generator used to generate this client
-      GENERATOR_VERSION = "0.15.0"
+      GENERATOR_VERSION = "0.15.1"
 
       # Revision of the discovery document this client was generated from
-      REVISION = "20240317"
+      REVISION = "20241018"
     end
   end
 end

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

@@ -148,6 +148,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class FindNearest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class GoogleDatastoreAdminV1CommonMetadata
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -400,6 +406,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class PropertyTransform
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Query
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -696,6 +708,20 @@ module Google
         end
       end
       
+      class FindNearest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :distance_measure, as: 'distanceMeasure'
+          property :distance_result_property, as: 'distanceResultProperty'
+          property :distance_threshold, as: 'distanceThreshold'
+          property :limit, as: 'limit'
+          property :query_vector, as: 'queryVector', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
+          property :vector_property, as: 'vectorProperty', class: Google::Apis::DatastoreV1::PropertyReference, decorator: Google::Apis::DatastoreV1::PropertyReference::Representation
+      
+        end
+      end
+      
       class GoogleDatastoreAdminV1CommonMetadata
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1023,12 +1049,15 @@ module Google
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
           property :base_version, :numeric_string => true, as: 'baseVersion'
+          property :conflict_resolution_strategy, as: 'conflictResolutionStrategy'
           property :delete, as: 'delete', class: Google::Apis::DatastoreV1::Key, decorator: Google::Apis::DatastoreV1::Key::Representation
       
           property :insert, as: 'insert', class: Google::Apis::DatastoreV1::Entity, decorator: Google::Apis::DatastoreV1::Entity::Representation
       
           property :property_mask, as: 'propertyMask', class: Google::Apis::DatastoreV1::PropertyMask, decorator: Google::Apis::DatastoreV1::PropertyMask::Representation
       
+          collection :property_transforms, as: 'propertyTransforms', class: Google::Apis::DatastoreV1::PropertyTransform, decorator: Google::Apis::DatastoreV1::PropertyTransform::Representation
+      
           property :update, as: 'update', class: Google::Apis::DatastoreV1::Entity, decorator: Google::Apis::DatastoreV1::Entity::Representation
       
           property :update_time, as: 'updateTime'
@@ -1044,6 +1073,8 @@ module Google
           property :create_time, as: 'createTime'
           property :key, as: 'key', class: Google::Apis::DatastoreV1::Key, decorator: Google::Apis::DatastoreV1::Key::Representation
       
+          collection :transform_results, as: 'transformResults', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
           property :update_time, as: 'updateTime'
           property :version, :numeric_string => true, as: 'version'
         end
@@ -1116,6 +1147,24 @@ module Google
         end
       end
       
+      class PropertyTransform
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :append_missing_elements, as: 'appendMissingElements', class: Google::Apis::DatastoreV1::ArrayValue, decorator: Google::Apis::DatastoreV1::ArrayValue::Representation
+      
+          property :increment, as: 'increment', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
+          property :maximum, as: 'maximum', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
+          property :minimum, as: 'minimum', class: Google::Apis::DatastoreV1::Value, decorator: Google::Apis::DatastoreV1::Value::Representation
+      
+          property :property, as: 'property'
+          property :remove_all_from_array, as: 'removeAllFromArray', class: Google::Apis::DatastoreV1::ArrayValue, decorator: Google::Apis::DatastoreV1::ArrayValue::Representation
+      
+          property :set_to_server_value, as: 'setToServerValue'
+        end
+      end
+      
       class Query
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1124,6 +1173,8 @@ module Google
           property :end_cursor, :base64 => true, as: 'endCursor'
           property :filter, as: 'filter', class: Google::Apis::DatastoreV1::Filter, decorator: Google::Apis::DatastoreV1::Filter::Representation
       
+          property :find_nearest, as: 'findNearest', class: Google::Apis::DatastoreV1::FindNearest, decorator: Google::Apis::DatastoreV1::FindNearest::Representation
+      
           collection :kind, as: 'kind', class: Google::Apis::DatastoreV1::KindExpression, decorator: Google::Apis::DatastoreV1::KindExpression::Representation
       
           property :limit, as: 'limit'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-apis-datastore_v1
 version: !ruby/object:Gem::Version
-  version: 0.38.0
+  version: 0.40.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-26 00:00:00.000000000 Z
+date: 2024-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
   changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datastore_v1/CHANGELOG.md
-  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.38.0
+  documentation_uri: https://googleapis.dev/ruby/google-apis-datastore_v1/v0.40.0
   source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-datastore_v1
 post_install_message: 
 rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.21
 signing_key: 
 specification_version: 4
 summary: Simple REST client for Cloud Datastore API V1