lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb in google-cloud-firestore-admin-v1-0.7.1 vs lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb in google-cloud-firestore-admin-v1-0.8.0
- old
+ new
@@ -276,18 +276,18 @@
# 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 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
raise ::ArgumentError, "request must be provided" if request.nil?
@@ -378,17 +378,15 @@
# 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 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
raise ::ArgumentError, "request must be provided" if request.nil?
@@ -743,18 +741,18 @@
# 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 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
raise ::ArgumentError, "request must be provided" if request.nil?
@@ -854,17 +852,15 @@
# 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 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
raise ::ArgumentError, "request must be provided" if request.nil?
@@ -968,18 +964,18 @@
# 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 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
raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1075,18 +1071,18 @@
# 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 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
raise ::ArgumentError, "request must be provided" if request.nil?
@@ -1342,17 +1338,17 @@
# 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:
+ # # 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
raise ::ArgumentError, "request must be provided" if request.nil?