google-cloud-firestore-admin-v1 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e576925bd653ff87f65db14f1a1727775a42bf509afbbb4e27ac6793b5111dd6
-  data.tar.gz: 015c2e510cb1c8b64602c3d95fa781e5111d10b3af7183f2499e6428e194d663
+  metadata.gz: 57ac7b3785adf8f1e43707d5450e8d806780aa70aae7089d25ac8d774312aec5
+  data.tar.gz: b545276711f57102c05622117accef8064cf094c2779d432a41a0927dba3ab80
 SHA512:
-  metadata.gz: 377663b172b3593969409b7ad3280eb8e04eebec7a7425ac85ad67b8e634d3fcca6361b45798fcb9fc92f97b5b01d68dfee555dbf7e7a8b04dc0f1f3feca94c2
-  data.tar.gz: 3ba5cedc5b07b6f52c693a3f1a09387475e4bda2b2b7a232bf1a043c166ce3d9fe37ecba2278de35f24744e23df43795fbfc3e0042970188d02df946a8cf3a32
+  metadata.gz: 9f0d68dd51a8c96be02be5f197dae2440c07231fe17cf28d0c116f9b990ca97d11e4c1614a5ea453af69f4865a4333b98333a1c8bda5d2881235c7835ae3ac83
+  data.tar.gz: 9b04fa863bb15308224ea4c6aea035116da46c5db6362da95dcb89f2fef0ee91ea7a51f9d0480bca168ab48358a93c90627244e120c871203b688d29518078a0

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Cloud Firestore Admin V1 API
+--title="Cloud Firestore Admin V1 API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

data/lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb

@@ -28,6 +28,32 @@ module Google
             ##
             # Client for the FirestoreAdmin service.
             #
+            # The Cloud Firestore Admin API.
+            #
+            # This API provides several administrative services for Cloud Firestore.
+            #
+            # Project, Database, Namespace, Collection, Collection Group, and Document are
+            # used as defined in the Google Cloud Firestore API.
+            #
+            # Operation: An Operation represents work being performed in the background.
+            #
+            # The index service manages Cloud Firestore indexes.
+            #
+            # Index creation is performed asynchronously.
+            # An Operation resource is created for each such asynchronous operation.
+            # The state of the operation (including any errors encountered)
+            # may be queried via the Operation resource.
+            #
+            # The Operations collection provides a record of actions performed for the
+            # specified Project (including any Operations in progress). Operations are not
+            # created directly but through calls on other collections or resources.
+            #
+            # An Operation that is done may be deleted so that it is no longer listed as
+            # part of the Operation collection. Operations are garbage collected after
+            # 30 days. By default, ListOperations will only return in progress and failed
+            # operations. To list completed operation, issue a ListOperations request with
+            # the filter `done: true`.
+            #
             # Operations are created by service `FirestoreAdmin`, but are accessed via
             # service `google.longrunning.Operations`.
             #
@@ -170,6 +196,7 @@ module Google
 
                 @operations_client = Operations.new do |config|
                   config.credentials = credentials
+                  config.quota_project = @quota_project_id
                   config.endpoint = @config.endpoint
                 end
 
@@ -762,7 +789,7 @@ module Google
               # Currently, {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
               # that have been explicitly overridden. To issue this query, call
               # {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
-              # `indexConfig.usesAncestorConfig:false`.
+              # `indexConfig.usesAncestorConfig:false` .
               #
               # @overload list_fields(request, options = nil)
               #   Pass arguments to `list_fields` via a request object, either of type
@@ -786,8 +813,8 @@ module Google
               #     The filter to apply to list results. Currently,
               #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
               #     that have been explicitly overridden. To issue this query, call
-              #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
-              #     `indexConfig.usesAncestorConfig:false`.
+              #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with a filter that includes
+              #     `indexConfig.usesAncestorConfig:false` .
               #   @param page_size [::Integer]
               #     The number of results to return.
               #   @param page_token [::String]
@@ -876,6 +903,9 @@ module Google
               # cancelled before completion it may leave partial data behind in Google
               # Cloud Storage.
               #
