google-cloud-firestore 1.0.0 → 1.1.0

data/lib/google/cloud/firestore/admin/v1/doc/google/protobuf/empty.rb

@@ -0,0 +1,29 @@
+# Copyright 2019 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 Protobuf
+    # A generic empty message that you can re-use to avoid defining duplicated
+    # empty messages in your APIs. A typical example is to use it as the request
+    # or the response type of an API method. For instance:
+    #
+    #     service Foo {
+    #       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+    #     }
+    #
+    # The JSON representation for `Empty` is empty JSON object `{}`.
+    class Empty; end
+  end
+end

data/lib/google/cloud/firestore/admin/v1/doc/google/protobuf/field_mask.rb

@@ -0,0 +1,222 @@
+# Copyright 2019 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 Protobuf
+    # `FieldMask` represents a set of symbolic field paths, for example:
+    #
+    #     paths: "f.a"
+    #     paths: "f.b.d"
+    #
+    # Here `f` represents a field in some root message, `a` and `b`
+    # fields in the message found in `f`, and `d` a field found in the
+    # message in `f.b`.
+    #
+    # Field masks are used to specify a subset of fields that should be
+    # returned by a get operation or modified by an update operation.
+    # Field masks also have a custom JSON encoding (see below).
+    #
+    # = Field Masks in Projections
+    #
+    # When used in the context of a projection, a response message or
+    # sub-message is filtered by the API to only contain those fields as
+    # specified in the mask. For example, if the mask in the previous
+    # example is applied to a response message as follows:
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #         x : 2
+    #       }
+    #       y : 13
+    #     }
+    #     z: 8
+    #
+    # The result will not contain specific values for fields x,y and z
+    # (their value will be set to the default, and omitted in proto text
+    # output):
+    #
+    #
+    #     f {
+    #       a : 22
+    #       b {
+    #         d : 1
+    #       }
+    #     }
+    #
+    # A repeated field is not allowed except at the last position of a
+    # paths string.
+    #
+    # If a FieldMask object is not present in a get operation, the
+    # operation applies to all fields (as if a FieldMask of all fields
+    # had been specified).
+    #
+    # Note that a field mask does not necessarily apply to the
+    # top-level response message. In case of a REST get operation, the
+    # field mask applies directly to the response, but in case of a REST
+    # list operation, the mask instead applies to each individual message
+    # in the returned resource list. In case of a REST custom method,
+    # other definitions may be used. Where the mask applies will be
+    # clearly documented together with its declaration in the API.  In
+    # any case, the effect on the returned resource/resources is required
+    # behavior for APIs.
+    #
+    # = Field Masks in Update Operations
+    #
+    # A field mask in update operations specifies which fields of the
+    # targeted resource are going to be updated. The API is required
+    # to only change the values of the fields as specified in the mask
+    # and leave the others untouched. If a resource is passed in to
+    # describe the updated values, the API ignores the values of all
+    # fields not covered by the mask.
+    #
+    # If a repeated field is specified for an update operation, new values will
+    # be appended to the existing repeated field in the target resource. Note that
+    # a repeated field is only allowed in the last position of a `paths` string.
+    #
+    # If a sub-message is specified in the last position of the field mask for an
+    # update operation, then new value will be merged into the existing sub-message
+    # in the target resource.
+    #
+    # For example, given the target message:
+    #
+    #     f {
+    #       b {
+    #         d: 1
+    #         x: 2
+    #       }
+    #       c: [1]
+    #     }
+    #
+    # And an update message:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #       }
+    #       c: [2]
+    #     }
+    #
+    # then if the field mask is:
+    #
+    #  paths: ["f.b", "f.c"]
+    #
+    # then the result will be:
+    #
+    #     f {
+    #       b {
+    #         d: 10
+    #         x: 2
+    #       }
+    #       c: [1, 2]
+    #     }
+    #
+    # An implementation may provide options to override this default behavior for
+    # repeated and message fields.
+    #
+    # In order to reset a field's value to the default, the field must
+    # be in the mask and set to the default value in the provided resource.
+    # Hence, in order to reset all fields of a resource, provide a default
+    # instance of the resource and set all fields in the mask, or do
+    # not provide a mask as described below.
+    #
+    # If a field mask is not present on update, the operation applies to
+    # all fields (as if a field mask of all fields has been specified).
+    # Note that in the presence of schema evolution, this may mean that
+    # fields the client does not know and has therefore not filled into
+    # the request will be reset to their default. If this is unwanted
+    # behavior, a specific service may require a client to always specify
+    # a field mask, producing an error if not.
+    #
+    # As with get operations, the location of the resource which
+    # describes the updated values in the request message depends on the
+    # operation kind. In any case, the effect of the field mask is
+    # required to be honored by the API.
+    #
+    # == Considerations for HTTP REST
+    #
+    # The HTTP kind of an update operation which uses a field mask must
+    # be set to PATCH instead of PUT in order to satisfy HTTP semantics
+    # (PUT must only be used for full updates).
+    #
+    # = JSON Encoding of Field Masks
+    #
+    # In JSON, a field mask is encoded as a single string where paths are
+    # separated by a comma. Fields name in each path are converted
+    # to/from lower-camel naming conventions.
+    #
+    # As an example, consider the following message declarations:
+    #
+    #     message Profile {
+    #       User user = 1;
+    #       Photo photo = 2;
+    #     }
+    #     message User {
+    #       string display_name = 1;
+    #       string address = 2;
+    #     }
+    #
+    # In proto a field mask for `Profile` may look as such:
+    #
+    #     mask {
+    #       paths: "user.display_name"
+    #       paths: "photo"
+    #     }
+    #
+    # In JSON, the same mask is represented as below:
+    #
+    #     {
+    #       mask: "user.displayName,photo"
+    #     }
+    #
+    # = Field Masks and Oneof Fields
+    #
+    # Field masks treat fields in oneofs just as regular fields. Consider the
+    # following message:
+    #
+    #     message SampleMessage {
+    #       oneof test_oneof {
+    #         string name = 4;
+    #         SubMessage sub_message = 9;
+    #       }
+    #     }
+    #
+    # The field mask can be:
+    #
+    #     mask {
+    #       paths: "name"
+    #     }
+    #
+    # Or:
+    #
+    #     mask {
+    #       paths: "sub_message"
+    #     }
+    #
+    # Note that oneof type names ("test_oneof" in this case) cannot be used in
+    # paths.
+    #
+    # == Field Mask Verification
+    #
+    # The implementation of any API method which has a FieldMask type field in the
+    # request should verify the included field paths, and return an
+    # `INVALID_ARGUMENT` error if any path is duplicated or unmappable.
+    # @!attribute [rw] paths
+    #   @return [Array<String>]
+    #     The set of field mask paths.
+    class FieldMask; end
+  end
+end

