google-cloud-firestore-admin-v1 0.7.1 → 0.9.0

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "gapic/rest"
+require "gapic/config"
+require "gapic/config/method"
+
+require "google/cloud/firestore/admin/v1/version"
+
+require "google/cloud/firestore/admin/v1/firestore_admin/credentials"
+require "google/cloud/firestore/admin/v1/firestore_admin/paths"
+require "google/cloud/firestore/admin/v1/firestore_admin/rest/operations"
+require "google/cloud/firestore/admin/v1/firestore_admin/rest/client"
+
+module Google
+  module Cloud
+    module Firestore
+      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`.
+          #
+          # To load this service and instantiate a REST client:
+          #
+          #     require "google/cloud/firestore/admin/v1/firestore_admin/rest"
+          #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
+          #
+          module FirestoreAdmin
+            # Client for the REST transport
+            module Rest
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+helper_path = ::File.join __dir__, "rest", "helpers.rb"
+require "google/cloud/firestore/admin/v1/firestore_admin/rest/helpers" if ::File.file? helper_path

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

@@ -26,6 +26,7 @@ require "google/cloud/firestore/admin/v1/firestore_admin/credentials"
 require "google/cloud/firestore/admin/v1/firestore_admin/paths"
 require "google/cloud/firestore/admin/v1/firestore_admin/operations"
 require "google/cloud/firestore/admin/v1/firestore_admin/client"
+require "google/cloud/firestore/admin/v1/firestore_admin/rest"
 
 module Google
   module Cloud
@@ -67,6 +68,11 @@ module Google
           #     require "google/cloud/firestore/admin/v1/firestore_admin"
           #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
           #
+          # @example Load this service and instantiate a REST client
+          #
+          #     require "google/cloud/firestore/admin/v1/firestore_admin/rest"
+          #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
+          #
           module FirestoreAdmin
           end
         end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Copyright 2023 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!
+
+require "google/cloud/firestore/admin/v1/firestore_admin/rest"
+require "google/cloud/firestore/admin/v1/version"
+
+module Google
+  module Cloud
+    module Firestore
+      module Admin
+        ##
+        # To load just the REST part of this package, including all its services, and instantiate a REST client:
+        #
+        # @example
+        #
+        #     require "google/cloud/firestore/admin/v1/rest"
+        #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
+        #
+        module V1
+        end
+      end
+    end
+  end
+end

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

@@ -22,7 +22,7 @@ module Google
     module Firestore
       module Admin
         module V1
-          VERSION = "0.7.1"
+          VERSION = "0.9.0"
         end
       end
     end

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

@@ -31,6 +31,11 @@ module Google
         #     require "google/cloud/firestore/admin/v1"
         #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
         #
+        # @example Load this package, including all its services, and instantiate a REST client
+        #
+        #     require "google/cloud/firestore/admin/v1"
+        #     client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Rest::Client.new
+        #
         module V1
         end
       end

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

@@ -10,6 +10,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     add_message "google.firestore.admin.v1.Index" do
       optional :name, :string, 1
       optional :query_scope, :enum, 2, "google.firestore.admin.v1.Index.QueryScope"
+      optional :api_scope, :enum, 5, "google.firestore.admin.v1.Index.ApiScope"
       repeated :fields, :message, 3, "google.firestore.admin.v1.Index.IndexField"
       optional :state, :enum, 4, "google.firestore.admin.v1.Index.State"
     end
@@ -33,6 +34,11 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
       value :QUERY_SCOPE_UNSPECIFIED, 0
       value :COLLECTION, 1
       value :COLLECTION_GROUP, 2
+      value :COLLECTION_RECURSIVE, 3
+    end
+    add_enum "google.firestore.admin.v1.Index.ApiScope" do
+      value :ANY_API, 0
+      value :DATASTORE_MODE_API, 1
     end
     add_enum "google.firestore.admin.v1.Index.State" do
       value :STATE_UNSPECIFIED, 0
@@ -53,6 +59,7 @@ module Google
           Index::IndexField::Order = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.Order").enummodule
           Index::IndexField::ArrayConfig = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.IndexField.ArrayConfig").enummodule
           Index::QueryScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.QueryScope").enummodule
+          Index::ApiScope = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.ApiScope").enummodule
           Index::State = ::Google::Protobuf::DescriptorPool.generated_pool.lookup("google.firestore.admin.v1.Index.State").enummodule
         end
       end

data/proto_docs/google/api/client.rb

@@ -35,7 +35,9 @@ module Google
     # Details about how and where to publish client libraries.
     # @!attribute [rw] version
     #   @return [::String]
-    #     Version of the API to apply these settings to.
+    #     Version of the API to apply these settings to. This is the full protobuf
+    #     package for the API, ending in the version element.
+    #     Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
     # @!attribute [rw] launch_stage
     #   @return [::Google::Api::LaunchStage]
     #     Launch stage of this version of the API.
@@ -81,7 +83,7 @@ module Google
     #     long-running operation pattern.
     # @!attribute [rw] new_issue_uri
     #   @return [::String]
-    #     Link to a place that API users can report issues.  Example:
+    #     Link to a *public* URI where users can report issues.  Example:
     #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
     # @!attribute [rw] documentation_uri
     #   @return [::String]
@@ -111,6 +113,10 @@ module Google
     #     Client library settings.  If the same version string appears multiple
     #     times in this list, then the last one wins.  Settings from earlier
     #     settings with the same version string are discarded.
+    # @!attribute [rw] proto_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to proto reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
     class Publishing
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from original service names to renamed versions.
+    #     This is used when the default generated types
+    #     would cause a naming conflict. (Neither name is
+    #     fully-qualified.)
+    #     Example: Subscriber to SubscriberServiceApi.
+    # @!attribute [rw] renamed_resources
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from full resource types to the effective short name
+    #     for the resource. This is used when otherwise resource
+    #     named from different services would cause naming collisions.
+    #     Example entry:
+    #     "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
+    # @!attribute [rw] ignored_resources
+    #   @return [::Array<::String>]
+    #     List of full resource types to ignore during generation.
+    #     This is typically used for API-specific Location resources,
+    #     which should be handled by the generator as if they were actually
+    #     the common Location resources.
+    #     Example entry: "documentai.googleapis.com/Location"
+    # @!attribute [rw] forced_namespace_aliases
+    #   @return [::Array<::String>]
+    #     Namespaces which must be aliased in snippets due to
+    #     a known (but non-generator-predictable) naming collision
+    # @!attribute [rw] handwritten_signatures
+    #   @return [::Array<::String>]
+    #     Method signatures (in the form "service.method(signature)")
+    #     which are provided separately, so shouldn't be generated.
+    #     Snippets *calling* these methods are still generated, however.
     class DotnetSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedResourcesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
     #     Example of a YAML configuration::
     #
     #      publishing:
-    #        method_behavior:
-    #          - selector: CreateAdDomain
+    #        method_settings:
+    #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
     #              initial_poll_delay:
     #                seconds: 60 # 1 minute
@@ -299,6 +353,15 @@ module Google
 
       # Street View Org.
       STREET_VIEW = 4
+
+      # Shopping Org.
+      SHOPPING = 5
+
+      # Geo Org.
+      GEO = 6
+
+      # Generative AI - https://developers.generativeai.google
+      GENERATIVE_AI = 7
     end
 
     # To where should client libraries be published?

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

@@ -39,16 +39,19 @@ module Google
           #     Indexes with a collection group query scope specified allow queries against
           #     all collections descended from a specific document, specified at query
           #     time, and that have the same collection id as this index.
+          # @!attribute [rw] api_scope
+          #   @return [::Google::Cloud::Firestore::Admin::V1::Index::ApiScope]
+          #     The API scope supported by this index.
           # @!attribute [rw] fields
           #   @return [::Array<::Google::Cloud::Firestore::Admin::V1::Index::IndexField>]
           #     The fields supported by this index.
           #
-          #     For composite indexes, this is always 2 or more fields.
-          #     The last field entry is always for the field path `__name__`. If, on
-          #     creation, `__name__` was not specified as the last field, it will be added
-          #     automatically with the same direction as that of the last field defined. If
-          #     the final field in a composite index is not directional, the `__name__`
-          #     will be ordered ASCENDING (unless explicitly specified).
+          #     For composite indexes, this requires a minimum of 2 and a maximum of 100
+          #     fields. The last field entry is always for the field path `__name__`. If,
+          #     on creation, `__name__` was not specified as the last field, it will be
+          #     added automatically with the same direction as that of the last field
+          #     defined. If the final field in a composite index is not directional, the
+          #     `__name__` will be ordered ASCENDING (unless explicitly specified).
           #
           #     For single field indexes, this will always be exactly one entry with a
           #     field path equal to the field path of the associated field.
@@ -115,6 +118,21 @@ module Google
               # against all collections that has the collection id specified by the
               # index.
               COLLECTION_GROUP = 2
+
+              # Include all the collections's ancestor in the index. Only available for
+              # Datastore Mode databases.
+              COLLECTION_RECURSIVE = 3
+            end
+
+            # API Scope defines the APIs (Firestore Native, or Firestore in
+            # Datastore Mode) that are supported for queries.
+            module ApiScope
+              # The index can only be used by the Firestore Native query API.
+              # This is the default.
+              ANY_API = 0
+
+              # The index can only be used by the Firestore in Datastore Mode query API.
+              DATASTORE_MODE_API = 1
             end
 
             # The state of an index. During index creation, an index will be in the

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.16.0
+        version: 0.18.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -60,7 +60,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -70,14 +70,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.26.1
+        version: 1.26.3
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -197,6 +197,11 @@ files:
 - lib/google/cloud/firestore/admin/v1/firestore_admin/credentials.rb
 - 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/firestore_admin/rest.rb
+- lib/google/cloud/firestore/admin/v1/firestore_admin/rest/client.rb
+- lib/google/cloud/firestore/admin/v1/firestore_admin/rest/operations.rb
+- lib/google/cloud/firestore/admin/v1/firestore_admin/rest/service_stub.rb
+- lib/google/cloud/firestore/admin/v1/rest.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
@@ -245,5 +250,6 @@ requirements: []
 rubygems_version: 3.4.2
 signing_key: 
 specification_version: 4
-summary: API Client library for the Cloud Firestore Admin V1 API
+summary: Accesses the NoSQL document database built for automatic scaling, high performance,
+  and ease of application development.
 test_files: []