+              # For more details on export behavior and output format, refer to:
+              # https://cloud.google.com/firestore/docs/manage-data/export-import
+              #
               # @overload export_documents(request, options = nil)
               #   Pass arguments to `export_documents` via a request object, either of type
               #   {::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest} or an equivalent Hash.
@@ -1085,6 +1115,273 @@ module Google
                 raise ::Google::Cloud::Error.from_error(e)
               end
 
+              ##
+              # Gets information about a database.
+              #
+              # @overload get_database(request, options = nil)
+              #   Pass arguments to `get_database` via a request object, either of type
+              #   {::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload get_database(name: nil)
+              #   Pass arguments to `get_database` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param name [::String]
+              #     Required. A name of the form
+              #     `projects/{project_id}/databases/{database_id}`
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::Database]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Cloud::Firestore::Admin::V1::Database]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/admin/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest.new
+              #
+              #   # Call the get_database method.
+              #   result = client.get_database request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::Admin::V1::Database.
+              #   p result
+              #
+              def get_database request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.get_database.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.name
+                  header_params["name"] = request.name
+                end
+
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.get_database.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.get_database.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @firestore_admin_stub.call_rpc :get_database, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # List all the databases in the project.
+              #
+              # @overload list_databases(request, options = nil)
+              #   Pass arguments to `list_databases` via a request object, either of type
+              #   {::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload list_databases(parent: nil)
+              #   Pass arguments to `list_databases` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param parent [::String]
+              #     Required. A parent name of the form
+              #     `projects/{project_id}`
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/admin/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest.new
+              #
+              #   # Call the list_databases method.
+              #   result = client.list_databases request
+              #
+              #   # The returned object is of type Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse.
+              #   p result
+              #
+              def list_databases request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.list_databases.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.parent
+                  header_params["parent"] = request.parent
+                end
+
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.list_databases.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.list_databases.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @firestore_admin_stub.call_rpc :list_databases, request, options: options do |response, operation|
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
+              ##
+              # Updates a database.
+              #
+              # @overload update_database(request, options = nil)
+              #   Pass arguments to `update_database` via a request object, either of type
+              #   {::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest} or an equivalent Hash.
+              #
+              #   @param request [::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest, ::Hash]
+              #     A request object representing the call parameters. Required. To specify no
+              #     parameters, or to keep all the default parameter values, pass an empty Hash.
+              #   @param options [::Gapic::CallOptions, ::Hash]
+              #     Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
+              #
+              # @overload update_database(database: nil, update_mask: nil)
+              #   Pass arguments to `update_database` via keyword arguments. Note that at
+              #   least one keyword argument is required. To specify no parameters, or to keep all
+              #   the default parameter values, pass an empty Hash as a request object (see above).
+              #
+              #   @param database [::Google::Cloud::Firestore::Admin::V1::Database, ::Hash]
+              #     Required. The database to update.
+              #   @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
+              #     The list of fields to be updated.
+              #
+              # @yield [response, operation] Access the result along with the RPC operation
+              # @yieldparam response [::Gapic::Operation]
+              # @yieldparam operation [::GRPC::ActiveCall::Operation]
+              #
+              # @return [::Gapic::Operation]
+              #
+              # @raise [::Google::Cloud::Error] if the RPC is aborted.
+              #
+              # @example Basic example
+              #   require "google/cloud/firestore/admin/v1"
+              #
+              #   # Create a client object. The client can be reused for multiple calls.
+              #   client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
+              #
+              #   # Create a request. To set request fields, pass in keyword arguments.
+              #   request = Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest.new
+              #
+              #   # Call the update_database method.
+              #   result = client.update_database request
+              #
+              #   # The returned object is of type Gapic::Operation. You can use this
+              #   # object to check the status of an operation, cancel it, or wait
+              #   # for results. Here is how to block until completion:
+              #   result.wait_until_done! timeout: 60
+              #   if result.response?
+              #     p result.response
+              #   else
+              #     puts "Error!"
+              #   end
+              #
+              def update_database request, options = nil
+                raise ::ArgumentError, "request must be provided" if request.nil?
+
+                request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest
+
+                # Converts hash and nil to an options object
+                options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
+
+                # Customize the options with defaults
+                metadata = @config.rpcs.update_database.metadata.to_h
+
+                # Set x-goog-api-client and x-goog-user-project headers
+                metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
+                  lib_name: @config.lib_name, lib_version: @config.lib_version,
+                  gapic_version: ::Google::Cloud::Firestore::Admin::V1::VERSION
+                metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
+
+                header_params = {}
+                if request.database&.name
+                  header_params["database.name"] = request.database.name
+                end
+
+                request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
+                metadata[:"x-goog-request-params"] ||= request_params_header
+
+                options.apply_defaults timeout:      @config.rpcs.update_database.timeout,
+                                       metadata:     metadata,
+                                       retry_policy: @config.rpcs.update_database.retry_policy
+
+                options.apply_defaults timeout:      @config.timeout,
+                                       metadata:     @config.metadata,
+                                       retry_policy: @config.retry_policy
+
+                @firestore_admin_stub.call_rpc :update_database, request, options: options do |response, operation|
+                  response = ::Gapic::Operation.new response, @operations_client, options: options
+                  yield response, operation if block_given?
+                  return response
+                end
+              rescue ::GRPC::BadStatus => e
+                raise ::Google::Cloud::Error.from_error(e)
+              end
+
               ##
               # Configuration class for the FirestoreAdmin API.
               #
