google-cloud-firestore-admin-v1 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a64d7cdb932ca8be336d7ea367239c9cd58507c78f670afb04517640bca20d11
-  data.tar.gz: 2dd3a5fe84f5c060a8331741de3f96d545b4b542564a55252bd92a9e2be36de6
+  metadata.gz: 81e47ddb5eaa9fce2c1f17357eb5cce975f86d1041f1f2910b407fe66b937c55
+  data.tar.gz: 36a1477f52a561c65e965f3bd597938b602c10eeca69ede784a88a07b1b0bc53
 SHA512:
-  metadata.gz: ea66969fbd3c8cdf2eb7b4056e00bc4489b70303b006e4364e5f8784eb16c3462ef2f7e0688ee0f09141e0d6ffc2a737b85dbfa7817c0624ee0bd6bde215cf5d
-  data.tar.gz: 750f3c69dbb5678ebfb72976ebec7b114b2f91a28eb4b19e84d13402ec1e3c9e896649846b0dff54dadf6910b54ac6c6d58cc2d004ae31c8328253ddb1880202
+  metadata.gz: 54ba9fd6346f66b503cb909dd60bd6a879447062aee3fde3ae49c3128e1f52199db397f0e96c2d61640088764140c978d7780e85577c08422eb94f83a4869290
+  data.tar.gz: 825bc0b0b720326721587904c36c1dfff45814f57b0c371b1c683fadddae718730128566359309d5659e61700d9fe629ed90c0041a4f6fd4e3e183551d910deb

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

@@ -212,7 +212,8 @@ module Google
                   credentials:  credentials,
                   endpoint:     @config.endpoint,
                   channel_args: @config.channel_args,
-                  interceptors: @config.interceptors
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
                 )
               end
 
@@ -1620,6 +1621,14 @@ module Google
                   end
                 end
 
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
                 ##
                 # Configuration RPC class for the FirestoreAdmin API.
                 #

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

@@ -94,7 +94,8 @@ module Google
                   credentials:  credentials,
                   endpoint:     @config.endpoint,
                   channel_args: @config.channel_args,
-                  interceptors: @config.interceptors
+                  interceptors: @config.interceptors,
+                  channel_pool_config: @config.channel_pool
                 )
 
                 # Used by an LRO wrapper for some methods of this service
@@ -702,6 +703,14 @@ module Google
                   end
                 end
 
+                ##
+                # Configuration for the channel pool
+                # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
+                #
+                def channel_pool
+                  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
+                end
+
                 ##
                 # Configuration RPC class for the Operations API.
                 #

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

@@ -257,6 +257,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::CreateIndexRequest.new
+                #
+                #   # Call the create_index method.
+                #   result = client.create_index request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def create_index request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -329,6 +352,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::ListIndexesRequest.new
+                #
+                #   # Call the list_indexes method.
+                #   result = client.list_indexes request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Index.
+                #     p item
+                #   end
+                #
                 def list_indexes request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -393,6 +436,22 @@ module Google
                 # @return [::Google::Cloud::Firestore::Admin::V1::Index]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::GetIndexRequest.new
+                #
+                #   # Call the get_index method.
+                #   result = client.get_index request
+                #
+                #   # The returned object is of type Google::Cloud::Firestore::Admin::V1::Index.
+                #   p result
+                #
                 def get_index request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -456,6 +515,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest.new
+                #
+                #   # Call the delete_index method.
+                #   result = client.delete_index request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def delete_index request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -519,6 +594,22 @@ module Google
                 # @return [::Google::Cloud::Firestore::Admin::V1::Field]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::GetFieldRequest.new
+                #
+                #   # Call the get_field method.
+                #   result = client.get_field request
+                #
+                #   # The returned object is of type Google::Cloud::Firestore::Admin::V1::Field.
+                #   p result
+                #
                 def get_field request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -599,6 +690,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest.new
+                #
+                #   # Call the update_field method.
+                #   result = client.update_field request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def update_field request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -683,6 +797,26 @@ module Google
                 # @return [::Gapic::Rest::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::ListFieldsRequest.new
