lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb in google-cloud-firestore-admin-v1-0.3.2 vs lib/google/cloud/firestore/admin/v1/firestore_admin/client.rb in google-cloud-firestore-admin-v1-0.3.3
- old
+ new
@@ -41,18 +41,17 @@
# Configure the FirestoreAdmin Client class.
#
# See {::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration}
# for a description of the configuration fields.
#
- # ## Example
+ # @example
#
- # To modify the configuration for all FirestoreAdmin clients:
+ # # Modify the configuration for all FirestoreAdmin clients
+ # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
+ # config.timeout = 10.0
+ # end
#
- # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
- # config.timeout = 10.0
- # end
- #
# @yield [config] Configure the Client client.
# @yieldparam config [Client::Configuration]
#
# @return [Client::Configuration]
#
@@ -127,24 +126,20 @@
end
##
# Create a new FirestoreAdmin client object.
#
- # ## Examples
+ # @example
#
- # To create a new FirestoreAdmin client with the default
- # configuration:
+ # # Create a client using the default configuration
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
#
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new
+ # # Create a client using a custom configuration
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
+ # config.timeout = 10.0
+ # end
#
- # To create a new FirestoreAdmin client with a custom
- # configuration:
- #
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
- # config.timeout = 10.0
- # end
- #
# @yield [config] Configure the FirestoreAdmin client.
# @yieldparam config [Client::Configuration]
#
def initialize
# These require statements are intentionally placed here to initialize
@@ -159,14 +154,13 @@
# Yield the configuration if needed
yield @config if block_given?
# Create credentials
credentials = @config.credentials
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
+ # Use self-signed JWT if the endpoint is unchanged from default,
# but only if the default endpoint does not have a region prefix.
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
- @config.endpoint == Client.configure.endpoint &&
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
!@config.endpoint.split(".").first.include?("-")
credentials ||= Credentials.default scope: @config.scope,
enable_self_signed_jwt: enable_self_signed_jwt
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
credentials = Credentials.new credentials, scope: @config.scope
@@ -255,11 +249,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.create_index.timeout,
metadata: metadata,
retry_policy: @config.rpcs.create_index.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :create_index, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
@@ -331,11 +327,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_indexes.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_indexes.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :list_indexes, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @firestore_admin_stub, :list_indexes, request, response, operation, options
yield response, operation if block_given?
@@ -399,11 +397,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_index.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_index.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :get_index, request, options: options do |response, operation|
yield response, operation if block_given?
return response
@@ -466,11 +466,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.delete_index.timeout,
metadata: metadata,
retry_policy: @config.rpcs.delete_index.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :delete_index, request, options: options do |response, operation|
yield response, operation if block_given?
return response
@@ -533,11 +535,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.get_field.timeout,
metadata: metadata,
retry_policy: @config.rpcs.get_field.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :get_field, request, options: options do |response, operation|
yield response, operation if block_given?
return response
@@ -614,11 +618,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.update_field.timeout,
metadata: metadata,
retry_policy: @config.rpcs.update_field.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :update_field, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
@@ -699,11 +705,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.list_fields.timeout,
metadata: metadata,
retry_policy: @config.rpcs.list_fields.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :list_fields, request, options: options do |response, operation|
response = ::Gapic::PagedEnumerable.new @firestore_admin_stub, :list_fields, request, response, operation, options
yield response, operation if block_given?
@@ -785,11 +793,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.export_documents.timeout,
metadata: metadata,
retry_policy: @config.rpcs.export_documents.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :export_documents, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
@@ -866,11 +876,13 @@
metadata[:"x-goog-request-params"] ||= request_params_header
options.apply_defaults timeout: @config.rpcs.import_documents.timeout,
metadata: metadata,
retry_policy: @config.rpcs.import_documents.retry_policy
- options.apply_defaults metadata: @config.metadata,
+
+ options.apply_defaults timeout: @config.timeout,
+ metadata: @config.metadata,
retry_policy: @config.retry_policy
@firestore_admin_stub.call_rpc :import_documents, request, options: options do |response, operation|
response = ::Gapic::Operation.new response, @operations_client, options: options
yield response, operation if block_given?
@@ -891,25 +903,24 @@
# for a list of RPCs that can be configured independently.
#
# Configuration can be applied globally to all clients, or to a single client
# on construction.
#
- # # Examples
+ # @example
#
- # To modify the global config, setting the timeout for create_index
- # to 20 seconds, and all remaining timeouts to 10 seconds:
+ # # Modify the global config, setting the timeout for
+ # # create_index to 20 seconds,
+ # # and all remaining timeouts to 10 seconds.
+ # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
+ # config.timeout = 10.0
+ # config.rpcs.create_index.timeout = 20.0
+ # end
#
- # ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
- # config.timeout = 10.0
- # config.rpcs.create_index.timeout = 20.0
- # end
- #
- # To apply the above configuration only to a new client:
- #
- # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
- # config.timeout = 10.0
- # config.rpcs.create_index.timeout = 20.0
- # end
+ # # Apply the above configuration only to a new client.
+ # client = ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new do |config|
+ # config.timeout = 10.0
+ # config.rpcs.create_index.timeout = 20.0
+ # end
#
# @!attribute [rw] endpoint
# The hostname or hostname:port of the service endpoint.
# Defaults to `"firestore.googleapis.com"`.
# @return [::String]