@@ -1265,6 +1562,21 @@ module Google
                   # @return [::Gapic::Config::Method]
                   #
                   attr_reader :import_documents
+                  ##
+                  # RPC-specific configuration for `get_database`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :get_database
+                  ##
+                  # RPC-specific configuration for `list_databases`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :list_databases
+                  ##
+                  # RPC-specific configuration for `update_database`
+                  # @return [::Gapic::Config::Method]
+                  #
+                  attr_reader :update_database
 
                   # @private
                   def initialize parent_rpcs = nil
@@ -1286,6 +1598,12 @@ module Google
                     @export_documents = ::Gapic::Config::Method.new export_documents_config
                     import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
                     @import_documents = ::Gapic::Config::Method.new import_documents_config
+                    get_database_config = parent_rpcs.get_database if parent_rpcs.respond_to? :get_database
+                    @get_database = ::Gapic::Config::Method.new get_database_config
+                    list_databases_config = parent_rpcs.list_databases if parent_rpcs.respond_to? :list_databases
+                    @list_databases = ::Gapic::Config::Method.new list_databases_config
+                    update_database_config = parent_rpcs.update_database if parent_rpcs.respond_to? :update_database
+                    @update_database = ::Gapic::Config::Method.new update_database_config
 
                     yield self if block_given?
                   end

data/lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb

@@ -103,6 +103,20 @@ module Google
                 "projects/#{project}/databases/#{database}/collectionGroups/#{collection}/indexes/#{index}"
               end
 
+              ##
+              # Create a fully-qualified Project resource string.
+              #
+              # The resource will be in the following format:
+              #
+              # `projects/{project}`
+              #
+              # @param project [String]
+              #
+              # @return [::String]
+              def project_path project:
+                "projects/#{project}"
+              end
+
               extend self
             end
           end

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

@@ -33,6 +33,32 @@ module Google
       module Admin
         module V1
           ##
+          # The Cloud Firestore Admin API.
+          #
+          # This API provides several administrative services for Cloud Firestore.
+          #
+          # Project, Database, Namespace, Collection, Collection Group, and Document are
+          # used as defined in the Google Cloud Firestore API.
+          #
+          # Operation: An Operation represents work being performed in the background.
+          #
+          # The index service manages Cloud Firestore indexes.
+          #
+          # Index creation is performed asynchronously.
+          # An Operation resource is created for each such asynchronous operation.
+          # The state of the operation (including any errors encountered)
+          # may be queried via the Operation resource.
+          #
+          # The Operations collection provides a record of actions performed for the
+          # specified Project (including any Operations in progress). Operations are not
+          # created directly but through calls on other collections or resources.
+          #
+          # An Operation that is done may be deleted so that it is no longer listed as
+          # part of the Operation collection. Operations are garbage collected after
+          # 30 days. By default, ListOperations will only return in progress and failed
+          # operations. To list completed operation, issue a ListOperations request with
+          # the filter `done: true`.
+          #
           # Operations are created by service `FirestoreAdmin`, but are accessed via
           # service `google.longrunning.Operations`.
           #

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

