google-cloud-firestore 1.4.1 → 2.1.0

data/lib/google/cloud/firestore/admin/v1/firestore_admin_client_config.json

@@ -1,71 +0,0 @@
-{
-  "interfaces": {
-    "google.firestore.admin.v1.FirestoreAdmin": {
-      "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": {
-        "DeleteIndex": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "UpdateField": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "CreateIndex": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "ListIndexes": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "GetIndex": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "GetField": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "ListFields": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "idempotent",
-          "retry_params_name": "default"
-        },
-        "ExportDocuments": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "ImportDocuments": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        }
-      }
-    }
-  }
-}

data/lib/google/cloud/firestore/v1.rb

@@ -1,152 +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.
-
-
-require "google/cloud/firestore/v1/firestore_client"
-
-module Google
-  module Cloud
-    module Firestore
-      # rubocop:disable LineLength
-
-      ##
-      # # Ruby Client for Google Cloud Firestore API
-      #
-      # [Google Cloud Firestore API][Product Documentation]:
-      #
-      # - [Product Documentation][]
-      #
-      # ## Quick Start
-      # In order to use this library, you first need to go through the following
-      # steps:
-      #
-      # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
-      # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
-      # 3. [Enable the Google Cloud Firestore API.](https://console.cloud.google.com/apis/library/firestore.googleapis.com)
-      # 4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-firestore/latest/file.AUTHENTICATION.html)
-      #
-      # ### Installation
-      # ```
-      # $ gem install google-cloud-firestore
-      # ```
-      #
-      # ### Next Steps
-      # - Read the [Google Cloud Firestore API Product documentation][Product Documentation]
-      #   to learn more about the product and see How-to Guides.
-      # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
-      #   to see the full list of Cloud APIs that we cover.
-      #
-      # [Product Documentation]: https://cloud.google.com/firestore
-      #
-      # ## Enabling Logging
-      #
-      # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-      # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
-      # or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
-      # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-      # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-      #
-      # Configuring a Ruby stdlib logger:
-      #
-      # ```ruby
-      # require "logger"
-      #
-      # module MyLogger
-      #   LOGGER = Logger.new $stderr, level: Logger::WARN
-      #   def logger
-      #     LOGGER
-      #   end
-      # end
-      #
-      # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-      # module GRPC
-      #   extend MyLogger
-      # end
-      # ```
-      #
-      module V1
-        # rubocop:enable LineLength
-
-        ##
-        # The Cloud Firestore service.
-        #
-        # Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL
-        # document database that simplifies storing, syncing, and querying data for
-        # your mobile, web, and IoT apps at global scale. Its client libraries provide
-        # live synchronization and offline support, while its security features and
-        # integrations with Firebase and Google Cloud Platform (GCP) accelerate
-        # building truly serverless apps.
-        #
-        # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
-        #   Provides the means for authenticating requests made by the client. This parameter can
-        #   be many types.
-        #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
-        #   authenticating requests made by this client.
-        #   A `String` will be treated as the path to the keyfile to be used for the construction of
-        #   credentials for this client.
-        #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
-        #   credentials for this client.
-        #   A `GRPC::Core::Channel` will be used to make calls through.
-        #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
-        #   should already be composed with a `GRPC::Core::CallCredentials` object.
-        #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
-        #   metadata for requests, generally, to give OAuth credentials.
-        # @param scopes [Array<String>]
-        #   The OAuth scopes for this service. This parameter is ignored if
-        #   an updater_proc is supplied.
-        # @param client_config [Hash]
-        #   A Hash for call options for each method. See
-        #   Google::Gax#construct_settings for the structure of
-        #   this data. Falls back to the default config if not specified
-        #   or the specified config is missing data points.
-        # @param timeout [Numeric]
-        #   The default timeout, in seconds, for calls made through this client.
-        # @param metadata [Hash]
-        #   Default metadata to be sent with each request. This can be overridden on a per call basis.
-        # @param service_address [String]
-        #   Override for the service hostname, or `nil` to leave as the default.
-        # @param service_port [Integer]
-        #   Override for the service port, or `nil` to leave as the default.
-        # @param exception_transformer [Proc]
-        #   An optional proc that intercepts any exceptions raised during an API call to inject
-        #   custom error handling.
-        def self.new \
-            credentials: nil,
-            scopes: nil,
-            client_config: nil,
-            timeout: nil,
-            metadata: nil,
-            service_address: nil,
-            service_port: nil,
-            exception_transformer: nil,
-            lib_name: nil,
-            lib_version: nil
-          kwargs = {
-            credentials: credentials,
-            scopes: scopes,
-            client_config: client_config,
-            timeout: timeout,
-            metadata: metadata,
-            exception_transformer: exception_transformer,
-            lib_name: lib_name,
-            service_address: service_address,
-            service_port: service_port,
-            lib_version: lib_version
-          }.select { |_, v| v != nil }
-          Google::Cloud::Firestore::V1::FirestoreClient.new(**kwargs)
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/firestore/v1/credentials.rb

