google-cloud-datastore-v1 0.1.0

data/proto_docs/README.md

@@ -0,0 +1,4 @@
+# Firestore in Datastore mode V1 Protocol Buffer Documentation
+
+These files are for the YARD documentation of the generated protobuf files.
+They are not intended to be required or loaded at runtime.

data/proto_docs/google/api/field_behavior.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Api
+    # An indicator of the behavior of a given field (for example, that a field
+    # is required in requests, or given as output but ignored as input).
+    # This **does not** change the behavior in protocol buffers itself; it only
+    # denotes the behavior and may affect how API tooling handles the field.
+    #
+    # Note: This enum **may** receive new values in the future.
+    module FieldBehavior
+      # Conventional default for enums. Do not use this.
+      FIELD_BEHAVIOR_UNSPECIFIED = 0
+
+      # Specifically denotes a field as optional.
+      # While all fields in protocol buffers are optional, this may be specified
+      # for emphasis if appropriate.
+      OPTIONAL = 1
+
+      # Denotes a field as required.
+      # This indicates that the field **must** be provided as part of the request,
+      # and failure to do so will cause an error (usually `INVALID_ARGUMENT`).
+      REQUIRED = 2
+
+      # Denotes a field as output only.
+      # This indicates that the field is provided in responses, but including the
+      # field in a request does nothing (the server *must* ignore it and
+      # *must not* throw an error as a result of the field's presence).
+      OUTPUT_ONLY = 3
+
+      # Denotes a field as input only.
+      # This indicates that the field is provided in requests, and the
+      # corresponding field is not included in output.
+      INPUT_ONLY = 4
+
+      # Denotes a field as immutable.
+      # This indicates that the field may be set once in a request to create a
+      # resource, but may not be changed thereafter.
+      IMMUTABLE = 5
+    end
+  end
+end

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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 Api
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/topics/{topic}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #    resources:
+    #    - type: "pubsub.googleapis.com/Topic"
+    #      name_descriptor:
+    #        - pattern: "projects/\\{project}/topics/\\{topic}"
+    #          parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #          parent_name_extractor: "projects/\\{project}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         name_descriptor: {
+    #           pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       name_descriptor:
+    #         - pattern: "projects/{project}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #           parent_name_extractor: "projects/{project}"
+    #         - pattern: "folders/{folder}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #           parent_name_extractor: "folders/{folder}"
+    #         - pattern: "organizations/{organization}/logs/{log}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
+    #           parent_name_extractor: "organizations/{organization}"
+    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #           parent_type: "billing.googleapis.com/BillingAccount"
+    #           parent_name_extractor: "billingAccounts/{billing_account}"
+    #
+    # For flexible resources, the resource name doesn't contain parent names, but
+    # the resource itself has parents for policy evaluation.
+    #
+    # Example:
+    #
+    #     message Shelf {
+    #       option (google.api.resource) = {
+    #         type: "library.googleapis.com/Shelf"
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         }
+    #         name_descriptor: {
+    #           pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #         }
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'library.googleapis.com/Shelf'
+    #       name_descriptor:
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
+    #         - pattern: "shelves/{shelf}"
+    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name, such as 'projects' for
+    #     the name of 'projects/\\{project}'. It is the same concept of the `plural`
+    #     field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #       message ListLogEntriesRequest {
+    #         string parent = 1 [(google.api.resource_reference) = {
+    #           child_type: "logging.googleapis.com/LogEntry"
+    #         };
+    #       }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -0,0 +1,349 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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
+        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#lookup Datastore.Lookup}.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] read_options
+        #   @return [::Google::Cloud::Datastore::V1::ReadOptions]
+        #     The options for this lookup request.
+        # @!attribute [rw] keys
+        #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
+        #     Required. Keys of entities to look up.
+        class LookupRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#lookup Datastore.Lookup}.
+        # @!attribute [rw] found
+        #   @return [::Array<::Google::Cloud::Datastore::V1::EntityResult>]
+        #     Entities found as `ResultType.FULL` entities. The order of results in this
+        #     field is undefined and has no relation to the order of the keys in the
+        #     input.
+        # @!attribute [rw] missing
+        #   @return [::Array<::Google::Cloud::Datastore::V1::EntityResult>]
+        #     Entities not found as `ResultType.KEY_ONLY` entities. The order of results
+        #     in this field is undefined and has no relation to the order of the keys
+        #     in the input.
+        # @!attribute [rw] deferred
+        #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
+        #     A list of keys that were not looked up due to resource constraints. The
+        #     order of results in this field is undefined and has no relation to the
+        #     order of the keys in the input.
+        class LookupResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#run_query Datastore.RunQuery}.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Required. The ID of the project against which to make the request.
+        # @!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] query
+        #   @return [::Google::Cloud::Datastore::V1::Query]
+        #     The query to run.
+        # @!attribute [rw] gql_query
+        #   @return [::Google::Cloud::Datastore::V1::GqlQuery]
+        #     The GQL query to run.
+        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}.
+        # @!attribute [rw] batch
+        #   @return [::Google::Cloud::Datastore::V1::QueryResultBatch]
+        #     A batch of query results (always present).
+        # @!attribute [rw] query
+        #   @return [::Google::Cloud::Datastore::V1::Query]
+        #     The parsed form of the `GqlQuery` from the request, if it was set.
+        class RunQueryResponse
+          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] transaction_options
+        #   @return [::Google::Cloud::Datastore::V1::TransactionOptions]
+        #     Options for a new transaction.
+        class BeginTransactionRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     The transaction identifier (always present).
+        class BeginTransactionResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#rollback Datastore.Rollback}.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     Required. The transaction identifier, returned by a call to
+        #     {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
+        class RollbackRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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
+        end
+
+        # The request for {::Google::Cloud::Datastore::V1::Datastore::Client#commit Datastore.Commit}.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Required. The ID of the project against which to make the request.
+        # @!attribute [rw] mode
+        #   @return [::Google::Cloud::Datastore::V1::CommitRequest::Mode]
+        #     The type of commit to perform. Defaults to `TRANSACTIONAL`.
+        # @!attribute [rw] transaction
+        #   @return [::String]
+        #     The identifier of the transaction associated with the commit. A
+        #     transaction identifier is returned by a call to
+        #     {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
+        # @!attribute [rw] mutations
+        #   @return [::Array<::Google::Cloud::Datastore::V1::Mutation>]
+        #     The mutations to perform.
+        #
+        #     When mode is `TRANSACTIONAL`, mutations affecting a single entity are
+        #     applied in order. The following sequences of mutations affecting a single
+        #     entity are not permitted in a single `Commit` request:
+        #
+        #     - `insert` followed by `insert`
+        #     - `update` followed by `insert`
+        #     - `upsert` followed by `insert`
+        #     - `delete` followed by `update`
+        #
+        #     When mode is `NON_TRANSACTIONAL`, no two mutations may affect a single
+        #     entity.
+        class CommitRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The modes available for commits.
+          module Mode
+            # Unspecified. This value must not be used.
+            MODE_UNSPECIFIED = 0
+
+            # Transactional: The mutations are either all applied, or none are applied.
+            # Learn about transactions
+            # [here](https://cloud.google.com/datastore/docs/concepts/transactions).
+            TRANSACTIONAL = 1
+
+            # Non-transactional: The mutations may not apply as all or none.
+            NON_TRANSACTIONAL = 2
+          end
+        end
+
+        # The response for {::Google::Cloud::Datastore::V1::Datastore::Client#commit Datastore.Commit}.
+        # @!attribute [rw] mutation_results
+        #   @return [::Array<::Google::Cloud::Datastore::V1::MutationResult>]
+        #     The result of performing the mutations.
+        #     The i-th mutation result corresponds to the i-th mutation in the request.
+        # @!attribute [rw] index_updates
+        #   @return [::Integer]
+        #     The number of index entries updated during the commit, or zero if none were
+        #     updated.
+        class CommitResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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] 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.
+        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}.
+        # @!attribute [rw] keys
+        #   @return [::Array<::Google::Cloud::Datastore::V1::Key>]
+        #     The keys specified in the request (in the same order), each with
+        #     its key path completed with a newly allocated ID.
+        class AllocateIdsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!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.
+        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}.
+        class ReserveIdsResponse
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # A mutation to apply to an entity.
+        # @!attribute [rw] insert
+        #   @return [::Google::Cloud::Datastore::V1::Entity]
+        #     The entity to insert. The entity must not already exist.
+        #     The entity key's final path element may be incomplete.
+        # @!attribute [rw] update
+        #   @return [::Google::Cloud::Datastore::V1::Entity]
+        #     The entity to update. The entity must already exist.
+        #     Must have a complete key path.
+        # @!attribute [rw] upsert
+        #   @return [::Google::Cloud::Datastore::V1::Entity]
+        #     The entity to upsert. The entity may or may not already exist.
+        #     The entity key's final path element may be incomplete.
+        # @!attribute [rw] delete
+        #   @return [::Google::Cloud::Datastore::V1::Key]
+        #     The key of the entity to delete. The entity may or may not already exist.
+        #     Must have a complete key path and must not be reserved/read-only.
+        # @!attribute [rw] base_version
+        #   @return [::Integer]
+        #     The version of the entity that this mutation is being applied to. If this
+        #     does not match the current version on the server, the mutation conflicts.
+        class Mutation
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The result of applying a mutation.
+        # @!attribute [rw] key
+        #   @return [::Google::Cloud::Datastore::V1::Key]
+        #     The automatically allocated key.
+        #     Set only when the mutation allocated a key.
+        # @!attribute [rw] version
+        #   @return [::Integer]
+        #     The version of the entity on the server after processing the mutation. If
+        #     the mutation doesn't change anything on the server, then the version will
+        #     be the version of the current entity or, if no entity is present, a version
+        #     that is strictly greater than the version of any previous entity and less
+        #     than the version of any possible future entity.
+        # @!attribute [rw] conflict_detected
+        #   @return [::Boolean]
+        #     Whether a conflict was detected for this mutation. Always false when a
+        #     conflict detection strategy field is not set in the mutation.
+        class MutationResult
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The options shared by read requests.
+        # @!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
+        #     transaction identifier is returned by a call to
+        #     {::Google::Cloud::Datastore::V1::Datastore::Client#begin_transaction Datastore.BeginTransaction}.
+        class ReadOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The possible values for read consistencies.
+          module ReadConsistency
+            # Unspecified. This value must not be used.
+            READ_CONSISTENCY_UNSPECIFIED = 0
+
+            # Strong consistency.
+            STRONG = 1
+
+            # Eventual consistency.
+            EVENTUAL = 2
+          end
+        end
+
+        # 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.
+        # @!attribute [rw] read_write
+        #   @return [::Google::Cloud::Datastore::V1::TransactionOptions::ReadWrite]
+        #     The transaction should allow both reads and writes.
+        # @!attribute [rw] read_only
+        #   @return [::Google::Cloud::Datastore::V1::TransactionOptions::ReadOnly]
+        #     The transaction should only allow reads.
+        class TransactionOptions
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Options specific to read / write transactions.
+          # @!attribute [rw] previous_transaction
+          #   @return [::String]
+          #     The transaction identifier of the transaction being retried.
+          class ReadWrite
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Options specific to read-only transactions.
+          class ReadOnly
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end