@@ -22,7 +22,7 @@ module Google
     module Firestore
       module Admin
         module V1
-          VERSION = "0.3.5"
+          VERSION = "0.4.0"
         end
       end
     end

data/lib/google/firestore/admin/v1/database_pb.rb

@@ -0,0 +1,46 @@
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: google/firestore/admin/v1/database.proto
+
+require 'google/api/field_behavior_pb'
+require 'google/api/resource_pb'
+require 'google/protobuf/duration_pb'
+require 'google/protobuf/timestamp_pb'
+require 'google/api/annotations_pb'
+require 'google/protobuf'
+
+Google::Protobuf::DescriptorPool.generated_pool.build do
+  add_file("google/firestore/admin/v1/database.proto", :syntax => :proto3) do
+    add_message "google.firestore.admin.v1.Database" do
+      optional :name, :string, 1
+      optional :location_id, :string, 9
+      optional :type, :enum, 10, "google.firestore.admin.v1.Database.DatabaseType"
+      optional :concurrency_mode, :enum, 15, "google.firestore.admin.v1.Database.ConcurrencyMode"
+      optional :etag, :string, 99
+    end
+    add_enum "google.firestore.admin.v1.Database.DatabaseType" do
+      value :DATABASE_TYPE_UNSPECIFIED, 0
+      value :FIRESTORE_NATIVE, 1
+      value :DATASTORE_MODE, 2
+    end
+    add_enum "google.firestore.admin.v1.Database.ConcurrencyMode" do
+      value :CONCURRENCY_MODE_UNSPECIFIED, 0
+      value :OPTIMISTIC, 1
+      value :PESSIMISTIC, 2
+      value :OPTIMISTIC_WITH_ENTITY_GROUPS, 3
+    end
+  end
+end
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          Database = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database").msgclass
+          Database::DatabaseType = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.DatabaseType").enummodule
+          Database::ConcurrencyMode = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Database.ConcurrencyMode").enummodule
+        end
+      end
+    end
+  end
+end

data/lib/google/firestore/admin/v1/field_pb.rb

@@ -1,6 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/firestore/admin/v1/field.proto
 
+require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
 require 'google/firestore/admin/v1/index_pb'
 require 'google/api/annotations_pb'

data/lib/google/firestore/admin/v1/firestore_admin_pb.rb

@@ -5,15 +5,33 @@ require 'google/api/annotations_pb'
 require 'google/api/client_pb'
 require 'google/api/field_behavior_pb'
 require 'google/api/resource_pb'
+require 'google/firestore/admin/v1/database_pb'
 require 'google/firestore/admin/v1/field_pb'
 require 'google/firestore/admin/v1/index_pb'
+require 'google/firestore/admin/v1/operation_pb'
 require 'google/longrunning/operations_pb'
 require 'google/protobuf/empty_pb'
 require 'google/protobuf/field_mask_pb'
+require 'google/protobuf/timestamp_pb'
 require 'google/protobuf'
 
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/firestore/admin/v1/firestore_admin.proto", :syntax => :proto3) do
+    add_message "google.firestore.admin.v1.ListDatabasesRequest" do
+      optional :parent, :string, 1
+    end
+    add_message "google.firestore.admin.v1.ListDatabasesResponse" do
+      repeated :databases, :message, 1, "google.firestore.admin.v1.Database"
+    end
+    add_message "google.firestore.admin.v1.GetDatabaseRequest" do
+      optional :name, :string, 1
+    end
+    add_message "google.firestore.admin.v1.UpdateDatabaseRequest" do
+      optional :database, :message, 1, "google.firestore.admin.v1.Database"
+      optional :update_mask, :message, 2, "google.protobuf.FieldMask"
+    end
+    add_message "google.firestore.admin.v1.UpdateDatabaseMetadata" do
+    end
     add_message "google.firestore.admin.v1.CreateIndexRequest" do
       optional :parent, :string, 1
       optional :index, :message, 2, "google.firestore.admin.v1.Index"