@@ -1,42 +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.
-
-
-require "googleauth"
-
-module Google
-  module Cloud
-    module Firestore
-      module V1
-        class Credentials < Google::Auth::Credentials
-          SCOPE = [
-            "https://www.googleapis.com/auth/cloud-platform",
-            "https://www.googleapis.com/auth/datastore"
-          ].freeze
-          PATH_ENV_VARS = %w(FIRESTORE_CREDENTIALS
-                             FIRESTORE_KEYFILE
-                             GOOGLE_CLOUD_CREDENTIALS
-                             GOOGLE_CLOUD_KEYFILE
-                             GCLOUD_KEYFILE)
-          JSON_ENV_VARS = %w(FIRESTORE_CREDENTIALS_JSON
-                             FIRESTORE_KEYFILE_JSON
-                             GOOGLE_CLOUD_CREDENTIALS_JSON
-                             GOOGLE_CLOUD_KEYFILE_JSON
-                             GCLOUD_KEYFILE_JSON)
-          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/common.rb

@@ -1,64 +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 Firestore
-    module V1
-      # A set of field paths on a document.
-      # Used to restrict a get or update operation on a document to a subset of its
-      # fields.
-      # This is different from standard field masks, as this is always scoped to a
-      # {Google::Firestore::V1::Document Document}, and takes in account the dynamic nature of {Google::Firestore::V1::Value Value}.
-      # @!attribute [rw] field_paths
-      #   @return [Array<String>]
-      #     The list of field paths in the mask. See {Google::Firestore::V1::Document#fields Document#fields} for a field
-      #     path syntax reference.
-      class DocumentMask; end
-
-      # A precondition on a document, used for conditional operations.
-      # @!attribute [rw] exists
-      #   @return [true, false]
-      #     When set to `true`, the target document must exist.
-      #     When set to `false`, the target document must not exist.
-      # @!attribute [rw] update_time
-      #   @return [Google::Protobuf::Timestamp]
-      #     When set, the target document must exist and have been last updated at
-      #     that time.
-      class Precondition; end
-
-      # Options for creating a new transaction.
-      # @!attribute [rw] read_only
-      #   @return [Google::Firestore::V1::TransactionOptions::ReadOnly]
-      #     The transaction can only be used for read operations.
-      # @!attribute [rw] read_write
-      #   @return [Google::Firestore::V1::TransactionOptions::ReadWrite]
-      #     The transaction can be used for both read and write operations.
-      class TransactionOptions
-        # Options for a transaction that can be used to read and write documents.
-        # @!attribute [rw] retry_transaction
-        #   @return [String]
-        #     An optional transaction to retry.
-        class ReadWrite; end
-
-        # Options for a transaction that can only be used to read documents.
-        # @!attribute [rw] read_time
-        #   @return [Google::Protobuf::Timestamp]
-        #     Reads documents at the given time.
-        #     This may not be older than 60 seconds.
-        class ReadOnly; end
-      end
-    end
-  end
-end

data/lib/google/cloud/firestore/v1/doc/google/firestore/v1/document.rb

