google-cloud-datastore 1.8.2 → 2.0.0

data/lib/google/cloud/datastore/v1/datastore_client_config.json

@@ -1,61 +0,0 @@
-{
-  "interfaces": {
-    "google.datastore.v1.Datastore": {
-      "retry_codes": {
-        "idempotent": [
-          "DEADLINE_EXCEEDED",
-          "UNAVAILABLE"
-        ],
-        "non_idempotent": []
-      },
-      "retry_params": {
-        "default": {
-          "initial_retry_delay_millis": 100,
-          "retry_delay_multiplier": 1.3,
-          "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 60000,
-          "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 60000,
-          "total_timeout_millis": 600000
-        }
-      },
-      "methods": {
-        "Lookup": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "RunQuery": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "ReserveIds": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "BeginTransaction": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "Commit": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "Rollback": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "AllocateIds": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        }
-      }
-    }
-  }
-}

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/datastore.rb

@@ -1,283 +0,0 @@
-# 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.
-
-
-module Google
-  module Datastore
-    module V1
-      # The request for {Google::Datastore::V1::Datastore::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::Datastore::V1::ReadOptions]
-      #     The options for this lookup request.
-      # @!attribute [rw] keys
-      #   @return [Array<Google::Datastore::V1::Key>]
-      #     Required. Keys of entities to look up.
-      class LookupRequest; end
-
-      # The response for {Google::Datastore::V1::Datastore::Lookup Datastore::Lookup}.
-      # @!attribute [rw] found
-      #   @return [Array<Google::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::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::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; end
-
-      # The request for {Google::Datastore::V1::Datastore::RunQuery 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::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::Datastore::V1::ReadOptions]
-      #     The options for this query.
-      # @!attribute [rw] query
-      #   @return [Google::Datastore::V1::Query]
-      #     The query to run.
-      # @!attribute [rw] gql_query
-      #   @return [Google::Datastore::V1::GqlQuery]
-      #     The GQL query to run.
-      class RunQueryRequest; end
-
-      # The response for {Google::Datastore::V1::Datastore::RunQuery Datastore::RunQuery}.
-      # @!attribute [rw] batch
-      #   @return [Google::Datastore::V1::QueryResultBatch]
-      #     A batch of query results (always present).
-      # @!attribute [rw] query
-      #   @return [Google::Datastore::V1::Query]
-      #     The parsed form of the `GqlQuery` from the request, if it was set.
-      class RunQueryResponse; end
-
-      # The request for {Google::Datastore::V1::Datastore::BeginTransaction 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::Datastore::V1::TransactionOptions]
-      #     Options for a new transaction.
-      class BeginTransactionRequest; end
-
-      # The response for {Google::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
-      # @!attribute [rw] transaction
-      #   @return [String]
-      #     The transaction identifier (always present).
-      class BeginTransactionResponse; end
-
-      # The request for {Google::Datastore::V1::Datastore::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::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
-      class RollbackRequest; end
-
-      # The response for {Google::Datastore::V1::Datastore::Rollback Datastore::Rollback}.
-      # (an empty message).
-      class RollbackResponse; end
-
-      # The request for {Google::Datastore::V1::Datastore::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::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::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
-      # @!attribute [rw] mutations
-      #   @return [Array<Google::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
-        # 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::Datastore::V1::Datastore::Commit Datastore::Commit}.
-      # @!attribute [rw] mutation_results
-      #   @return [Array<Google::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; end
-
-      # The request for {Google::Datastore::V1::Datastore::AllocateIds 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::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; end
-
-      # The response for {Google::Datastore::V1::Datastore::AllocateIds Datastore::AllocateIds}.
-      # @!attribute [rw] keys
-      #   @return [Array<Google::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; end
-
-      # The request for {Google::Datastore::V1::Datastore::ReserveIds 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::Datastore::V1::Key>]
-      #     Required. A list of keys with complete key paths whose numeric IDs should not be
-      #     auto-allocated.
-      class ReserveIdsRequest; end
-
-      # The response for {Google::Datastore::V1::Datastore::ReserveIds Datastore::ReserveIds}.
-      class ReserveIdsResponse; end
-
-      # A mutation to apply to an entity.
-      # @!attribute [rw] insert
-      #   @return [Google::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::Datastore::V1::Entity]
-      #     The entity to update. The entity must already exist.
-      #     Must have a complete key path.
-      # @!attribute [rw] upsert
-      #   @return [Google::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::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; end
-
-      # The result of applying a mutation.
-      # @!attribute [rw] key
-      #   @return [Google::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 [true, false]
-      #     Whether a conflict was detected for this mutation. Always false when a
-      #     conflict detection strategy field is not set in the mutation.
-      class MutationResult; end
-
-      # The options shared by read requests.
-      # @!attribute [rw] read_consistency
-      #   @return [Google::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::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction}.
-      class ReadOptions
-        # 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::Datastore::V1::Datastore::BeginTransaction Datastore::BeginTransaction} or implicitly by setting
-      # {Google::Datastore::V1::ReadOptions#new_transaction ReadOptions#new_transaction} in read requests.
-      # @!attribute [rw] read_write
-      #   @return [Google::Datastore::V1::TransactionOptions::ReadWrite]
-      #     The transaction should allow both reads and writes.
-      # @!attribute [rw] read_only
-      #   @return [Google::Datastore::V1::TransactionOptions::ReadOnly]
-      #     The transaction should only allow reads.
-      class TransactionOptions
-        # Options specific to read / write transactions.
-        # @!attribute [rw] previous_transaction
-        #   @return [String]
-        #     The transaction identifier of the transaction being retried.
-        class ReadWrite; end
-
-        # Options specific to read-only transactions.
-        class ReadOnly; end
-      end
-    end
-  end
-end

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/entity.rb