@@ -69,6 +87,11 @@ module Google
     module Firestore
       module Admin
         module V1
+          ListDatabasesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListDatabasesRequest").msgclass
+          ListDatabasesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListDatabasesResponse").msgclass
+          GetDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.GetDatabaseRequest").msgclass
+          UpdateDatabaseRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateDatabaseRequest").msgclass
+          UpdateDatabaseMetadata = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.UpdateDatabaseMetadata").msgclass
           CreateIndexRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.CreateIndexRequest").msgclass
           ListIndexesRequest = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesRequest").msgclass
           ListIndexesResponse = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.ListIndexesResponse").msgclass

data/lib/google/firestore/admin/v1/firestore_admin_services_pb.rb

@@ -1,7 +1,7 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # Source: google/firestore/admin/v1/firestore_admin.proto for package 'Google.Cloud.Firestore.Admin.V1'
 # Original file comments:
-# Copyright 2019 Google LLC.
+# Copyright 2021 Google LLC
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,7 +15,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-#
 
 require 'grpc'
 require 'google/firestore/admin/v1/firestore_admin_pb'
@@ -26,6 +25,32 @@ module Google
       module Admin
         module V1
           module FirestoreAdmin
+            # The Cloud Firestore Admin API.
+            #
+            # This API provides several administrative services for Cloud Firestore.
+            #
+            # Project, Database, Namespace, Collection, Collection Group, and Document are
+            # used as defined in the Google Cloud Firestore API.
+            #
+            # Operation: An Operation represents work being performed in the background.
+            #
+            # The index service manages Cloud Firestore indexes.
+            #
+            # Index creation is performed asynchronously.
+            # An Operation resource is created for each such asynchronous operation.
+            # The state of the operation (including any errors encountered)
+            # may be queried via the Operation resource.
+            #
+            # The Operations collection provides a record of actions performed for the
+            # specified Project (including any Operations in progress). Operations are not
+            # created directly but through calls on other collections or resources.
+            #
+            # An Operation that is done may be deleted so that it is no longer listed as
+            # part of the Operation collection. Operations are garbage collected after
+            # 30 days. By default, ListOperations will only return in progress and failed
+            # operations. To list completed operation, issue a ListOperations request with
+            # the filter `done: true`.
+            #
             # Operations are created by service `FirestoreAdmin`, but are accessed via
             # service `google.longrunning.Operations`.
             class Service
@@ -67,7 +92,7 @@ module Google
               # Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields
               # that have been explicitly overridden. To issue this query, call
               # [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to
-              # `indexConfig.usesAncestorConfig:false`.
+              # `indexConfig.usesAncestorConfig:false` .
               rpc :ListFields, ::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest, ::Google::Cloud::Firestore::Admin::V1::ListFieldsResponse
               # 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
@@ -77,6 +102,9 @@ module Google
               # 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.
+              #
+              # For more details on export behavior and output format, refer to:
+              # https://cloud.google.com/firestore/docs/manage-data/export-import
               rpc :ExportDocuments, ::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest, ::Google::Longrunning::Operation
               # Imports documents into Google Cloud Firestore. Existing documents with the
               # same name are overwritten. The import occurs in the background and its
@@ -84,6 +112,12 @@ module Google
               # created. If an ImportDocuments operation is cancelled, it is possible
               # that a subset of the data has already been imported to Cloud Firestore.
               rpc :ImportDocuments, ::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest, ::Google::Longrunning::Operation
+              # Gets information about a database.
+              rpc :GetDatabase, ::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest, ::Google::Cloud::Firestore::Admin::V1::Database
+              # List all the databases in the project.
+              rpc :ListDatabases, ::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest, ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse
+              # Updates a database.
+              rpc :UpdateDatabase, ::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest, ::Google::Longrunning::Operation
             end
 
             Stub = Service.rpc_stub_class

data/proto_docs/google/api/resource.rb

@@ -33,11 +33,7 @@ module Google
     #       // For Kubernetes resources, the format is {api group}/{kind}.
     #       option (google.api.resource) = {
     #         type: "pubsub.googleapis.com/Topic"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