data/lib/google/cloud/firestore/admin/v1/doc/google/rpc/status.rb

@@ -0,0 +1,87 @@
+# Copyright 2019 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 Rpc
+    # The `Status` type defines a logical error model that is suitable for
+    # different programming environments, including REST APIs and RPC APIs. It is
+    # used by [gRPC](https://github.com/grpc). The error model is designed to be:
+    #
+    # * Simple to use and understand for most users
+    # * Flexible enough to meet unexpected needs
+    #
+    # = Overview
+    #
+    # The `Status` message contains three pieces of data: error code, error
+    # message, and error details. The error code should be an enum value of
+    # {Google::Rpc::Code}, but it may accept additional error codes
+    # if needed.  The error message should be a developer-facing English message
+    # that helps developers *understand* and *resolve* the error. If a localized
+    # user-facing error message is needed, put the localized message in the error
+    # details or localize it in the client. The optional error details may contain
+    # arbitrary information about the error. There is a predefined set of error
+    # detail types in the package `google.rpc` that can be used for common error
+    # conditions.
+    #
+    # = Language mapping
+    #
+    # The `Status` message is the logical representation of the error model, but it
+    # is not necessarily the actual wire format. When the `Status` message is
+    # exposed in different client libraries and different wire protocols, it can be
+    # mapped differently. For example, it will likely be mapped to some exceptions
+    # in Java, but more likely mapped to some error codes in C.
+    #
+    # = Other uses
+    #
+    # The error model and the `Status` message can be used in a variety of
+    # environments, either with or without APIs, to provide a
+    # consistent developer experience across different environments.
+    #
+    # Example uses of this error model include:
+    #
+    # * Partial errors. If a service needs to return partial errors to the client,
+    #   it may embed the `Status` in the normal response to indicate the partial
+    #   errors.
+    #
+    # * Workflow errors. A typical workflow has multiple steps. Each step may
+    #   have a `Status` message for error reporting.
+    #
+    # * Batch operations. If a client uses batch request and batch response, the
+    #   `Status` message should be used directly inside batch response, one for
+    #   each error sub-response.
+    #
+    # * Asynchronous operations. If an API call embeds asynchronous operation
+    #   results in its response, the status of those operations should be
+    #   represented directly using the `Status` message.
+    #
+    # * Logging. If some API errors are stored in logs, the message `Status` could
+    #   be used directly after any stripping needed for security/privacy reasons.
+    # @!attribute [rw] code
+    #   @return [Integer]
+    #     The status code, which should be an enum value of
+    #     {Google::Rpc::Code}.
+    # @!attribute [rw] message
+    #   @return [String]
+    #     A developer-facing error message, which should be in English. Any
+    #     user-facing error message should be localized and sent in the
+    #     {Google::Rpc::Status#details} field, or localized
+    #     by the client.
+    # @!attribute [rw] details
+    #   @return [Array<Google::Protobuf::Any>]
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
+    class Status; end
+  end
+end

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

