# Cloud Firestore Admin API - Module Google::Cloud::Firestore::Admin (v0.7.0)

0.7.0 (latest) 0.6.0 0.5.2 0.4.1 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Cloud Firestore Admin API module Google::Cloud::Firestore::Admin.

## Methods

### .configure

    def self.configure() -> ::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.
  - `:jitter` (*type:* `Numeric`) - The jitter in seconds. Default: 1.0.
  - `:retry_codes` (*type:* `Array<String>`) - The error codes that should trigger a retry.
**Yields**

- (::Google::Cloud.configure.firestore_admin)
**Returns**

- (::Google::Cloud::Config) --- The default configuration used by this library

### .firestore_admin

    def self.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](https://cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/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
[Admin.firestore_admin_available?](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin/latest/Google-Cloud-Firestore-Admin#Google__Cloud__Firestore__Admin_firestore_admin_available__class_ "Google::Cloud::Firestore::Admin.firestore_admin_available? (method)").

#### 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`.

<br />

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.

### .firestore_admin_available?

    def self.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 [Admin.firestore_admin](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin/latest/Google-Cloud-Firestore-Admin#Google__Cloud__Firestore__Admin_firestore_admin_class_ "Google::Cloud::Firestore::Admin.firestore_admin (method)").
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.

## Constants

### VERSION

**value:**"0.7.0"