+    #         pattern: "projects/{project}/topics/{topic}"
     #       };
     #     }
     #
@@ -45,10 +41,7 @@ module Google
     #
     #     resources:
     #     - type: "pubsub.googleapis.com/Topic"
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/topics/{topic}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
+    #       pattern: "projects/{project}/topics/{topic}"
     #
     # Sometimes, resources have multiple patterns, typically because they can
     # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
     #     message LogEntry {
     #       option (google.api.resource) = {
     #         type: "logging.googleapis.com/LogEntry"
-    #         name_descriptor: {
-    #           pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #         }
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
     #       };
     #     }
     #
@@ -85,48 +62,10 @@ module Google
     #
     #     resources:
     #     - type: 'logging.googleapis.com/LogEntry'
-    #       name_descriptor:
-    #         - pattern: "projects/{project}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #           parent_name_extractor: "projects/{project}"
-    #         - pattern: "folders/{folder}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #           parent_name_extractor: "folders/{folder}"
-    #         - pattern: "organizations/{organization}/logs/{log}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Organization"
-    #           parent_name_extractor: "organizations/{organization}"
-    #         - pattern: "billingAccounts/{billing_account}/logs/{log}"
-    #           parent_type: "billing.googleapis.com/BillingAccount"
-    #           parent_name_extractor: "billingAccounts/{billing_account}"
-    #
-    # For flexible resources, the resource name doesn't contain parent names, but
-    # the resource itself has parents for policy evaluation.
-    #
-    # Example:
-    #
-    #     message Shelf {
-    #       option (google.api.resource) = {
-    #         type: "library.googleapis.com/Shelf"
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         }
-    #         name_descriptor: {
-    #           pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
-    #         }
-    #       };
-    #     }
-    #
-    # The ResourceDescriptor Yaml config will look like:
-    #
-    #     resources:
-    #     - type: 'library.googleapis.com/Shelf'
-    #       name_descriptor:
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Project"
-    #         - pattern: "shelves/{shelf}"
-    #           parent_type: "cloudresourcemanager.googleapis.com/Folder"
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
     # @!attribute [rw] type
     #   @return [::String]
     #     The resource type. It must be in the format of

data/proto_docs/google/firestore/admin/v1/database.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# Copyright 2022 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        module V1
+          # A Cloud Firestore Database.
+          # Currently only one database is allowed per cloud project; this database
+          # must have a `database_id` of '(default)'.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     The resource name of the Database.
+          #     Format: `projects/{project}/databases/{database}`
+          # @!attribute [rw] location_id
+          #   @return [::String]
+          #     The location of the database. Available databases are listed at
+          #     https://cloud.google.com/firestore/docs/locations.
+          # @!attribute [rw] type
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database::DatabaseType]
+          #     The type of the database.
+          #     See https://cloud.google.com/datastore/docs/firestore-or-datastore for
+          #     information about how to choose.
+          # @!attribute [rw] concurrency_mode
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database::ConcurrencyMode]
+          #     The concurrency control mode to use for this database.
+          # @!attribute [rw] etag
+          #   @return [::String]
+          #     This checksum is computed by the server based on the value of other
+          #     fields, and may be sent on update and delete requests to ensure the
+          #     client has an up-to-date value before proceeding.
+          class Database
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the database.
+            # See https://cloud.google.com/datastore/docs/firestore-or-datastore for
+            # information about how to choose.
+            module DatabaseType
+              # The default value. This value is used if the database type is omitted.
+              DATABASE_TYPE_UNSPECIFIED = 0
+
+              # Firestore Native Mode
+              FIRESTORE_NATIVE = 1
+
+              # Firestore in Datastore Mode.
+              DATASTORE_MODE = 2
+            end
+
+            # The type of concurrency control mode for transactions.
+            module ConcurrencyMode
+              # Not used.
+              CONCURRENCY_MODE_UNSPECIFIED = 0
+
+              # Use optimistic concurrency control by default. This setting is available
+              # for Cloud Firestore customers.
+              OPTIMISTIC = 1
+
+              # Use pessimistic concurrency control by default. This setting is available
+              # for Cloud Firestore customers.
+              # This is the default setting for Cloud Firestore.
+              PESSIMISTIC = 2
+
+              # Use optimistic concurrency control with entity groups by default. This is
+              # the only available setting for Cloud Datastore customers.
+              # This is the default setting for Cloud Datastore.
+              OPTIMISTIC_WITH_ENTITY_GROUPS = 3
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/firestore/admin/v1/field.rb

