# Cloud Firestore Admin V1 API - Class Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client (v1.13.0)

1.13.0 (latest) 1.12.1 1.11.0 1.10.0 1.9.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.1 1.3.0 1.2.0 1.1.0 1.0.1 0.18.0 0.17.1 0.16.0 0.15.0 0.14.3 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.1 0.6.0 0.5.0 0.4.0 0.3.5 Reference documentation and code samples for the Cloud Firestore Admin V1 API class Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.

Client for the FirestoreAdmin service.


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

## Inherits

- Object

## Includes

- [Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Paths](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Paths)

## Methods

### .configure

    def self.configure() { |config| ... } -> Client::Configuration

Configure the FirestoreAdmin Client class.


<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration))
**Example**

```ruby
# Modify the configuration for all FirestoreAdmin clients
::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure do |config|
  config.timeout = 10.0
end
```

### #bulk_delete_documents

    def bulk_delete_documents(request, options = nil) -> ::Gapic::Operation
    def bulk_delete_documents(name: nil, collection_ids: nil, namespace_ids: nil) -> ::Gapic::Operation

Bulk deletes a subset of documents from Google Cloud Firestore.
Documents created or updated after the underlying system starts to process
the request will not be deleted. The bulk delete occurs in the background
and its progress can be monitored and managed via the Operation resource
that is created.


<br />

For more details on bulk delete behavior, refer to:
<https://cloud.google.com/firestore/docs/manage-data/bulk-delete>
**Overloads**

    def bulk_delete_documents(request, options = nil) -> ::Gapic::Operation

