google-cloud-firestore-admin-v1 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d2b82bc7e31a94b443d3488036598da63964727af49bc0b3a470cc7363a14a6
-  data.tar.gz: 5a57057c552eea368c848128f84269060ac6c0808be571052f72a5cd04239a84
+  metadata.gz: e8332e8f997799ea3eca52fa8b19300bfac3c708835eadda9f4fdba79beddbe0
+  data.tar.gz: d3d92ee8ccc16ca13091baa7e42fbfa270ef20f89fc782980fcd7aa602bbd32b
 SHA512:
-  metadata.gz: ae3ab82b13d2d1b0a929fa80749e93e33034fb2c8f1633deeef087c2ec5ea5e9908a82ac543c823474bd3b52053d49c240bb0ceb9a889e8a9a63f1cfa79203f9
-  data.tar.gz: e1ed38ee364e96a8b2f7b33dd887b4a42dbac1b6d89caf855969772dbc2ded8afdaf21621edc32cf472eaac97fab58d621907ec27ec88aba9cdea00588ea5dbb
+  metadata.gz: d95fab527f7af306d03f515a4ed0ff6e95e5ad2240ec847ec3aab727200126c69c29881e3070f97f90e5ff5cd28188ccaf8f7f75d7562b86c8289cb8197b2fce
+  data.tar.gz: bc83c74251f2056b3ade43dcb58008244ee91175813f48cc47bb6744a5d14501439acec1868f64cfec9e3d8029b22056d62752760b529df3188c501e1b7553b2

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.
 
@@ -9,7 +9,7 @@ https://github.com/googleapis/google-cloud-ruby
 This gem is a _versioned_ client. It provides basic client classes for a
 specific version of the Cloud Firestore Admin V1 API. Most users should consider using
 the main client gem,
-[google-cloud-firestore](https://rubygems.org/gems/google-cloud-firestore).
+[google-cloud-firestore-admin](https://rubygems.org/gems/google-cloud-firestore-admin).
 See the section below titled *Which client should I use?* for more information.
 
 ## Installation
@@ -46,7 +46,7 @@ for general usage information.
 ## Enabling Logging
 
 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/stdlib/libdoc/logger/rdoc/Logger.html) as shown below,
+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)
 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.
@@ -88,7 +88,7 @@ support schedule.
 ## Which client should I use?
 
 Most modern Ruby client libraries for Google APIs come in two flavors: the main
-client library with a name such as `google-cloud-firestore`,
+client library with a name such as `google-cloud-firestore-admin`,
 and lower-level _versioned_ client libraries with names such as
 `google-cloud-firestore-admin-v1`.
 _In most cases, you should install the main client._
@@ -115,7 +115,7 @@ service version.
 
 We recommend that most users install the main client gem for a service. You can
 identify this gem as the one _without_ a version in its name, e.g.
-`google-cloud-firestore`.
+`google-cloud-firestore-admin`.
 The main client is recommended because it will embody the best practices for
 accessing the service, and may also provide more convenient interfaces or
 tighter integration into frameworks and third-party libraries. In addition, the

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

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