Module: Google::Cloud::Firestore::Admin

Defined in:
lib/google/cloud/firestore/admin.rb,
lib/google/cloud/firestore/admin/version.rb

Constant Summary collapse

VERSION = 
"0.5.2"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.firestore_admin| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-firestore-admin library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



174
175
176
177
178
 
# File 'lib/google/cloud/firestore/admin.rb', line 174

def self.configure
  yield ::Google::Cloud.configure.firestore_admin if block_given?

  ::Google::Cloud.configure.firestore_admin
end

.firestore_admin(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for FirestoreAdmin.

By default, this returns an instance of Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the FirestoreAdmin service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the FirestoreAdmin service. You can determine whether the method will succeed by calling firestore_admin_available?.

About FirestoreAdmin

The Cloud Firestore Admin API.

This API provides several administrative services for Cloud Firestore.

Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.

Operation: An Operation represents work being performed in the background.

The index service manages Cloud Firestore indexes.

Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.

The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.

An Operation that is done may be deleted so that it is no longer listed as part of the Operation collection. Operations are garbage collected after 30 days. By default, ListOperations will only return in progress and failed operations. To list completed operation, issue a ListOperations request with the filter done: true.

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/google/cloud/firestore/admin.rb', line 103

def self.firestore_admin version: :v1, transport: :grpc, &block
  require "google/cloud/firestore/admin/#{version.to_s.downcase}"

  package_name = Google::Cloud::Firestore::Admin
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::Firestore::Admin.const_get(package_name).const_get(:FirestoreAdmin)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.firestore_admin_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the FirestoreAdmin service is supported by the current client. If true, you can retrieve a client object by calling firestore_admin. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the FirestoreAdmin service, or if the versioned client gem needs an update to support the FirestoreAdmin service.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/google/cloud/firestore/admin.rb', line 127

def self.firestore_admin_available? version: :v1, transport: :grpc
  require "google/cloud/firestore/admin/#{version.to_s.downcase}"
  package_name = Google::Cloud::Firestore::Admin
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::Firestore::Admin.const_get package_name
  return false unless service_module.const_defined? :FirestoreAdmin
  service_module = service_module.const_get :FirestoreAdmin
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end