Pass arguments to `bulk_delete_documents` via a request object, either of type [BulkDeleteDocumentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest "Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BulkDeleteDocumentsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def bulk_delete_documents(name: nil, collection_ids: nil, namespace_ids: nil) -> ::Gapic::Operation

Pass arguments to `bulk_delete_documents` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **name** (::String) --- Required. Database to operate. Should be of the form: `projects/{project_id}/databases/{database_id}`.
- **collection_ids** (::Array\<::String\>) --- Optional. IDs of the collection groups to delete. Unspecified means all collection groups.


  Each collection group in this list must be unique.
- **namespace_ids** (::Array\<::String\>) --- Optional. Namespaces to delete.


  An empty list means all namespaces. This is the recommended
  usage for databases that don't use namespaces.

  An empty string element represents the default namespace. This should be
  used if the database has data in non-default namespaces, but doesn't want
  to delete from them.

  Each namespace in this list must be unique.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::BulkDeleteDocumentsRequest.new

# Call the bulk_delete_documents method.
result = client.bulk_delete_documents request

# 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 "No response received."
end
```

### #clone_database

    def clone_database(request, options = nil) -> ::Gapic::Operation
    def clone_database(parent: nil, database_id: nil, pitr_snapshot: nil, encryption_config: nil, tags: nil) -> ::Gapic::Operation

Creates a new database by cloning an existing one.


The new database must be in the same cloud region or multi-region location
as the existing database. This behaves similar to
[FirestoreAdmin.CreateDatabase](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_create_database_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_database (method)")
except instead of creating a new empty database, a new database is created
with the database type, index configuration, and documents from an existing
database.

<br />

The [long-running operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation "Google::Longrunning::Operation (class)") can be used to
track the progress of the clone, with the Operation's
[metadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_metadata_instance_ "Google::Longrunning::Operation#metadata (method)") field type being the
[CloneDatabaseMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CloneDatabaseMetadata "Google::Cloud::Firestore::Admin::V1::CloneDatabaseMetadata (class)").
The [response](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_response_instance_ "Google::Longrunning::Operation#response (method)") type is the
[Database](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database "Google::Cloud::Firestore::Admin::V1::Database (class)") if the clone was
successful. The new database is not readable or writeable until the LRO has
completed.
**Overloads**

    def clone_database(request, options = nil) -> ::Gapic::Operation

Pass arguments to `clone_database` via a request object, either of type [CloneDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CloneDatabaseRequest "Google::Cloud::Firestore::Admin::V1::CloneDatabaseRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::CloneDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CloneDatabaseRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def clone_database(parent: nil, database_id: nil, pitr_snapshot: nil, encryption_config: nil, tags: nil) -> ::Gapic::Operation

Pass arguments to `clone_database` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The project to clone the database in. Format is `projects/{project_id}`.
- **database_id** (::String) --- Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database.


  This value should be 4-63 characters. Valid characters are /\[a-z\]\[0-9\]-/
  with first character a letter and the last a letter or a number. Must not
  be UUID-like /\[0-9a-f\]{8}(-\[0-9a-f\]{4}){3}-\[0-9a-f\]{12}/.

  "(default)" database ID is also valid if the database is Standard edition.
- **pitr_snapshot** ([::Google::Cloud::Firestore::Admin::V1::PitrSnapshot](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-PitrSnapshot), ::Hash) --- Required. Specification of the PITR data to clone from. The source database must exist.


  The cloned database will be created in the same location as the source
  database.
- **encryption_config** ([::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig), ::Hash) --- Optional. Encryption configuration for the cloned database.


  If this field is not specified, the cloned database will use
  the same encryption configuration as the source database, namely
  [use_source_encryption](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig#Google__Cloud__Firestore__Admin__V1__Database__EncryptionConfig_use_source_encryption_instance_ "Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption (method)").
- **tags** (::Hash{::String =\> ::String}) --- Optional. Immutable. Tags to be bound to the cloned database.


  The tags should be provided in the format of
  `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::CloneDatabaseRequest.new

# Call the clone_database method.
result = client.clone_database request

# 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 "No response received."
end
```

### #configure

    def configure() { |config| ... } -> Client::Configuration

Configure the FirestoreAdmin Client instance.


The configuration is set to the derived mode, meaning that values can be changed,
but structural changes (adding new fields, etc.) are not allowed. Structural changes
should be made on [Client.configure](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_configure_class_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.configure (method)").

<br />

See [Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client::Configuration (class)")
for a description of the configuration fields.
**Yields**

- (config) --- Configure the Client client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration))
**Returns**

- ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration))

### #create_backup_schedule

    def create_backup_schedule(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule
    def create_backup_schedule(parent: nil, backup_schedule: nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Creates a backup schedule on a database.
At most two backup schedules can be configured on a database, one daily
backup schedule and one weekly backup schedule.
**Overloads**

    def create_backup_schedule(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Pass arguments to `create_backup_schedule` via a request object, either of type [CreateBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateBackupScheduleRequest "Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateBackupScheduleRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def create_backup_schedule(parent: nil, backup_schedule: nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Pass arguments to `create_backup_schedule` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The parent database.


  Format `projects/{project}/databases/{database}`
- **backup_schedule** ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule), ::Hash) --- Required. The backup schedule to create.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::CreateBackupScheduleRequest.new

# Call the create_backup_schedule method.
result = client.create_backup_schedule request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::BackupSchedule.
p result
```

### #create_database

    def create_database(request, options = nil) -> ::Gapic::Operation
    def create_database(parent: nil, database: nil, database_id: nil) -> ::Gapic::Operation

Create a database.
**Overloads**

    def create_database(request, options = nil) -> ::Gapic::Operation

Pass arguments to `create_database` via a request object, either of type [CreateDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateDatabaseRequest "Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateDatabaseRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def create_database(parent: nil, database: nil, database_id: nil) -> ::Gapic::Operation

Pass arguments to `create_database` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. A parent name of the form `projects/{project_id}`
- **database** ([::Google::Cloud::Firestore::Admin::V1::Database](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database), ::Hash) --- Required. The Database to create.
- **database_id** (::String) --- Required. The ID to use for the database, which will become the final component of the database's resource name.


  This value should be 4-63 characters. Valid characters are /\[a-z\]\[0-9\]-/
  with first character a letter and the last a letter or a number. Must not
  be UUID-like /\[0-9a-f\]{8}(-\[0-9a-f\]{4}){3}-\[0-9a-f\]{12}/.

  "(default)" database ID is also valid if the database is Standard edition.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::CreateDatabaseRequest.new

# Call the create_database method.
result = client.create_database request

# 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 "No response received."
end
```

### #create_index

    def create_index(request, options = nil) -> ::Gapic::Operation
    def create_index(parent: nil, index: nil) -> ::Gapic::Operation

Creates a composite index. This returns a
[google.longrunning.Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation "Google::Longrunning::Operation (class)") which may be
used to track the status of the creation. The metadata for the operation
will be the type
[IndexOperationMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-IndexOperationMetadata "Google::Cloud::Firestore::Admin::V1::IndexOperationMetadata (class)").
**Overloads**

    def create_index(request, options = nil) -> ::Gapic::Operation

Pass arguments to `create_index` via a request object, either of type [CreateIndexRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateIndexRequest "Google::Cloud::Firestore::Admin::V1::CreateIndexRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::CreateIndexRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateIndexRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def create_index(parent: nil, index: nil) -> ::Gapic::Operation

Pass arguments to `create_index` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
- **index** ([::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index), ::Hash) --- Required. The composite index to create.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 "No response received."
end
```

### #create_user_creds

    def create_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds
    def create_user_creds(parent: nil, user_creds: nil, user_creds_id: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Create a user creds.
**Overloads**

    def create_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `create_user_creds` via a request object, either of type [CreateUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateUserCredsRequest "Google::Cloud::Firestore::Admin::V1::CreateUserCredsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::CreateUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-CreateUserCredsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def create_user_creds(parent: nil, user_creds: nil, user_creds_id: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `create_user_creds` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. A parent name of the form `projects/{project_id}/databases/{database_id}`
- **user_creds** ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds), ::Hash) --- Required. The user creds to create.
- **user_creds_id** (::String) --- Required. The ID to use for the user creds, which will become the final component of the user creds's resource name.


  This value should be 4-63 characters. Valid characters are /\[a-z\]\[0-9\]-/
  with first character a letter and the last a letter or a number. Must not
  be UUID-like /\[0-9a-f\]{8}(-\[0-9a-f\]{4}){3}-\[0-9a-f\]{12}/.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::CreateUserCredsRequest.new

# Call the create_user_creds method.
result = client.create_user_creds request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::UserCreds.
p result
```

### #delete_backup

    def delete_backup(request, options = nil) -> ::Google::Protobuf::Empty
    def delete_backup(name: nil) -> ::Google::Protobuf::Empty

Deletes a backup.
**Overloads**

    def delete_backup(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_backup` via a request object, either of type [DeleteBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteBackupRequest "Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteBackupRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def delete_backup(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_backup` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. Name of the backup to delete.


  format is `projects/{project}/locations/{location}/backups/{backup}`.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::DeleteBackupRequest.new

# Call the delete_backup method.
result = client.delete_backup request

# The returned object is of type Google::Protobuf::Empty.
p result
```

### #delete_backup_schedule

    def delete_backup_schedule(request, options = nil) -> ::Google::Protobuf::Empty
    def delete_backup_schedule(name: nil) -> ::Google::Protobuf::Empty

Deletes a backup schedule.
**Overloads**

    def delete_backup_schedule(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_backup_schedule` via a request object, either of type [DeleteBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteBackupScheduleRequest "Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteBackupScheduleRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def delete_backup_schedule(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_backup_schedule` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The name of the backup schedule.


  Format
  `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::DeleteBackupScheduleRequest.new

# Call the delete_backup_schedule method.
result = client.delete_backup_schedule request

# The returned object is of type Google::Protobuf::Empty.
p result
```

### #delete_database

    def delete_database(request, options = nil) -> ::Gapic::Operation
    def delete_database(name: nil, etag: nil) -> ::Gapic::Operation

Deletes a database.
**Overloads**

    def delete_database(request, options = nil) -> ::Gapic::Operation

Pass arguments to `delete_database` via a request object, either of type [DeleteDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteDatabaseRequest "Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteDatabaseRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def delete_database(name: nil, etag: nil) -> ::Gapic::Operation

Pass arguments to `delete_database` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}`
- **etag** (::String) --- The current etag of the Database. If an etag is provided and does not match the current etag of the database, deletion will be blocked and a FAILED_PRECONDITION error will be returned.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::DeleteDatabaseRequest.new

# Call the delete_database method.
result = client.delete_database request

# 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 "No response received."
end
```

### #delete_index

    def delete_index(request, options = nil) -> ::Google::Protobuf::Empty
    def delete_index(name: nil) -> ::Google::Protobuf::Empty

Deletes a composite index.
**Overloads**

    def delete_index(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_index` via a request object, either of type [DeleteIndexRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteIndexRequest "Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteIndexRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def delete_index(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_index` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::DeleteIndexRequest.new

# Call the delete_index method.
result = client.delete_index request

# The returned object is of type Google::Protobuf::Empty.
p result
```

### #delete_user_creds

    def delete_user_creds(request, options = nil) -> ::Google::Protobuf::Empty
    def delete_user_creds(name: nil) -> ::Google::Protobuf::Empty

Deletes a user creds.
**Overloads**

    def delete_user_creds(request, options = nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_user_creds` via a request object, either of type [DeleteUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteUserCredsRequest "Google::Cloud::Firestore::Admin::V1::DeleteUserCredsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::DeleteUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DeleteUserCredsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def delete_user_creds(name: nil) -> ::Google::Protobuf::Empty

Pass arguments to `delete_user_creds` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Protobuf::Empty](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Empty))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::DeleteUserCredsRequest.new

# Call the delete_user_creds method.
result = client.delete_user_creds request

# The returned object is of type Google::Protobuf::Empty.
p result
```

### #disable_user_creds

    def disable_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds
    def disable_user_creds(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Disables a user creds. No-op if the user creds are already disabled.
**Overloads**

    def disable_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `disable_user_creds` via a request object, either of type [DisableUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DisableUserCredsRequest "Google::Cloud::Firestore::Admin::V1::DisableUserCredsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::DisableUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-DisableUserCredsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def disable_user_creds(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `disable_user_creds` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::DisableUserCredsRequest.new

# Call the disable_user_creds method.
result = client.disable_user_creds request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::UserCreds.
p result
```

### #enable_user_creds

    def enable_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds
    def enable_user_creds(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Enables a user creds. No-op if the user creds are already enabled.
**Overloads**

    def enable_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `enable_user_creds` via a request object, either of type [EnableUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-EnableUserCredsRequest "Google::Cloud::Firestore::Admin::V1::EnableUserCredsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::EnableUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-EnableUserCredsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def enable_user_creds(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `enable_user_creds` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::EnableUserCredsRequest.new

# Call the enable_user_creds method.
result = client.enable_user_creds request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::UserCreds.
p result
```

### #export_documents

    def export_documents(request, options = nil) -> ::Gapic::Operation
    def export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil, namespace_ids: nil, snapshot_time: nil) -> ::Gapic::Operation

Exports a copy of all or a subset of documents from Google Cloud Firestore
to another storage system, such as Google Cloud Storage. Recent updates to
documents may not be reflected in the export. The export occurs in the
background and its progress can be monitored and managed via the
Operation resource that is created. The output of an export may only be
used once the associated operation is done. If an export operation is
cancelled before completion it may leave partial data behind in Google
Cloud Storage.


<br />

For more details on export behavior and output format, refer to:
<https://cloud.google.com/firestore/docs/manage-data/export-import>
**Overloads**

    def export_documents(request, options = nil) -> ::Gapic::Operation

Pass arguments to `export_documents` via a request object, either of type [ExportDocumentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ExportDocumentsRequest "Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ExportDocumentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ExportDocumentsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def export_documents(name: nil, collection_ids: nil, output_uri_prefix: nil, namespace_ids: nil, snapshot_time: nil) -> ::Gapic::Operation

Pass arguments to `export_documents` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **name** (::String) --- Required. Database to export. Should be of the form: `projects/{project_id}/databases/{database_id}`.
- **collection_ids** (::Array\<::String\>) --- IDs of the collection groups to export. Unspecified means all collection groups. Each collection group in this list must be unique.
- **output_uri_prefix** (::String) --- The output URI. Currently only supports Google Cloud Storage URIs of the form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional Google Cloud Storage namespace path. When choosing a name, be sure to consider Google Cloud Storage naming guidelines: https://cloud.google.com/storage/docs/naming. If the URI is a bucket (without a namespace path), a prefix will be generated based on the start time.
- **namespace_ids** (::Array\<::String\>) --- An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.


  An empty string element represents the default namespace. This should be
  used if the database has data in non-default namespaces, but doesn't want
  to include them. Each namespace in this list must be unique.
- **snapshot_time** ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-Timestamp), ::Hash) --- The timestamp that corresponds to the version of the database to be exported. The timestamp must be in the past, rounded to the minute and not older than [earliestVersionTime](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database#Google__Cloud__Firestore__Admin__V1__Database_earliest_version_time_instance_ "Google::Cloud::Firestore::Admin::V1::Database#earliest_version_time (method)"). If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 "No response received."
end
```

### #get_backup

    def get_backup(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Backup
    def get_backup(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Backup

Gets information about a backup.
**Overloads**

    def get_backup(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Backup

Pass arguments to `get_backup` via a request object, either of type [GetBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetBackupRequest "Google::Cloud::Firestore::Admin::V1::GetBackupRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::GetBackupRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetBackupRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_backup(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Backup

Pass arguments to `get_backup` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. Name of the backup to fetch.


  Format is `projects/{project}/locations/{location}/backups/{backup}`.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::Backup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Backup))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Backup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Backup))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::GetBackupRequest.new

# Call the get_backup method.
result = client.get_backup request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::Backup.
p result
```

### #get_backup_schedule

    def get_backup_schedule(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule
    def get_backup_schedule(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Gets information about a backup schedule.
**Overloads**

    def get_backup_schedule(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Pass arguments to `get_backup_schedule` via a request object, either of type [GetBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetBackupScheduleRequest "Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetBackupScheduleRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_backup_schedule(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Pass arguments to `get_backup_schedule` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. The name of the backup schedule.


  Format
  `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::GetBackupScheduleRequest.new

# Call the get_backup_schedule method.
result = client.get_backup_schedule request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::BackupSchedule.
p result
```

### #get_database

    def get_database(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Database
    def get_database(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Database

Gets information about a database.
**Overloads**

    def get_database(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Database

Pass arguments to `get_database` via a request object, either of type [GetDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetDatabaseRequest "Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetDatabaseRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_database(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Database

Pass arguments to `get_database` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::Database](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Database](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::GetDatabaseRequest.new

# Call the get_database method.
result = client.get_database request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::Database.
p result
```

### #get_field

    def get_field(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Field
    def get_field(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Field

Gets the metadata and configuration for a Field.
**Overloads**

    def get_field(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Field

Pass arguments to `get_field` via a request object, either of type [GetFieldRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetFieldRequest "Google::Cloud::Firestore::Admin::V1::GetFieldRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::GetFieldRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetFieldRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_field(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Field

Pass arguments to `get_field` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::Field](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Field](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::GetFieldRequest.new

# Call the get_field method.
result = client.get_field request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::Field.
p result
```

### #get_index

    def get_index(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Index
    def get_index(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Index

Gets a composite index.
**Overloads**

    def get_index(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::Index

Pass arguments to `get_index` via a request object, either of type [GetIndexRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetIndexRequest "Google::Cloud::Firestore::Admin::V1::GetIndexRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::GetIndexRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetIndexRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_index(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::Index

Pass arguments to `get_index` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::GetIndexRequest.new

# Call the get_index method.
result = client.get_index request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::Index.
p result
```

### #get_user_creds

    def get_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds
    def get_user_creds(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Gets a user creds resource. Note that the returned resource does not
contain the secret value itself.
**Overloads**

    def get_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `get_user_creds` via a request object, either of type [GetUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetUserCredsRequest "Google::Cloud::Firestore::Admin::V1::GetUserCredsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::GetUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-GetUserCredsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def get_user_creds(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `get_user_creds` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::GetUserCredsRequest.new

# Call the get_user_creds method.
result = client.get_user_creds request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::UserCreds.
p result
```

### #import_documents

    def import_documents(request, options = nil) -> ::Gapic::Operation
    def import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil, namespace_ids: nil) -> ::Gapic::Operation

Imports documents into Google Cloud Firestore. Existing documents with the
same name are overwritten. The import occurs in the background and its
progress can be monitored and managed via the Operation resource that is
created. If an ImportDocuments operation is cancelled, it is possible
that a subset of the data has already been imported to Cloud Firestore.
**Overloads**

    def import_documents(request, options = nil) -> ::Gapic::Operation

Pass arguments to `import_documents` via a request object, either of type [ImportDocumentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ImportDocumentsRequest "Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ImportDocumentsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ImportDocumentsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def import_documents(name: nil, collection_ids: nil, input_uri_prefix: nil, namespace_ids: nil) -> ::Gapic::Operation

Pass arguments to `import_documents` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **name** (::String) --- Required. Database to import into. Should be of the form: `projects/{project_id}/databases/{database_id}`.
- **collection_ids** (::Array\<::String\>) --- IDs of the collection groups to import. Unspecified means all collection groups that were included in the export. Each collection group in this list must be unique.
- **input_uri_prefix** (::String) --- Location of the exported files. This must match the output_uri_prefix of an ExportDocumentsResponse from an export that has completed successfully. See: [google.firestore.admin.v1.ExportDocumentsResponse.output_uri_prefix](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ExportDocumentsResponse#Google__Cloud__Firestore__Admin__V1__ExportDocumentsResponse_output_uri_prefix_instance_ "Google::Cloud::Firestore::Admin::V1::ExportDocumentsResponse#output_uri_prefix (method)").
- **namespace_ids** (::Array\<::String\>) --- An empty list represents all namespaces. This is the preferred usage for databases that don't use namespaces.


  An empty string element represents the default namespace. This should be
  used if the database has data in non-default namespaces, but doesn't want
  to include them. Each namespace in this list must be unique.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 "No response received."
end
```

### #initialize

    def initialize() { |config| ... } -> Client

Create a new FirestoreAdmin client object.
**Yields**

- (config) --- Configure the FirestoreAdmin client.
**Yield Parameter**

- **config** ([Client::Configuration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client-Configuration))
**Returns**

- ([Client](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client)) --- a new instance of Client
**Example**

```ruby
# Create a client using the default configuration
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
```

### #list_backup_schedules

    def list_backup_schedules(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse
    def list_backup_schedules(parent: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse

List backup schedules.
**Overloads**

    def list_backup_schedules(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse

Pass arguments to `list_backup_schedules` via a request object, either of type [ListBackupSchedulesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupSchedulesRequest "Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupSchedulesRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_backup_schedules(parent: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse

Pass arguments to `list_backup_schedules` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **parent** (::String) --- Required. The parent database.


  Format is `projects/{project}/databases/{database}`.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupSchedulesResponse))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupSchedulesResponse))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesRequest.new

# Call the list_backup_schedules method.
result = client.list_backup_schedules request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::ListBackupSchedulesResponse.
p result
```

### #list_backups

    def list_backups(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse
    def list_backups(parent: nil, filter: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse

Lists all the backups.
**Overloads**

    def list_backups(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse

Pass arguments to `list_backups` via a request object, either of type [ListBackupsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupsRequest "Google::Cloud::Firestore::Admin::V1::ListBackupsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ListBackupsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_backups(parent: nil, filter: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse

Pass arguments to `list_backups` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The location to list backups from.


  Format is `projects/{project}/locations/{location}`.
  Use `{location} = '-'` to list backups from all locations for the given
  project. This allows listing backups from a single location or from all
  locations.
- **filter** (::String) ---

  An expression that filters the list of returned backups.

  A filter expression consists of a field name, a comparison operator, and a
  value for filtering.
  The value must be a string, a number, or a boolean. The comparison operator
  must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`.
  Colon `:` is the contains operator. Filter rules are not case sensitive.

  The following fields in the [Backup](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Backup "Google::Cloud::Firestore::Admin::V1::Backup (class)") are
  eligible for filtering:
  - `database_uid` (supports `=` only)
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupsResponse))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::ListBackupsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListBackupsResponse))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::ListBackupsRequest.new

# Call the list_backups method.
result = client.list_backups request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::ListBackupsResponse.
p result
```

### #list_databases

    def list_databases(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse
    def list_databases(parent: nil, show_deleted: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse

List all the databases in the project.
**Overloads**

    def list_databases(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse

Pass arguments to `list_databases` via a request object, either of type [ListDatabasesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListDatabasesRequest "Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListDatabasesRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_databases(parent: nil, show_deleted: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse

Pass arguments to `list_databases` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. A parent name of the form `projects/{project_id}`
- **show_deleted** (::Boolean) --- If true, also returns deleted resources.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListDatabasesResponse))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListDatabasesResponse))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::ListDatabasesRequest.new

# Call the list_databases method.
result = client.list_databases request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::ListDatabasesResponse.
p result
```

### #list_fields

    def list_fields(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>
    def list_fields(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>

Lists the field configuration and metadata for this database.


<br />

Currently,
[FirestoreAdmin.ListFields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_list_fields_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields (method)")
only supports listing fields that have been explicitly overridden. To issue
this query, call
[FirestoreAdmin.ListFields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_list_fields_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields (method)")
with the filter set to `indexConfig.usesAncestorConfig:false` or
`ttlConfig:*`.
**Overloads**

    def list_fields(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>

Pass arguments to `list_fields` via a request object, either of type [ListFieldsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListFieldsRequest "Google::Cloud::Firestore::Admin::V1::ListFieldsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ListFieldsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListFieldsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_fields(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Field>

Pass arguments to `list_fields` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
- **filter** (::String) --- The filter to apply to list results. Currently, [FirestoreAdmin.ListFields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_list_fields_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields (method)") only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_list_fields_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields (method)") with a filter that includes `indexConfig.usesAncestorConfig:false` or `ttlConfig:*`.
- **page_size** (::Integer) --- The number of results to return.
- **page_token** (::String) --- A page token, returned from a previous call to [FirestoreAdmin.ListFields](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_list_fields_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_fields (method)"), that may be used to get the next page of results.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::PagedEnumerable\<[::Google::Cloud::Firestore::Admin::V1::Field](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field)\>)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::PagedEnumerable\<[::Google::Cloud::Firestore::Admin::V1::Field](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field)\>)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 item
end
```

### #list_indexes

    def list_indexes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>
    def list_indexes(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>

Lists composite indexes.
**Overloads**

    def list_indexes(request, options = nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>

Pass arguments to `list_indexes` via a request object, either of type [ListIndexesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListIndexesRequest "Google::Cloud::Firestore::Admin::V1::ListIndexesRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ListIndexesRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListIndexesRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_indexes(parent: nil, filter: nil, page_size: nil, page_token: nil) -> ::Gapic::PagedEnumerable<::Google::Cloud::Firestore::Admin::V1::Index>

Pass arguments to `list_indexes` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}`
- **filter** (::String) --- The filter to apply to list results.
- **page_size** (::Integer) --- The number of results to return.
- **page_token** (::String) --- A page token, returned from a previous call to [FirestoreAdmin.ListIndexes](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_list_indexes_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#list_indexes (method)"), that may be used to get the next page of results.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::PagedEnumerable\<[::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index)\>)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::PagedEnumerable\<[::Google::Cloud::Firestore::Admin::V1::Index](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Index)\>)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 item
end
```

### #list_user_creds

    def list_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse
    def list_user_creds(parent: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse

List all user creds in the database. Note that the returned resource
does not contain the secret value itself.
**Overloads**

    def list_user_creds(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse

Pass arguments to `list_user_creds` via a request object, either of type [ListUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListUserCredsRequest "Google::Cloud::Firestore::Admin::V1::ListUserCredsRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ListUserCredsRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListUserCredsRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def list_user_creds(parent: nil) -> ::Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse

Pass arguments to `list_user_creds` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **parent** (::String) --- Required. A parent database name of the form `projects/{project_id}/databases/{database_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListUserCredsResponse))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ListUserCredsResponse))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::ListUserCredsRequest.new

# Call the list_user_creds method.
result = client.list_user_creds request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::ListUserCredsResponse.
p result
```

### #location_client

    def location_client() -> Google::Cloud::Location::Locations::Client

Get the associated client for mix-in of the Locations.
**Returns**

- (Google::Cloud::Location::Locations::Client)

### #logger

    def logger() -> Logger

The logger used for request/response debug logging.
**Returns**

- (Logger)

### #operations_client

    def operations_client() -> ::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations

Get the associated client for long-running operations.
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Operations](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Operations))

### #reset_user_password

    def reset_user_password(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds
    def reset_user_password(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Resets the password of a user creds.
**Overloads**

    def reset_user_password(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `reset_user_password` via a request object, either of type [ResetUserPasswordRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ResetUserPasswordRequest "Google::Cloud::Firestore::Admin::V1::ResetUserPasswordRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::ResetUserPasswordRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-ResetUserPasswordRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def reset_user_password(name: nil) -> ::Google::Cloud::Firestore::Admin::V1::UserCreds

Pass arguments to `reset_user_password` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameter**

- **name** (::String) --- Required. A name of the form `projects/{project_id}/databases/{database_id}/userCreds/{user_creds_id}`
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::UserCreds](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UserCreds))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::ResetUserPasswordRequest.new

# Call the reset_user_password method.
result = client.reset_user_password request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::UserCreds.
p result
```

### #restore_database

    def restore_database(request, options = nil) -> ::Gapic::Operation
    def restore_database(parent: nil, database_id: nil, backup: nil, encryption_config: nil, tags: nil) -> ::Gapic::Operation

Creates a new database by restoring from an existing backup.


The new database must be in the same cloud region or multi-region location
as the existing backup. This behaves similar to
[FirestoreAdmin.CreateDatabase](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_create_database_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#create_database (method)")
except instead of creating a new empty database, a new database is created
with the database type, index configuration, and documents from an existing
backup.

<br />

The [long-running operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation "Google::Longrunning::Operation (class)") can be used to
track the progress of the restore, with the Operation's
[metadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_metadata_instance_ "Google::Longrunning::Operation#metadata (method)") field type being the
[RestoreDatabaseMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseMetadata "Google::Cloud::Firestore::Admin::V1::RestoreDatabaseMetadata (class)").
The [response](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation#Google__Longrunning__Operation_response_instance_ "Google::Longrunning::Operation#response (method)") type is the
[Database](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database "Google::Cloud::Firestore::Admin::V1::Database (class)") if the restore was
successful. The new database is not readable or writeable until the LRO has
completed.
**Overloads**

    def restore_database(request, options = nil) -> ::Gapic::Operation

Pass arguments to `restore_database` via a request object, either of type [RestoreDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest "Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-RestoreDatabaseRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def restore_database(parent: nil, database_id: nil, backup: nil, encryption_config: nil, tags: nil) -> ::Gapic::Operation

Pass arguments to `restore_database` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **parent** (::String) --- Required. The project to restore the database in. Format is `projects/{project_id}`.
- **database_id** (::String) --- Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database.


  This value should be 4-63 characters. Valid characters are /\[a-z\]\[0-9\]-/
  with first character a letter and the last a letter or a number. Must not
  be UUID-like /\[0-9a-f\]{8}(-\[0-9a-f\]{4}){3}-\[0-9a-f\]{12}/.

  "(default)" database ID is also valid if the database is Standard edition.
- **backup** (::String) --- Required. Backup to restore from. Must be from the same project as the parent.


  The restored database will be created in the same location as the source
  backup.

  Format is: `projects/{project_id}/locations/{location}/backups/{backup}`
- **encryption_config** ([::Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig), ::Hash) --- Optional. Encryption configuration for the restored database.


  If this field is not specified, the restored database will use
  the same encryption configuration as the backup, namely
  [use_source_encryption](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database-EncryptionConfig#Google__Cloud__Firestore__Admin__V1__Database__EncryptionConfig_use_source_encryption_instance_ "Google::Cloud::Firestore::Admin::V1::Database::EncryptionConfig#use_source_encryption (method)").
- **tags** (::Hash{::String =\> ::String}) --- Optional. Immutable. Tags to be bound to the restored database.


  The tags should be provided in the format of
  `tagKeys/{tag_key_id} -> tagValues/{tag_value_id}`.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::RestoreDatabaseRequest.new

# Call the restore_database method.
result = client.restore_database request

# 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 "No response received."
end
```

### #universe_domain

    def universe_domain() -> String

The effective universe domain
**Returns**

- (String)

### #update_backup_schedule

    def update_backup_schedule(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule
    def update_backup_schedule(backup_schedule: nil, update_mask: nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Updates a backup schedule.
**Overloads**

    def update_backup_schedule(request, options = nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Pass arguments to `update_backup_schedule` via a request object, either of type [UpdateBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UpdateBackupScheduleRequest "Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UpdateBackupScheduleRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def update_backup_schedule(backup_schedule: nil, update_mask: nil) -> ::Google::Cloud::Firestore::Admin::V1::BackupSchedule

Pass arguments to `update_backup_schedule` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **backup_schedule** ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule), ::Hash) --- Required. The backup schedule to update.
- **update_mask** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-FieldMask), ::Hash) --- The list of fields to be updated.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule))
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- ([::Google::Cloud::Firestore::Admin::V1::BackupSchedule](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-BackupSchedule))
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::Firestore::Admin::V1::UpdateBackupScheduleRequest.new

# Call the update_backup_schedule method.
result = client.update_backup_schedule request

# The returned object is of type Google::Cloud::Firestore::Admin::V1::BackupSchedule.
p result
```

### #update_database

    def update_database(request, options = nil) -> ::Gapic::Operation
    def update_database(database: nil, update_mask: nil) -> ::Gapic::Operation

Updates a database.
**Overloads**

    def update_database(request, options = nil) -> ::Gapic::Operation

Pass arguments to `update_database` via a request object, either of type [UpdateDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UpdateDatabaseRequest "Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::UpdateDatabaseRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UpdateDatabaseRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def update_database(database: nil, update_mask: nil) -> ::Gapic::Operation

Pass arguments to `update_database` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **database** ([::Google::Cloud::Firestore::Admin::V1::Database](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Database), ::Hash) --- Required. The database to update.
- **update_mask** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-FieldMask), ::Hash) --- The list of fields to be updated.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 "No response received."
end
```

### #update_field

    def update_field(request, options = nil) -> ::Gapic::Operation
    def update_field(field: nil, update_mask: nil) -> ::Gapic::Operation

Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
[FirestoreAdmin.UpdateField](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FirestoreAdmin-Client#Google__Cloud__Firestore__Admin__V1__FirestoreAdmin__Client_update_field_instance_ "Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client#update_field (method)")
should provide a field mask to avoid changing any configuration that the
caller isn't aware of. The field mask should be specified as: `{ paths:
"index_config" }`.


This call returns a
[google.longrunning.Operation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Longrunning-Operation "Google::Longrunning::Operation (class)") which may be
used to track the status of the field update. The metadata for the
operation will be the type
[FieldOperationMetadata](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-FieldOperationMetadata "Google::Cloud::Firestore::Admin::V1::FieldOperationMetadata (class)").

<br />

To configure the default field settings for the database, use
the special `Field` with resource name:
`projects/{project_id}/databases/{database_id}/collectionGroups/default/fields/*`.
**Overloads**

    def update_field(request, options = nil) -> ::Gapic::Operation

Pass arguments to `update_field` via a request object, either of type [UpdateFieldRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UpdateFieldRequest "Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest (class)") or an equivalent Hash. **Parameters**

- **request** ([::Google::Cloud::Firestore::Admin::V1::UpdateFieldRequest](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-UpdateFieldRequest), ::Hash) --- A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.
- **options** (::Gapic::CallOptions, ::Hash) --- Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

    def update_field(field: nil, update_mask: nil) -> ::Gapic::Operation

Pass arguments to `update_field` via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above). **Parameters**

- **field** ([::Google::Cloud::Firestore::Admin::V1::Field](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Cloud-Firestore-Admin-V1-Field), ::Hash) --- Required. The field to be updated.
- **update_mask** ([::Google::Protobuf::FieldMask](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-firestore-admin-v1/latest/Google-Protobuf-FieldMask), ::Hash) --- A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.
**Yields**

- (response, operation) --- Access the result along with the RPC operation
**Yield Parameters**

- **response** (::Gapic::Operation)
- **operation** (::GRPC::ActiveCall::Operation)
**Returns**

- (::Gapic::Operation)
**Raises**

- (::Google::Cloud::Error) --- if the RPC is aborted.
**Example**

Basic example

```ruby
require "google/cloud/firestore/admin/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::Firestore::Admin::V1::FirestoreAdmin::Client.new

# Create a request. To set request fields, pass in keyword arguments.
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 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 "No response received."
end
```