@@ -1,189 +0,0 @@
-# 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.
-
-
-module Google
-  module Datastore
-    module V1
-      # A partition ID identifies a grouping of entities. The grouping is always
-      # by project and namespace, however the namespace ID may be empty.
-      #
-      # A partition ID contains several dimensions:
-      # project ID and namespace ID.
-      #
-      # Partition dimensions:
-      #
-      # * May be `""`.
-      # * Must be valid UTF-8 bytes.
-      # * Must have values that match regex `[A-Za-z\d\.\-_]{1,100}`
-      #   If the value of any dimension matches regex `__.*__`, the partition is
-      #   reserved/read-only.
-      #   A reserved/read-only partition ID is forbidden in certain documented
-      #   contexts.
-      #
-      # Foreign partition IDs (in which the project ID does
-      # not match the context project ID ) are discouraged.
-      # Reads and writes of foreign partition IDs may fail if the project is not in
-      # an active state.
-      # @!attribute [rw] project_id
-      #   @return [String]
-      #     The ID of the project to which the entities belong.
-      # @!attribute [rw] namespace_id
-      #   @return [String]
-      #     If not empty, the ID of the namespace to which the entities belong.
-      class PartitionId; end
-
-      # 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.
-      # @!attribute [rw] partition_id
-      #   @return [Google::Datastore::V1::PartitionId]
-      #     Entities are partitioned into subsets, currently identified by a project
-      #     ID and namespace ID.
-      #     Queries are scoped to a single partition.
-      # @!attribute [rw] path
-      #   @return [Array<Google::Datastore::V1::Key::PathElement>]
-      #     The entity path.
-      #     An entity path consists of one or more elements composed of a kind and a
-      #     string or numerical identifier, which identify entities. The first
-      #     element identifies a _root entity_, the second element identifies
-      #     a _child_ of the root entity, the third element identifies a child of the
-      #     second entity, and so forth. The entities identified by all prefixes of
-      #     the path are called the element's _ancestors_.
-      #
-      #     An entity path is always fully complete: *all* of the entity's ancestors
-      #     are required to be in the path along with the entity identifier itself.
-      #     The only exception is that in some documented cases, the identifier in the
-      #     last path element (for the entity) itself may be omitted. For example,
-      #     the last path element of the key of `Mutation.insert` may have no
-      #     identifier.
-      #
-      #     A path can never be empty, and a path can have at most 100 elements.
-      class Key
-        # A (kind, ID/name) pair used to construct a key path.
-        #
-        # If either name or ID is set, the element is complete.
-        # If neither is set, the element is incomplete.
-        # @!attribute [rw] kind
-        #   @return [String]
-        #     The kind of the entity.
-        #     A kind matching regex `__.*__` is reserved/read-only.
-        #     A kind must not contain more than 1500 bytes when UTF-8 encoded.
-        #     Cannot be `""`.
-        # @!attribute [rw] id
-        #   @return [Integer]
-        #     The auto-allocated ID of the entity.
-        #     Never equal to zero. Values less than zero are discouraged and may not
-        #     be supported in the future.
-        # @!attribute [rw] name
-        #   @return [String]
-        #     The name of the entity.
-        #     A name matching regex `__.*__` is reserved/read-only.
-        #     A name must not be more than 1500 bytes when UTF-8 encoded.
-        #     Cannot be `""`.
-        class PathElement; end
-      end
-
-      # An array value.
-      # @!attribute [rw] values
-      #   @return [Array<Google::Datastore::V1::Value>]
-      #     Values in the array.
-      #     The order of values in an array is preserved as long as all values have
-      #     identical settings for 'exclude_from_indexes'.
-      class ArrayValue; end
-
-      # A message that can hold any of the supported value types and associated
-      # metadata.
-      # @!attribute [rw] null_value
-      #   @return [Google::Protobuf::NullValue]
-      #     A null value.
-      # @!attribute [rw] boolean_value
-      #   @return [true, false]
-      #     A boolean value.
-      # @!attribute [rw] integer_value
-      #   @return [Integer]
-      #     An integer value.
-      # @!attribute [rw] double_value
-      #   @return [Float]
-      #     A double value.
-      # @!attribute [rw] timestamp_value
-      #   @return [Google::Protobuf::Timestamp]
-      #     A timestamp value.
-      #     When stored in the Datastore, precise only to microseconds;
-      #     any additional precision is rounded down.
-      # @!attribute [rw] key_value
-      #   @return [Google::Datastore::V1::Key]
-      #     A key value.
-      # @!attribute [rw] string_value
-      #   @return [String]
-      #     A UTF-8 encoded string value.
-      #     When `exclude_from_indexes` is false (it is indexed), may have at most
-      #     1500 bytes. Otherwise, may be set to at most 1,000,000 bytes.
-      # @!attribute [rw] blob_value
-      #   @return [String]
-      #     A blob value.
-      #     May have at most 1,000,000 bytes.
-      #     When `exclude_from_indexes` is false, may have at most 1500 bytes.
-      #     In JSON requests, must be base64-encoded.
-      # @!attribute [rw] geo_point_value
-      #   @return [Google::Type::LatLng]
-      #     A geo point value representing a point on the surface of Earth.
-      # @!attribute [rw] entity_value
-      #   @return [Google::Datastore::V1::Entity]
-      #     An entity value.
-      #
-      #     * May have no key.
-      #     * May have a key with an incomplete key path.
-      #     * May have a reserved/read-only key.
-      # @!attribute [rw] array_value
-      #   @return [Google::Datastore::V1::ArrayValue]
-      #     An array value.
-      #     Cannot contain another array value.
-      #     A `Value` instance that sets field `array_value` must not set fields
-      #     `meaning` or `exclude_from_indexes`.
-      # @!attribute [rw] meaning
-      #   @return [Integer]
-      #     The `meaning` field should only be populated for backwards compatibility.
-      # @!attribute [rw] exclude_from_indexes
-      #   @return [true, false]
-      #     If the value should be excluded from all indexes including those defined
-      #     explicitly.
-      class Value; end
-
-      # A Datastore data object.
-      #
-      # An entity is limited to 1 megabyte when stored. That _roughly_
-      # corresponds to a limit of 1 megabyte for the serialized form of this
-      # message.
-      # @!attribute [rw] key
-      #   @return [Google::Datastore::V1::Key]
-      #     The entity's key.
-      #
-      #     An entity must have a key, unless otherwise documented (for example,
-      #     an entity in `Value.entity_value` may have no key).
-      #     An entity's kind is its key path's last element's kind,
-      #     or null if it has no key.
-      # @!attribute [rw] properties
-      #   @return [Hash{String => Google::Datastore::V1::Value}]
-      #     The entity's properties.
-      #     The map's keys are property names.
-      #     A property name matching regex `__.*__` is reserved.
-      #     A reserved property name is forbidden in certain documented contexts.
-      #     The name must not contain more than 500 characters.
-      #     The name cannot be `""`.
-      class Entity; end
-    end
-  end
-end