# 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] 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. # @!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. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # The time at which these entities were read or found missing. 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] 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] 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. 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}. # @!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#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. 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] 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 # {::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] 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`. # @!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. # @!attribute [rw] commit_time # @return [::Google::Protobuf::Timestamp] # The transaction commit timestamp. Not set for non-transactional commits. 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] 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. 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] # 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. 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. # @!attribute [rw] update_time # @return [::Google::Protobuf::Timestamp] # The update time of the entity that this mutation is being applied # to. If this does not match the current update time 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] update_time # @return [::Google::Protobuf::Timestamp] # 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 'delete'. # @!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. # @!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}. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Reads entities as they were at the given time. This may not be older # than 270 seconds. This value is only supported for Cloud Firestore in # Datastore mode. 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. # @!attribute [rw] read_time # @return [::Google::Protobuf::Timestamp] # Reads entities at the given time. # This may not be older than 60 seconds. class ReadOnly include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end end end end