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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 662f74a6d1aa36039b5f3539b475b6f4fb4b703a9ff1e8b3a227fe6bb72713c3
-  data.tar.gz: 429d18a2f317a7e22aae8c17917737a38b2f2a6fcb15c7b5adacd88e3fd491be
+  metadata.gz: 44272042c309e5302eec5551cd6a25645a0b73d4cc0beec3f9adf8670bb41248
+  data.tar.gz: 2d6525b835a1fa295c255479e83f4212aa309dd3427178109d7aa49bd71dcaf4
 SHA512:
-  metadata.gz: e6b90a823c1e230c0592167cb2ada5a128d665027e6e0b30e4f5e91073adc7309404f244938d4563dcdef9751cc7eba1a2fc716d074d64d1457d167affdf0099
-  data.tar.gz: 652211218a72f7fdc5b4afe6af68c574e2399123a8a4f0a2d07a045dc692787790a039c805ebf520b97d01f57aaa3ca0da2b38943963d9e6e9ea162284d37a4f
+  metadata.gz: f033088ffadc96e0ad1ab201745f0b16656bf799ac926afc7d9239aa4c1ce5097f41adf73de2a7a005381af6393da8680b525a4a7c57955f6af205de37a4e5d6
+  data.tar.gz: cea92f85b56fde40ef31de9a3a9f6282cc9bd7680b812638e88f9b842c3a7b3c505de6b15847c679679604cc008d8db2a045e1ad0b1eec317b20870a6a587f47

data/README.md

@@ -1,6 +1,6 @@
 # Ruby Client for the Cloud Firestore Admin V1 API
 
-API Client library for the Cloud Firestore Admin V1 API
+Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
 
 Cloud Firestore is a NoSQL document database built for automatic scaling, high performance, and ease of application development.
 
@@ -47,7 +47,7 @@ for general usage information.
 
 To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
 The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest)
+or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
 that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
 and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 

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

@@ -278,14 +278,14 @@ module Google
               #   # Call the create_index method.
               #   result = client.create_index 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def create_index request, options = nil
@@ -380,13 +380,11 @@ module Google
               #   # Call the list_indexes method.
               #   result = client.list_indexes request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # 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 response
+              #     p item
               #   end
               #
               def list_indexes request, options = nil
@@ -745,14 +743,14 @@ module Google
               #   # Call the update_field method.
               #   result = client.update_field 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def update_field request, options = nil
@@ -856,13 +854,11 @@ module Google
               #   # Call the list_fields method.
               #   result = client.list_fields request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # 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 response
+              #     p item
               #   end
               #
               def list_fields request, options = nil
@@ -970,14 +966,14 @@ module Google
               #   # Call the export_documents method.
               #   result = client.export_documents 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def export_documents request, options = nil
@@ -1077,14 +1073,14 @@ module Google
               #   # Call the import_documents method.
               #   result = client.import_documents 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def import_documents request, options = nil
@@ -1344,14 +1340,14 @@ module Google
               #   # 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def update_database request, options = nil
@@ -1434,9 +1430,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
               #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
               #    *  (`nil`) indicating no credentials

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

@@ -159,13 +159,11 @@ module Google
               #   # Call the list_operations method.
               #   result = client.list_operations request
               #
-              #   # The returned object is of type Gapic::PagedEnumerable. You can
-              #   # iterate over all elements by calling #each, and the enumerable
-              #   # will lazily make API calls to fetch subsequent pages. Other
-              #   # methods are also available for managing paging directly.
-              #   result.each do |response|
+              #   # 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 response
+              #     p item
               #   end
               #
               def list_operations request, options = nil
@@ -254,14 +252,14 @@ module Google
               #   # Call the get_operation method.
               #   result = client.get_operation 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def get_operation request, options = nil
@@ -541,14 +539,14 @@ module Google
               #   # Call the wait_operation method.
               #   result = client.wait_operation 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:
+              #   # 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 "Error!"
+              #     puts "No response received."
               #   end
               #
               def wait_operation request, options = nil
@@ -623,9 +621,9 @@ module Google
               #    *  (`String`) The path to a service account key file in JSON format
               #    *  (`Hash`) A service account key as a Hash
               #    *  (`Google::Auth::Credentials`) A googleauth credentials object
-              #       (see the [googleauth docs](https://googleapis.dev/ruby/googleauth/latest/index.html))
+              #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
               #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
-              #       (see the [signet docs](https://googleapis.dev/ruby/signet/latest/Signet/OAuth2/Client.html))
+              #       (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
               #    *  (`GRPC::Core::Channel`) a gRPC channel with included credentials
               #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
               #    *  (`nil`) indicating no credentials