@@ -28,7 +28,7 @@ module Google
           # collections in the database with the same id.
           # @!attribute [rw] name
           #   @return [::String]
-          #     A field name of the form
+          #     Required. A field name of the form
           #     `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`
           #
           #     A field path may be a simple field name, e.g. `address` or a path to fields

data/proto_docs/google/firestore/admin/v1/firestore_admin.rb

@@ -22,6 +22,53 @@ module Google
     module Firestore
       module Admin
         module V1
+          # A request to list the Firestore Databases in all locations for a project.
+          # @!attribute [rw] parent
+          #   @return [::String]
+          #     Required. A parent name of the form
+          #     `projects/{project_id}`
+          class ListDatabasesRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The list of databases for a project.
+          # @!attribute [rw] databases
+          #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::Database>]
+          #     The databases in the project.
+          class ListDatabasesResponse
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#get_database FirestoreAdmin.GetDatabase}.
+          # @!attribute [rw] name
+          #   @return [::String]
+          #     Required. A name of the form
+          #     `projects/{project_id}/databases/{database_id}`
+          class GetDatabaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_database FirestoreAdmin.UpdateDatabase}.
+          # @!attribute [rw] database
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Database]
+          #     Required. The database to update.
+          # @!attribute [rw] update_mask
+          #   @return [::Google::Protobuf::FieldMask]
+          #     The list of fields to be updated.
+          class UpdateDatabaseRequest
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Metadata related to the update database operation.
+          class UpdateDatabaseMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # The request for {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_index FirestoreAdmin.CreateIndex}.
           # @!attribute [rw] parent
           #   @return [::String]
@@ -122,8 +169,8 @@ module Google
           #     The filter to apply to list results. Currently,
           #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} only supports listing fields
           #     that have been explicitly overridden. To issue this query, call
-          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with the filter set to
-          #     `indexConfig.usesAncestorConfig:false`.
+          #     {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields FirestoreAdmin.ListFields} with a filter that includes
+          #     `indexConfig.usesAncestorConfig:false` .
           # @!attribute [rw] page_size
           #   @return [::Integer]
           #     The number of results to return.

data/proto_docs/google/firestore/admin/v1/index.rb

@@ -70,7 +70,7 @@ module Google
             # @!attribute [rw] order
             #   @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::Order]
             #     Indicates that this field supports ordering by the specified order or
-            #     comparing using =, <, <=, >, >=.
+            #     comparing using =, !=, <, <=, >, >=.
             # @!attribute [rw] array_config
             #   @return [::Google::Cloud::Firestore::Admin::V1::Index::IndexField::ArrayConfig]
             #     Indicates that this field supports operations on `array_value`s.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -177,6 +177,7 @@ files:
 - lib/google/cloud/firestore/admin/v1/firestore_admin/operations.rb
 - lib/google/cloud/firestore/admin/v1/firestore_admin/paths.rb
 - lib/google/cloud/firestore/admin/v1/version.rb
+- lib/google/firestore/admin/v1/database_pb.rb
 - lib/google/firestore/admin/v1/field_pb.rb
 - lib/google/firestore/admin/v1/firestore_admin_pb.rb
 - lib/google/firestore/admin/v1/firestore_admin_services_pb.rb
@@ -186,6 +187,7 @@ files:
 - proto_docs/README.md
 - proto_docs/google/api/field_behavior.rb
 - proto_docs/google/api/resource.rb
+- proto_docs/google/firestore/admin/v1/database.rb
 - proto_docs/google/firestore/admin/v1/field.rb
 - proto_docs/google/firestore/admin/v1/firestore_admin.rb
 - proto_docs/google/firestore/admin/v1/index.rb
@@ -218,7 +220,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Cloud Firestore Admin V1 API