@@ -1,136 +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 Firestore
-    module V1
-      # A Firestore document.
-      #
-      # Must not exceed 1 MiB - 4 bytes.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     The resource name of the document, for example
-      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
-      # @!attribute [rw] fields
-      #   @return [Hash{String => Google::Firestore::V1::Value}]
-      #     The document's fields.
-      #
-      #     The map keys represent field names.
-      #
-      #     A simple field name contains only characters `a` to `z`, `A` to `Z`,
-      #     `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
-      #     `foo_bar_17`.
-      #
-      #     Field names matching the regular expression `__.*__` are reserved. Reserved
-      #     field names are forbidden except in certain documented contexts. The map
-      #     keys, represented as UTF-8, must not exceed 1,500 bytes and cannot be
-      #     empty.
-      #
-      #     Field paths may be used in other contexts to refer to structured fields
-      #     defined here. For `map_value`, the field path is represented by the simple
-      #     or quoted field names of the containing fields, delimited by `.`. For
-      #     example, the structured field
-      #     `"foo" : { map_value: { "x&y" : { string_value: "hello" }}}` would be
-      #     represented by the field path `foo.x&y`.
-      #
-      #     Within a field path, a quoted field name starts and ends with `` ` `` and
-      #     may contain any character. Some characters, including `` ` ``, must be
-      #     escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
-      #     `` `bak\`tik` `` represents `` bak`tik ``.
-      # @!attribute [rw] create_time
-      #   @return [Google::Protobuf::Timestamp]
-      #     Output only. The time at which the document was created.
-      #
-      #     This value increases monotonically when a document is deleted then
-      #     recreated. It can also be compared to values from other documents and
-      #     the `read_time` of a query.
-      # @!attribute [rw] update_time
-      #   @return [Google::Protobuf::Timestamp]
-      #     Output only. The time at which the document was last changed.
-      #
-      #     This value is initially set to the `create_time` then increases
-      #     monotonically with each change to the document. It can also be
-      #     compared to values from other documents and the `read_time` of a query.
-      class Document; end
-
-      # A message that can hold any of the supported value types.
-      # @!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.
-      #
-      #     Precise only to microseconds. When stored, any additional precision is
-      #     rounded down.
-      # @!attribute [rw] string_value
-      #   @return [String]
-      #     A string value.
-      #
-      #     The string, represented as UTF-8, must not exceed 1 MiB - 89 bytes.
-      #     Only the first 1,500 bytes of the UTF-8 representation are considered by
-      #     queries.
-      # @!attribute [rw] bytes_value
-      #   @return [String]
-      #     A bytes value.
-      #
-      #     Must not exceed 1 MiB - 89 bytes.
-      #     Only the first 1,500 bytes are considered by queries.
-      # @!attribute [rw] reference_value
-      #   @return [String]
-      #     A reference to a document. For example:
-      #     `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
-      # @!attribute [rw] geo_point_value
-      #   @return [Google::Type::LatLng]
-      #     A geo point value representing a point on the surface of Earth.
-      # @!attribute [rw] array_value
-      #   @return [Google::Firestore::V1::ArrayValue]
-      #     An array value.
-      #
-      #     Cannot directly contain another array value, though can contain an
-      #     map which contains another array.
-      # @!attribute [rw] map_value
-      #   @return [Google::Firestore::V1::MapValue]
-      #     A map value.
-      class Value; end
-
-      # An array value.
-      # @!attribute [rw] values
-      #   @return [Array<Google::Firestore::V1::Value>]
-      #     Values in the array.
-      class ArrayValue; end
-
-      # A map value.
-      # @!attribute [rw] fields
-      #   @return [Hash{String => Google::Firestore::V1::Value}]
-      #     The map's fields.
-      #
-      #     The map keys represent field names. Field names matching the regular
-      #     expression `__.*__` are reserved. Reserved field names are forbidden except
-      #     in certain documented contexts. The map keys, represented as UTF-8, must
-      #     not exceed 1,500 bytes and cannot be empty.
-      class MapValue; end
-    end
-  end
-end