@@ -0,0 +1,761 @@
+# Copyright 2019 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.
+#
+# EDITING INSTRUCTIONS
+# This file was generated from the file
+# https://github.com/googleapis/googleapis/blob/master/google/firestore/admin/v1/firestore_admin.proto,
+# and updates to that file get reflected here through a refresh process.
+# For the short term, the refresh process will only be runnable by Google
+# engineers.
+
+
+require "json"
+require "pathname"
+
+require "google/gax"
+
+require "google/firestore/admin/v1/firestore_admin_pb"
+require "google/cloud/firestore/admin/v1/credentials"
+require "google/cloud/firestore/version"
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          # Operations are created by service `FirestoreAdmin`, but are accessed via
+          # service `google.longrunning.Operations`.
+          #
+          # @!attribute [r] firestore_admin_stub
+          #   @return [Google::Firestore::Admin::V1::FirestoreAdmin::Stub]
+          class FirestoreAdminClient
+            # @private
+            attr_reader :firestore_admin_stub
+
+            # The default address of the service.
+            SERVICE_ADDRESS = "firestore.googleapis.com".freeze
+
+            # The default port of the service.
+            DEFAULT_SERVICE_PORT = 443
+
+            # The default set of gRPC interceptors.
+            GRPC_INTERCEPTORS = []
+
+            DEFAULT_TIMEOUT = 30
+
+            PAGE_DESCRIPTORS = {
+              "list_indexes" => Google::Gax::PageDescriptor.new(
+                "page_token",
+                "next_page_token",
+                "indexes"),
+              "list_fields" => Google::Gax::PageDescriptor.new(
+                "page_token",
+                "next_page_token",
+                "fields")
+            }.freeze
+
+            private_constant :PAGE_DESCRIPTORS
+
+            # The scopes needed to make gRPC calls to all of the methods defined in
+            # this service.
+            ALL_SCOPES = [
+              "https://www.googleapis.com/auth/cloud-platform",
+              "https://www.googleapis.com/auth/datastore"
+            ].freeze
+
+
+            DATABASE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/databases/{database}"
+            )
+
+            private_constant :DATABASE_PATH_TEMPLATE
+
+            FIELD_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/databases/{database}/collectionGroups/{collection_id}/fields/{field_id}"
+            )
+
+            private_constant :FIELD_PATH_TEMPLATE
+
+            INDEX_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/databases/{database}/collectionGroups/{collection_id}/indexes/{index_id}"
+            )
+
+            private_constant :INDEX_PATH_TEMPLATE
+
+            PARENT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
+              "projects/{project}/databases/{database}/collectionGroups/{collection_id}"
+            )
+
+            private_constant :PARENT_PATH_TEMPLATE
+
+            # Returns a fully-qualified database resource name string.
+            # @param project [String]
+            # @param database [String]
+            # @return [String]
+            def self.database_path project, database
+              DATABASE_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"database" => database
+              )
+            end
+
+            # Returns a fully-qualified field resource name string.
+            # @param project [String]
+            # @param database [String]
+            # @param collection_id [String]
+            # @param field_id [String]
+            # @return [String]
+            def self.field_path project, database, collection_id, field_id
+              FIELD_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"database" => database,
+                :"collection_id" => collection_id,
+                :"field_id" => field_id
+              )
+            end
+
+            # Returns a fully-qualified index resource name string.
+            # @param project [String]
+            # @param database [String]
+            # @param collection_id [String]
+            # @param index_id [String]
+            # @return [String]
+            def self.index_path project, database, collection_id, index_id
+              INDEX_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"database" => database,
+                :"collection_id" => collection_id,
+                :"index_id" => index_id
+              )
+            end
+
+            # Returns a fully-qualified parent resource name string.
+            # @param project [String]
+            # @param database [String]
+            # @param collection_id [String]
+            # @return [String]
+            def self.parent_path project, database, collection_id
+              PARENT_PATH_TEMPLATE.render(
+                :"project" => project,
+                :"database" => database,
+                :"collection_id" => collection_id
+              )
+            end
+
+            # @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 initialize \
+                credentials: nil,
+                scopes: ALL_SCOPES,
+                client_config: {},
+                timeout: DEFAULT_TIMEOUT,
+                metadata: nil,
+                service_address: nil,
+                service_port: nil,
+                exception_transformer: nil,
+                lib_name: nil,
+                lib_version: ""
+              # These require statements are intentionally placed here to initialize
+              # the gRPC module only when it's required.
+              # See https://github.com/googleapis/toolkit/issues/446
+              require "google/gax/grpc"
+              require "google/firestore/admin/v1/firestore_admin_services_pb"
+
+              credentials ||= Google::Cloud::Firestore::Admin::V1::Credentials.default
+
+              if credentials.is_a?(String) || credentials.is_a?(Hash)
+                updater_proc = Google::Cloud::Firestore::Admin::V1::Credentials.new(credentials).updater_proc
+              end
+              if credentials.is_a?(GRPC::Core::Channel)
+                channel = credentials
+              end
+              if credentials.is_a?(GRPC::Core::ChannelCredentials)
+                chan_creds = credentials
+              end
+              if credentials.is_a?(Proc)
+                updater_proc = credentials
+              end
+              if credentials.is_a?(Google::Auth::Credentials)
+                updater_proc = credentials.updater_proc
+              end
+
+              package_version = Google::Cloud::Firestore::VERSION
+
+              google_api_client = "gl-ruby/#{RUBY_VERSION}"
+              google_api_client << " #{lib_name}/#{lib_version}" if lib_name
+              google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
+              google_api_client << " grpc/#{GRPC::VERSION}"
+              google_api_client.freeze
+
+              headers = { :"x-goog-api-client" => google_api_client }
+              headers.merge!(metadata) unless metadata.nil?
+              client_config_file = Pathname.new(__dir__).join(
+                "firestore_admin_client_config.json"
+              )
+              defaults = client_config_file.open do |f|
+                Google::Gax.construct_settings(
+                  "google.firestore.admin.v1.FirestoreAdmin",
+                  JSON.parse(f.read),
+                  client_config,
+                  Google::Gax::Grpc::STATUS_CODE_NAMES,
+                  timeout,
+                  page_descriptors: PAGE_DESCRIPTORS,
+                  errors: Google::Gax::Grpc::API_ERRORS,
+                  metadata: headers
+                )
+              end
+
+              # Allow overriding the service path/port in subclasses.
+              service_path = service_address || self.class::SERVICE_ADDRESS
+              port = service_port || self.class::DEFAULT_SERVICE_PORT
+              interceptors = self.class::GRPC_INTERCEPTORS
+              @firestore_admin_stub = Google::Gax::Grpc.create_stub(
+                service_path,
+                port,
+                chan_creds: chan_creds,
+                channel: channel,
+                updater_proc: updater_proc,
+                scopes: scopes,
+                interceptors: interceptors,
+                &Google::Firestore::Admin::V1::FirestoreAdmin::Stub.method(:new)
+              )
+
+              @create_index = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:create_index),
+                defaults["create_index"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'parent' => request.parent}
+                end
+              )
+              @list_indexes = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:list_indexes),
+                defaults["list_indexes"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'parent' => request.parent}
+                end
+              )
+              @get_index = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:get_index),
+                defaults["get_index"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'name' => request.name}
+                end
+              )
+              @delete_index = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:delete_index),
+                defaults["delete_index"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'name' => request.name}
+                end
+              )
+              @import_documents = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:import_documents),
+                defaults["import_documents"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'name' => request.name}
+                end
+              )
+              @export_documents = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:export_documents),
+                defaults["export_documents"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'name' => request.name}
+                end
+              )
+              @get_field = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:get_field),
+                defaults["get_field"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'name' => request.name}
+                end
+              )
+              @list_fields = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:list_fields),
+                defaults["list_fields"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'parent' => request.parent}
+                end
+              )
+              @update_field = Google::Gax.create_api_call(
+                @firestore_admin_stub.method(:update_field),
+                defaults["update_field"],
+                exception_transformer: exception_transformer,
+                params_extractor: proc do |request|
+                  {'field.name' => request.field.name}
+                end
+              )
+            end
+
+            # Service calls
+
+            # Creates a composite index. This returns a {Google::Longrunning::Operation}
+            # which may be used to track the status of the creation. The metadata for
+            # the operation will be the type {Google::Firestore::Admin::V1::IndexOperationMetadata IndexOperationMetadata}.
+            #
+            # @param parent [String]
+            #   A parent name of the form
+            #   `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+            # @param index [Google::Firestore::Admin::V1::Index | Hash]
+            #   The composite index to create.
+            #   A hash of the same form as `Google::Firestore::Admin::V1::Index`
+            #   can also be provided.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Longrunning::Operation]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Longrunning::Operation]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_parent = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.parent_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]")
+            #
+            #   # TODO: Initialize `index`:
+            #   index = {}
+            #   response = firestore_admin_client.create_index(formatted_parent, index)
+
+            def create_index \
+                parent,
+                index,
+                options: nil,
+                &block
+              req = {
+                parent: parent,
+                index: index
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::CreateIndexRequest)
+              @create_index.call(req, options, &block)
+            end
+
+            # Lists composite indexes.
+            #
+            # @param parent [String]
+            #   A parent name of the form
+            #   `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+            # @param filter [String]
+            #   The filter to apply to list results.
+            # @param page_size [Integer]
+            #   The maximum number of resources contained in the underlying API
+            #   response. If page streaming is performed per-resource, this
+            #   parameter does not affect the return value. If page streaming is
+            #   performed per-page, this determines the maximum number of
+            #   resources in a page.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Gax::PagedEnumerable<Google::Firestore::Admin::V1::Index>]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Gax::PagedEnumerable<Google::Firestore::Admin::V1::Index>]
+            #   An enumerable of Google::Firestore::Admin::V1::Index instances.
+            #   See Google::Gax::PagedEnumerable documentation for other
+            #   operations such as per-page iteration or access to the response
+            #   object.
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_parent = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.parent_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]")
+            #
+            #   # Iterate over all results.
+            #   firestore_admin_client.list_indexes(formatted_parent).each do |element|
+            #     # Process element.
+            #   end
+            #
+            #   # Or iterate over results one page at a time.
+            #   firestore_admin_client.list_indexes(formatted_parent).each_page do |page|
+            #     # Process each page at a time.
+            #     page.each do |element|
+            #       # Process element.
+            #     end
+            #   end
+
+            def list_indexes \
+                parent,
+                filter: nil,
+                page_size: nil,
+                options: nil,
+                &block
+              req = {
+                parent: parent,
+                filter: filter,
+                page_size: page_size
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::ListIndexesRequest)
+              @list_indexes.call(req, options, &block)
+            end
+
+            # Gets a composite index.
+            #
+            # @param name [String]
+            #   A name of the form
+            #   `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Firestore::Admin::V1::Index]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Firestore::Admin::V1::Index]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_name = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.index_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]")
+            #   response = firestore_admin_client.get_index(formatted_name)
+
+            def get_index \
+                name,
+                options: nil,
+                &block
+              req = {
+                name: name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::GetIndexRequest)
+              @get_index.call(req, options, &block)
+            end
+
+            # Deletes a composite index.
+            #
+            # @param name [String]
+            #   A name of the form
+            #   `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result []
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_name = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.index_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[INDEX_ID]")
+            #   firestore_admin_client.delete_index(formatted_name)
+
+            def delete_index \
+                name,
+                options: nil,
+                &block
+              req = {
+                name: name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::DeleteIndexRequest)
+              @delete_index.call(req, options, &block)
+              nil
+            end
+
+            # Imports documents into Google Cloud Firestore. Existing documents with the
+            # same name are overwritten. The import occurs in the background and its
+            # progress can be monitored and managed via the Operation resource that is
+            # created. If an ImportDocuments operation is cancelled, it is possible
+            # that a subset of the data has already been imported to Cloud Firestore.
+            #
+            # @param name [String]
+            #   Database to import into. Should be of the form:
+            #   `projects/{project_id}/databases/{database_id}`.
+            # @param collection_ids [Array<String>]
+            #   Which collection ids to import. Unspecified means all collections included
+            #   in the import.
+            # @param input_uri_prefix [String]
+            #   Location of the exported files.
+            #   This must match the output_uri_prefix of an ExportDocumentsResponse from
+            #   an export that has completed successfully.
+            #   See:
+            #   {Google::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix}.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Longrunning::Operation]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Longrunning::Operation]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_name = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.database_path("[PROJECT]", "[DATABASE]")
+            #   response = firestore_admin_client.import_documents(formatted_name)
+
+            def import_documents \
+                name,
+                collection_ids: nil,
+                input_uri_prefix: nil,
+                options: nil,
+                &block
+              req = {
+                name: name,
+                collection_ids: collection_ids,
+                input_uri_prefix: input_uri_prefix
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::ImportDocumentsRequest)
+              @import_documents.call(req, options, &block)
+            end
+
+            # Exports a copy of all or a subset of documents from Google Cloud Firestore
+            # to another storage system, such as Google Cloud Storage. Recent updates to
+            # documents may not be reflected in the export. The export occurs in the
+            # background and its progress can be monitored and managed via the
+            # Operation resource that is created. The output of an export may only be
+            # used once the associated operation is done. If an export operation is
+            # cancelled before completion it may leave partial data behind in Google
+            # Cloud Storage.
+            #
+            # @param name [String]
+            #   Database to export. Should be of the form:
+            #   `projects/{project_id}/databases/{database_id}`.
+            # @param collection_ids [Array<String>]
+            #   Which collection ids to export. Unspecified means all collections.
+            # @param output_uri_prefix [String]
+            #   The output URI. Currently only supports Google Cloud Storage URIs of the
+            #   form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
+            #   of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
+            #   Google Cloud Storage namespace path. When
+            #   choosing a name, be sure to consider Google Cloud Storage naming
+            #   guidelines: https://cloud.google.com/storage/docs/naming.
+            #   If the URI is a bucket (without a namespace path), a prefix will be
+            #   generated based on the start time.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Longrunning::Operation]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Longrunning::Operation]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_name = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.database_path("[PROJECT]", "[DATABASE]")
+            #   response = firestore_admin_client.export_documents(formatted_name)
+
+            def export_documents \
+                name,
+                collection_ids: nil,
+                output_uri_prefix: nil,
+                options: nil,
+                &block
+              req = {
+                name: name,
+                collection_ids: collection_ids,
+                output_uri_prefix: output_uri_prefix
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::ExportDocumentsRequest)
+              @export_documents.call(req, options, &block)
+            end
+
+            # Gets the metadata and configuration for a Field.
+            #
+            # @param name [String]
+            #   A name of the form
+            #   `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Firestore::Admin::V1::Field]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Firestore::Admin::V1::Field]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_name = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.field_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]", "[FIELD_ID]")
+            #   response = firestore_admin_client.get_field(formatted_name)
+
+            def get_field \
+                name,
+                options: nil,
+                &block
+              req = {
+                name: name
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::GetFieldRequest)
+              @get_field.call(req, options, &block)
+            end
+
+            # Lists the field configuration and metadata for this database.
+            #
+            # Currently, {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields} only supports listing fields
+            # that have been explicitly overridden. To issue this query, call
+            # {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields} with the filter set to
+            # `indexConfig.usesAncestorConfig:false`.
+            #
+            # @param parent [String]
+            #   A parent name of the form
+            #   `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
+            # @param filter [String]
+            #   The filter to apply to list results. Currently,
+            #   {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields} only supports listing fields
+            #   that have been explicitly overridden. To issue this query, call
+            #   {Google::Firestore::Admin::V1::FirestoreAdmin::ListFields FirestoreAdmin::ListFields} with the filter set to
+            #   `indexConfig.usesAncestorConfig:false`.
+            # @param page_size [Integer]
+            #   The maximum number of resources contained in the underlying API
+            #   response. If page streaming is performed per-resource, this
+            #   parameter does not affect the return value. If page streaming is
+            #   performed per-page, this determines the maximum number of
+            #   resources in a page.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Gax::PagedEnumerable<Google::Firestore::Admin::V1::Field>]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Gax::PagedEnumerable<Google::Firestore::Admin::V1::Field>]
+            #   An enumerable of Google::Firestore::Admin::V1::Field instances.
+            #   See Google::Gax::PagedEnumerable documentation for other
+            #   operations such as per-page iteration or access to the response
+            #   object.
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #   formatted_parent = Google::Cloud::Firestore::Admin::V1::FirestoreAdminClient.parent_path("[PROJECT]", "[DATABASE]", "[COLLECTION_ID]")
+            #
+            #   # Iterate over all results.
+            #   firestore_admin_client.list_fields(formatted_parent).each do |element|
+            #     # Process element.
+            #   end
+            #
+            #   # Or iterate over results one page at a time.
+            #   firestore_admin_client.list_fields(formatted_parent).each_page do |page|
+            #     # Process each page at a time.
+            #     page.each do |element|
+            #       # Process element.
+            #     end
+            #   end
+
+            def list_fields \
+                parent,
+                filter: nil,
+                page_size: nil,
+                options: nil,
+                &block
+              req = {
+                parent: parent,
+                filter: filter,
+                page_size: page_size
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::ListFieldsRequest)
+              @list_fields.call(req, options, &block)
+            end
+
+            # Updates a field configuration. Currently, field updates apply only to
+            # single field index configuration. However, calls to
+            # {Google::Firestore::Admin::V1::FirestoreAdmin::UpdateField FirestoreAdmin::UpdateField} should provide a field mask to avoid
+            # changing any configuration that the caller isn't aware of. The field mask
+            # should be specified as: `{ paths: "index_config" }`.
+            #
+            # This call returns a {Google::Longrunning::Operation} which may be used to
+            # track the status of the field update. The metadata for
+            # the operation will be the type {Google::Firestore::Admin::V1::FieldOperationMetadata FieldOperationMetadata}.
+            #
+            # To configure the default field settings for the database, use
+            # the special `Field` with resource name:
+            # `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`.
+            #
+            # @param field [Google::Firestore::Admin::V1::Field | Hash]
+            #   The field to be updated.
+            #   A hash of the same form as `Google::Firestore::Admin::V1::Field`
+            #   can also be provided.
+            # @param update_mask [Google::Protobuf::FieldMask | Hash]
+            #   A mask, relative to the field. If specified, only configuration specified
+            #   by this field_mask will be updated in the field.
+            #   A hash of the same form as `Google::Protobuf::FieldMask`
+            #   can also be provided.
+            # @param options [Google::Gax::CallOptions]
+            #   Overrides the default settings for this call, e.g, timeout,
+            #   retries, etc.
+            # @yield [result, operation] Access the result along with the RPC operation
+            # @yieldparam result [Google::Longrunning::Operation]
+            # @yieldparam operation [GRPC::ActiveCall::Operation]
+            # @return [Google::Longrunning::Operation]
+            # @raise [Google::Gax::GaxError] if the RPC is aborted.
+            # @example
+            #   require "google/cloud/firestore/admin"
+            #
+            #   firestore_admin_client = Google::Cloud::Firestore::Admin.new(version: :v1)
+            #
+            #   # TODO: Initialize `field`:
+            #   field = {}
+            #   response = firestore_admin_client.update_field(field)
+
+            def update_field \
+                field,
+                update_mask: nil,
+                options: nil,
+                &block
+              req = {
+                field: field,
+                update_mask: update_mask
+              }.delete_if { |_, v| v.nil? }
+              req = Google::Gax::to_proto(req, Google::Firestore::Admin::V1::UpdateFieldRequest)
+              @update_field.call(req, options, &block)
+            end
+          end
+        end
+      end
+    end
+  end
+end