+                #
+                #   # Call the list_fields method.
+                #   result = client.list_fields request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Cloud::Firestore::Admin::V1::Field.
+                #     p item
+                #   end
+                #
                 def list_fields request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -768,6 +902,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest.new
+                #
+                #   # Call the export_documents method.
+                #   result = client.export_documents request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def export_documents request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -845,6 +1002,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest.new
+                #
+                #   # Call the import_documents method.
+                #   result = client.import_documents request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def import_documents request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -916,6 +1096,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest.new
+                #
+                #   # Call the create_database method.
+                #   result = client.create_database request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def create_database request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -980,6 +1183,22 @@ module Google
                 # @return [::Google::Cloud::Firestore::Admin::V1::Database]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 
@@ -1043,6 +1262,22 @@ module Google
                 # @return [::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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?
 
@@ -1107,6 +1342,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call 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::Rest::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 it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def update_database request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -137,6 +137,26 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Longrunning::ListOperationsRequest.new
+                #
+                #   # Call the list_operations method.
+                #   result = client.list_operations request
+                #
+                #   # The returned object is of type Gapic::PagedEnumerable. You can iterate
+                #   # over elements, and API calls will be issued to fetch pages as needed.
+                #   result.each do |item|
+                #     # Each element is of type ::Google::Longrunning::Operation.
+                #     p item
+                #   end
+                #
                 def list_operations request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -202,6 +222,29 @@ module Google
                 # @return [::Gapic::Operation]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Longrunning::GetOperationRequest.new
+                #
+                #   # Call the get_operation method.
+                #   result = client.get_operation request
+                #
+                #   # The returned object is of type Gapic::Operation. You can use it to
+                #   # check the status of an operation, cancel it, or wait for results.
+                #   # Here is how to wait for a response.
+                #   result.wait_until_done! timeout: 60
+                #   if result.response?
+                #     p result.response
+                #   else
+                #     puts "No response received."
+                #   end
+                #
                 def get_operation request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -268,6 +311,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Longrunning::DeleteOperationRequest.new
+                #
+                #   # Call the delete_operation method.
+                #   result = client.delete_operation request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def delete_operation request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -339,6 +398,22 @@ module Google
                 # @return [::Google::Protobuf::Empty]
                 #
                 # @raise [::Google::Cloud::Error] if the REST call is aborted.
+                #
+                # @example Basic example
+                #   require "google/longrunning"
+                #
+                #   # Create a client object. The client can be reused for multiple calls.
+                #   client = Google::Longrunning::Operations::Rest::Client.new
+                #
+                #   # Create a request. To set request fields, pass in keyword arguments.
+                #   request = Google::Longrunning::CancelOperationRequest.new
+                #
+                #   # Call the cancel_operation method.
+                #   result = client.cancel_operation request
+                #
+                #   # The returned object is of type Google::Protobuf::Empty.
+                #   p result
+                #
                 def cancel_operation request, options = nil
                   raise ::ArgumentError, "request must be provided" if request.nil?
 

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

@@ -22,7 +22,7 @@ module Google
     module Firestore
       module Admin
         module V1
-          VERSION = "0.10.0"
+          VERSION = "0.11.0"
         end
       end
     end

data/proto_docs/google/api/field_behavior.rb

@@ -66,6 +66,20 @@ module Google
       # a non-empty value will be returned. The user will not be aware of what
       # non-empty value to expect.
       NON_EMPTY_DEFAULT = 7
+
+      # Denotes that the field in a resource (a message annotated with
+      # google.api.resource) is used in the resource name to uniquely identify the
+      # resource. For AIP-compliant APIs, this should only be applied to the
+      # `name` field on the resource.
+      #
+      # This behavior should not be applied to references to other resources within
+      # the message.
+      #
+      # The identifier field of resources often have different field behavior
+      # depending on the request it is embedded in (e.g. for Create methods name
+      # is optional and unused, while for Update methods it is required). Instead
+      # of method-specific annotations, only `IDENTIFIER` is required.
+      IDENTIFIER = 8
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-firestore-admin-v1
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-06 00:00:00.000000000 Z
+date: 2023-09-12 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.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: 0.20.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -247,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.2
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Accesses the NoSQL document database built for automatic scaling, high performance,